agentmods.dev

rails_api_keys AGENTS.md

Project instructions for rails_api_keys, a Ruby on Rails engine that lets host applications create and check personal API keys. The guide explains its design, naming, installation, and boundaries.

In plain words
What is it for?
Use it when working on the rails_api_keys gem, its Rails models, Bearer-token authentication, owner setup, configuration, or installation generator.
Why use it?
It gives coding agents the rules needed to change the engine without adding features it does not own, such as user interfaces, domain APIs, or email jobs.

Instructions file for CodexOpenCode

10 15d ago A scan 504 tokens original MIT
View the source file rubyroidlabs/rails_api_keys
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/rubyroidlabs/rails_api_keys/agents-md
Clone the repo
git clone --depth 1 https://github.com/rubyroidlabs/rails_api_keys

Made for: Codex, OpenCode.

Per session 504 This file is loaded in full into every session.
When invoked 504 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00504 $0.00504
Opus 5 $0.00252 $0.00252
Sonnet 5 $0.00101 $0.00101
Haiku 4.5 $0.00050 $0.00050

Measured 2d ago against content hash e2162ba43239, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

rails_api_keys AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 61 lines

What it actually says

rails_api_keys — Agent Guide

Thin, reusable Rails engine for personal API keys. Host apps own UI, routes, and domain APIs.

Stack

  • Ruby gem / Rails engine (isolate_namespace RailsApiKeys)
  • Active Record model + install generator
  • Auth concern for ActionController::API (Bearer token)

Naming

Gem, require, and repo all use rails_api_keys. Module is RailsApiKeys.

gem "rails_api_keys", git: "…" # or path:

No custom require: needed.

Architecture (keep it thin)

In this gem

  • RailsApiKeys::ApiKey — create (return raw once), SHA-256 digest, soft revoke, read / read_write
  • RailsApiKeys::Authentication — authenticate_api_key! (Bearer + method-based permission), current_api_key / current_api_owner
  • has_api_keys — owner opt-in macro (polymorphic has_many + registry + create_api_key!); multiple models allowed
  • RailsApiKeys.configure — optional overrides (token_prefix, owner_active)
  • Install generator (migration + initializer)

Not in this gem

  • Key management UI, domain APIs, mailers, jobs, views, assets, session auth

Critical rules

  • Do not reintroduce unused Rails scaffolds unless a real feature needs them.
  • Do not put host-app business endpoints in the engine.
  • Raw token is returned only from create_api_key! / generate_for!; never store plaintext.
  • Permissions are immutable after create; revoke via soft revoked_at.
  • Prefer single quotes; # frozen_string_literal: true on Ruby files.
  • Run bundle exec rspec and bundle exec rubocop after non-trivial changes.

Commands

bundle install
bundle exec rspec
bin/rubocop

Specs live under spec/ and boot spec/dummy (sqlite).

Where to look

  • Project state: .cursor/rules/context.mdc
  • Model: app/models/rails_api_keys/api_key.rb
  • Auth: lib/rails_api_keys/authentication.rb
  • Owner macro: lib/rails_api_keys/owner.rb
  • Config: lib/rails_api_keys/configuration.rb
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 61 lines · 504 tokens per session scan A e2162ba43239

Subscribe to this mod's changes

rails_api_keys AGENTS.md is an instructions file published in the GitHub repository rubyroidlabs/rails_api_keys (10 stars, last pushed 15d ago), licensed MIT. It adds 504 tokens to every session, about $0.0025 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

API-keyBackend and APIsPlanningSecurityapiapi-key-authapi-key-managementapi-key-managerapi-keys
Related

Other instructions, from other repositories

gorest AGENTS.md

Instructions for pilinux/gorest, covering agents.md, project overview, build and run commands, build and tidy dependencies.

pilinux/gorest · 5,194 tokens

gmgn-skills CLAUDE.md

Instructions for GMGNAI/gmgn-skills, covering claude.md, critical rule — read this first, project overview, available skills and quick decision guide.

GMGNAI/gmgn-skills · 2,591 tokens

cli AGENTS.md

Instructions for nylas/cli, covering ai coding agent guidelines, quick reference: shared helpers, quick reference: adding a new feature and quick reference: credential storage.

nylas/cli · 909 tokens

nango CLAUDE.md

Claude Code instructions for NangoHQ/nango, a project described as: Build product integrations with AI.

NangoHQ/nango · 3 tokens

mcp-agent-langchainjs AGENTS.md

Instructions for Azure-Samples/mcp-agent-langchainjs, covering mcp agent langchain.js project instructions, architecture overview, component communication flow, key architectural patterns and authentication & state management.

Azure-Samples/mcp-agent-langchainjs · 441 tokens

silkweave CLAUDE.md

Instructions for silkweave/silkweave, covering claude.md, commands, mcp inspector (connects to mcp stdio example via .mcp.json), architecture and packages.

silkweave/silkweave · 22,658 tokens