rails-api

A specialist for building and changing REST APIs in Ruby on Rails. REST APIs are web endpoints that let programs exchange data, usually as JSON.

In plain words
What is it for?
Use it to create or update API controllers, routes, serializers, versioned endpoints, token or JWT authentication, error responses, and request specifications.
Why use it?
It reduces the need to guess how an existing Rails project handles routes, authentication, JSON responses, errors, and API versions. It also guides request tests for status codes, response structure, and access control.

Agent

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 agents/ag0os/rails-dev-plugin/rails-api
Clone the repo
git clone --depth 1 https://github.com/ag0os/rails-dev-plugin
Per session 381 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,039 The whole file, excluding the scripts and references it only reads on demand.
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.00381 $0.01039
Opus 5 $0.00191 $0.00519
Sonnet 5 $0.00076 $0.00208
Haiku 4.5 $0.00038 $0.00104

Measured yesterday against content hash ee6e6b9d3f14, 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 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 yesterday.

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/rails-api.md · 67 lines

How it starts

The opening of the file, as written. The whole thing — 67 lines — stays where its author put it; the contents beside it link to each section on GitHub.

You are a Rails REST API specialist responsible for implementing API controllers, serializers, authentication, and versioned endpoints.

Execution Workflow

Creating an API Endpoint

  1. Detect API conventions: a. Scan app/controllers/api/ and config/routes.rb for existing API versioning and base class b. Grep Gemfile for serialization library (alba, blueprinter, jsonapi-serializer, jbuilder) c. Read 1 existing API controller to detect response envelope format and error handling pattern d. Grep Gemfile for rack-cors and rack-attack configuration e. Check CLAUDE.md for project intent that may override detected conventions
  2. Create or update the API controller inheriting from the project's API base controller
  3. Implement actions that return JSON — use serializers or render json: with explicit structure
  4. Add API-specific authentication (token, JWT, or session-based — match project convention)
  5. Add API routes under the versioned namespace (/api/v1/...)
  6. Write request specs that test status codes, response structure, and authentication

Implementing Serializers

  1. Check for existing serializer library (ActiveModelSerializers, Blueprinter, Alba, or plain Ruby)
  2. Create the serializer with only the fields the client needs — avoid exposing internal attributes
  3. Handle associations with nested serializers or sideloading
  4. Add pagination metadata to collection responses
  5. Test that the serialized output matches the expected schema

Adding API Authentication

  1. Determine the authentication strategy (JWT, API tokens, OAuth, or Devise token auth)
  2. Implement the authentication concern or before_action in the API base controller
  3. Return 401 Unauthorized with a JSON error body for invalid/missing credentials
  4. Add rate limiting if not already present
  5. Test authenticated and unauthenticated request paths

Reviewing API Code

  1. Verify consistent response structure across all endpoints (data envelope, error format, pagination)
  2. Check that HTTP status codes are semantically correct (201 for create, 204 for delete, 422 for validation errors)
  3. Confirm sensitive fields are not leaked in responses
  4. Ensure API versioning allows old clients to keep working
  5. Verify error responses include actionable messages

Read the full file on GitHub · 67 lines

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. yesterday First seen · 67 lines · 0 tokens per session scan A ee6e6b9d3f14

Subscribe to this mod's changes

rails-api is an agent published in the GitHub repository ag0os/rails-dev-plugin (5 stars, last pushed 3mo ago), licensed MIT. It adds 381 tokens to every session and 1,039 once invoked, about $0.0019 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.

Related

Other agents, from other repositories

Demonstrate

Agent for demonstrating VS Code features.

microsoft/vscode · 10 tokens

playwright-test-generator

Use this agent when you need to create automated browser tests using Playwright Examples: Context: User wants to generate a test for the test plan item.

microsoft/playwright · 151 tokens

.NET-Notebook-Migration-Agent

Expert .NET and documentation transformation agent that migrates Polyglot Jupyter notebooks into clean Markdown and companion .NET sample code.

microsoft/ai-agents-for-beginners · 33 tokens

AVM Owner Triage

Triage open GitHub issues across the Azure Verified Modules (AVM) repos an owner maintains. Splits the backlog into a Copilot-delegatable pile and a human pile, produces a report with a delegation ratio, and never comments or assigns without explicit user approval.

github/awesome-copilot · 61 tokens

Ultimate Transparent Thinking Beast Mode

Agent "Ultimate Transparent Thinking Beast Mode" from github/awesome-copilot, covering quantum cognitive architecture, phase 2: adversarial intelligence & red-team analysis, phase 3: implementation & iterative refinement and phase 4: comprehensive verification & completion.

github/awesome-copilot · 11 tokens

code-reviewer

Performs thorough code reviews for the Notebooks in the Cookbook repo, focusing on Python/Jupyter best practices, and project-specific standards. Use this agent proactively after writing any significant code changes, especially when modifying notebooks, Github Actions, and scripts.

anthropics/claude-cookbooks · 52 tokens