Skip to main content
Skills are markdown playbooks embedded in the Reqbook binary. When installed, agents read them from their config directories and apply them automatically when a user prompt matches a known intent — you do not need to mention Reqbook explicitly.

rqb

Covers the full Reqbook workflow: project layout, endpoint spec format, Assertions operators, pipeline capture patterns, MCP tool reference, and routing rules for when to use each slash command.

​
Install

rqb skills install
This writes the skill to every supported agent’s config directory. To target one agent: 
rqb skills install --agent=cursor
rqb skills install --agent=copilot
rqb skills install --agent=claude-code

​
What the skill teaches

​
Project layout

api-docs/
├── reqbook.md              # project config (name, default-env, timeouts)
├── _shared/env.template.md # shared environment template
├── _shared/env.md          # local base URLs and variables
├── apis/<resource>/<method>-<slug>.md   # one file per endpoint
└── flows/<name>.md         # multi-step pipelines

​
Endpoint format

Required frontmatter: resource, protocol: http, method, path (:param for path params), version: 1. Sections in order: ## Request → ## Expected response → ## Error responses (optional) → ## Assertions (optional) → ## Tests (optional) → ## Notes (optional).

​
Assertions

Structured rules that run after each execution:
OperatorExample
(equals)status: 200 · body.name: Ada Lovelace
existsbody.id: exists
in [...]body.role: in [admin, user]
containsheaders.content-type: contains json
matchesbody.slug: matches ^[a-z]+$

​
Pipeline capture patterns

PatternWhen to use
response.body.<field>Top-level JSON field
response.body.<a>.<b>Nested JSON field
response.body[<n>].<field>Field from nth array item
response.headers.<name>Response header value

​
Routing table

The skill routes the agent to the right tool or command based on the situation:
SituationAction
Create or update specs/rqb
Debug a failing endpoint or pipeline/rqb-debug
Execute a specrqb_exec MCP tool
Diagnose a failed endpointrqb_diagnose MCP tool
Run a pipelinerqb_flow MCP tool

​
Supported agents

AgentSkill formatPath
Claude CodeSKILL.md.claude/skills/rqb/SKILL.md
Cursor.mdc.cursor/rules/rqb.mdc
GitHub Copilot.instructions.md.github/instructions/rqb.instructions.md
Codex CLISKILL.md.agents/skills/rqb/SKILL.md
AntigravitySKILL.md.agents/skills/rqb/SKILL.md
OpenCodeSKILL.md.opencode/skills/rqb/SKILL.md
Windsurf.md (rule).windsurf/rules/rqb.md
All agents receive the same skill content — only the file format differs.