Quickstart

Get AI context for your Rails app in under 5 minutes.

Tools Reference · Recipes · Configuration · FAQ


TipLet your AI tool do it. Open it at your app's root and paste the recommended install prompt. Copy-paste prompts has one for every other setup too: no Gemfile change, CLI only, MCP only, a team, a folder of apps, nothing committed.

# 1. Add the gem
bundle add rails-ai-context --group development

# 2. Run the install generator
rails generate rails_ai_context:install

The generator asks two questions:

  1. Which AI tools do you use? - Claude Code, Cursor, GitHub Copilot, OpenCode, Codex CLI, or all. There is no "none" choice: an empty answer, or one with no valid number, takes the default (all five on a first install, the recorded selection on a re-run).
  2. What should rails-ai-context write? - MCP config + context files (default), context files only (CLI mode), or MCP config only

The third answer is MCP-only: the server and the CLI answer in full, and your own CLAUDE.md, AGENTS.md and rules files are left alone. Non-interactively that is --mcp-only.

Three more prompts appear only when they apply:

--defaults skips every prompt and takes each default: on a first install all five tools and MCP config + context files, on a re-run the recorded tools and setup; it keeps every file and installs no hook. Flags answer one question each, and --defaults the rest:

rails generate rails_ai_context:install --tools claude --defaults             # Claude Code, MCP config + context files
rails generate rails_ai_context:install --tools claude,cursor --cli --defaults # context files only (CLI mode)
rails generate rails_ai_context:install --tools all --mcp-only --defaults      # MCP config only

--tools takes claude, cursor, copilot, opencode, codex or all. --mcp picks MCP config + context files outright, which a re-run needs to switch back to it, since its default is the recorded setup. --prune removes a dropped tool's files without asking, and --hook installs the pre-commit hook. Every step is listed in What the install generator does.

That's it. Your AI tool now has live access to your schema, models, routes, controllers, views, and conventions.

TipThe generator is idempotent - re-running it preserves existing config and only adds new sections.

Option B: Standalone (no Gemfile entry)

# 1. Install the gem globally
gem install rails-ai-context

# 2. Navigate to your Rails app
cd your-rails-app

# 3. Run interactive setup
rails-ai-context init

# 4. Start the MCP server
rails-ai-context serve

init asks the same two questions, and the cleanup and legacy-file prompts when they apply, and takes the same flags (rails-ai-context init --tools claude --defaults asks nothing). It has no pre-commit hook prompt, and it does not create config/initializers/rails_ai_context.rb.

Works with every Ruby version manager (rbenv, rvm, asdf, mise, chruby, system). Learn more about standalone mode →

What just happened?

The install generator created:

File Purpose
.mcp.json / .cursor/mcp.json / .vscode/mcp.json / .github/mcp.json / opencode.json / .codex/config.toml Each AI tool finds its config when it opens the project, then asks you to approve the server once
CLAUDE.md + .claude/rules/ / AGENTS.md + .cursor/rules/ / .github/copilot-instructions.md + .github/instructions/ Static context rules your AI reads
.ai-context.json The same context as JSON (added to .gitignore)
config/initializers/rails_ai_context.rb All configuration options
.rails-ai-context.yml Your tool selection, and the config file for standalone mode

Verify it works

# Check AI readiness
rails ai:doctor          # In-Gemfile
rails-ai-context doctor  # Standalone

# Try a tool
rails 'ai:tool[schema]' table=users
rails 'ai:tool[model_details]' model=User
rails 'ai:tool[routes]' controller=users

See it work

ImportantThese are CLI commands. When MCP is connected, your AI calls the same tools automatically - you never type these manually.

Three commands that show immediate value:

# 1. Trace a method across your entire codebase - one call
rails 'ai:tool[search_code]' pattern="your_method_name" match_type=trace

# 2. Full-stack feature analysis - models + controllers + routes + tests
rails 'ai:tool[analyze_feature]' feature=auth

# 3. Get your app's actual conventions - not generic Rails patterns
rails 'ai:tool[config]' section=conventions

What to do next

  1. Do the "Next step" the install printed for your AI tool: approve the server in Claude Code, turn it on in Cursor, trust the folder in VS Code or Codex CLI, or restart OpenCode. AI tool setup has the table
  2. Ask your AI to describe your User model - it will call rails_get_model_details instead of guessing
  3. Read Recipes for real-world workflows that show the tools in action

Quick reference

In-Gemfile Standalone What it does
rails ai:serve rails-ai-context serve Start MCP server
rails 'ai:tool[NAME]' rails-ai-context tool NAME Run any tool
rails ai:tool rails-ai-context tool --list List all tools
rails ai:doctor rails-ai-context doctor Diagnostics
rails ai:watch rails-ai-context watch Auto-regenerate on change (needs listen: in the Gemfile, or gem install listen standalone)
rails ai:context rails-ai-context context Regenerate context files
bundle exec rails-ai-context uninstall rails-ai-context uninstall Remove what the gem wrote

Next: Tools Reference →

Back to Home