rails-markup
Point-and-click annotation for AI agents. Mark up your Rails views in the browser; your agent reads the feedback over MCP and fixes it in the code.
status: stable · latest 1.2.1 · MIT
▸ Open the interactive docs → — a live FAB configurator (see the config change as you tune it) and a try-it annotation demo.
rails-markup is a single Ruby gem that gives a Rails app four things: a mounted dashboard, a self-contained browser toolbar, an MCP server, and a CLI — all sharing one annotation model.
The loop
| Step | What happens |
|---|---|
| 1. Annotate | Click any element in your running app, type what should change, pick intent + severity. Optional element screenshot with arrows/highlights. |
| 2. Read | Your AI agent lists pending annotations over MCP and gets the exact element, page, and note. |
| 3. Resolve | The agent fixes the code and resolves the annotation with a summary — synced back to the pin and dashboard. |
Install
# Gemfile
gem "rails-markup", require: "rails_markup"
bundle install
bin/rails generate rails_markup:install
bin/rails db:migrate
The generator mounts the engine, injects the toolbar, writes an initializer, and creates a migration.
Docs
- Interactive start — configurator + demo.
- Installation — generator, options, requirements.
- Configuration — every config option.
- MCP & agents — connect Claude Code / Codex.
-
CLI — the
rails-markupcommands.
Links
- Gem: https://rubygems.org/gems/rails-markup
- Source: https://github.com/nauman/rails-markup
- Landing: https://nauman.github.io/rails-markup/
source: nauman/rails-markup · rev 1.2.1