document-engine

document-engine is a skill for Claude Code, Codex from igmarin/rails-agent-skills. It costs 27 tokens per session (833 once invoked), scanned A, original, MIT.

A documentation guide for Ruby on Rails engines, which are reusable Rails applications mounted inside a larger Rails app. It covers installation, host-app assumptions, configuration, mounting, usage, and migrations.

In plain words
What is it for?
Use it when writing or updating an engine README, installation guide, configuration reference, or usage documentation.
Why use it?
It helps prevent setup documentation from omitting requirements that can leave an engine unusable or incorrectly integrated.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it when writing or updating an engine README, installation guide, configuration reference, or usage documentation.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/igmarin/rails-agent-skills/document-engine
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.

Any agent
npx skills add igmarin/rails-agent-skills --skill document-engine
Clone the repo
git clone --depth 1 https://github.com/igmarin/rails-agent-skills

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for document-engine

README.md
[![agentmods](https://agentmods.dev/badge/skills/igmarin/rails-agent-skills/document-engine/github.svg)](https://agentmods.dev/skills/igmarin/rails-agent-skills/document-engine)
Your own site
<a href="https://agentmods.dev/skills/igmarin/rails-agent-skills/document-engine"><img src="https://agentmods.dev/badge/skills/igmarin/rails-agent-skills/document-engine/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for document-engine

Your own site · 80×15
<a href="https://agentmods.dev/skills/igmarin/rails-agent-skills/document-engine"><img src="https://agentmods.dev/badge/skills/igmarin/rails-agent-skills/document-engine.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 27 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 833 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.1 $0.00027 $0.00833
Opus 5.5 $0.00011 $0.00333
Sonnet 5.5 $0.00005 $0.00167
Haiku 4.5 $0.00003 $0.00083

Measured 25d ago against content hash 6d48038302c6, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

document-engine 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 25d 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.

skills/document-engine/SKILL.md · 91 lines

How it starts

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

Document Engine

Use this skill when writing or maintaining documentation for Rails engines.

Core Process & Constraints

Step Section Focus
1 Installation gem add, bundle, run install generator — show minimum working path first
2 Host Assumptions Explicitly state any host model, job backend, or auth integration assumptions
3 Configuration All options with defaults, required vs optional
4 Mounting Explicit mount MyEngine::Engine, at: '/path' in routes — show once only
5 Usage Copyable code for typical workflows
6 Migrations Install generator, one-time setup, upgrade-impacting changes

Hard gate: All generated documentation MUST satisfy steps 1, 2, and 3 above before proceeding to optional sections.

README snippet (install + mount):

## Installation

Add to your Gemfile:

    gem 'my_engine'

Run:

    bundle install
    rails generate my_engine:install

This creates `config/initializers/my_engine.rb`. Mount the engine in `config/routes.rb`:

    mount MyEngine::Engine, at: '/admin'

Configuration section:

## Configuration

In `config/initializers/my_engine.rb`:

    MyEngine.configure do |config|
      config.user_class = "User"       # required: host model for current user
      config.widget_count = 10         # optional, default 10
    end

Extended Resources

See CHECKLIST.md for the full recommended README shape and documentation gap checklist. Critical gaps tracked there: installation steps, all config options with defaults, explicit mount path, migration timing, host model/auth assumptions.

  • assets/configuration.md — detailed config option catalog with type info, validation rules, and all supported defaults
  • assets/examples.md — realistic end-to-end usage examples covering common host-app integration workflows
  • assets/installation.md — step-by-step install and generator reference including post-install setup tasks

Read the full file on GitHub · 91 lines

Files

What ships with it

4 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 25d ago Changed · -1 lines 6d48038302c6
  2. 1mo ago Changed · +2 lines 3d22546f3f2a
  3. 1mo ago First seen · 90 lines · 27 tokens per session scan A 5682544d369c

Subscribe to this mod's changes

document-engine is a skill published in the GitHub repository igmarin/rails-agent-skills (28 stars, last pushed 26d ago), licensed MIT. It adds 27 tokens to every session and 833 once invoked, about $0.0001 per session on Opus 5.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-30.

Related

Other skills, from other repositories

rubyllm

Build and maintain Ruby or Rails applications with the RubyLLM AI framework. Use for chats, agents, tools, MCP servers, structured output, judgments, evaluations, media generation, transcription, OCR, moderation, embeddings, reranking, tracing, Rails integration, and RubyLLM upgrades; not for contributing to the…

crmne/ruby_llm · 70 tokens

new

Create a new project to start development quickly.

clacky-ai/openclacky · 10 tokens

rspec-conventions

Rootstrap RSpec conventions. Use when writing, reviewing, or editing RSpec test files (spec//spec.rb, spec/railshelper.rb, spec/spechelper.rb, spec/support//.rb) or factories. Covers describe/context structure, let/subject, matchers, factories, mocking/stubbing, shared examples, and spec types (model, request…

rootstrap/rails_api_base · 82 tokens

dhh-rails-style

This skill should be used when writing Ruby and Rails code in DHH's distinctive 37signals style. It applies when writing Ruby code, Rails applications, creating models, controllers, or any Ruby file. Triggers on Ruby/Rails code generation, refactoring requests, code review, or when the user mentions DHH, 37signals…

davekilleen/Dex · 115 tokens

ruby-patterns

Ruby/Rails: blocks, metaprogramming, ActiveRecord, Sidekiq, RSpec, Sorbet, Hanami. Triggers: Ruby, Rails, ActiveRecord, Sidekiq, RSpec, Gemfile, bundler, Hanami, Sorbet.

softspark/ai-toolkit · 60 tokens

ruby-idioms

Modern Ruby (3.x) idioms: pattern matching, keyword arguments, immutable data structures, error hierarchies, and RSpec testing. Use when writing, modifying, or reviewing Ruby scripts, gems, or business logic. Pair with rails-idioms for Rails applications.

irahardianto/awesome-agv · 61 tokens