# Reqbook

## Docs

- [MCP server](https://docs.markapidown.net/agents/mcp.md): Ten structured tools for MCP-compatible coding agents: exec, diagnose, flow, author, vars, search, context, history, session, and exec_batch. Surgical context by default; verbose mode for debugging.
- [Set up agent support](https://docs.markapidown.net/agents/setup.md): Install the skill, slash commands, and the MCP server for Claude Code, Cursor, Copilot, Codex CLI, Antigravity, OpenCode, and Windsurf.
- [Skills reference](https://docs.markapidown.net/agents/skills.md): A single SKILL.md playbook installed for every supported agent — teaches the Reqbook spec format, file layout, MCP tools, and when to use each command.
- [Slash commands](https://docs.markapidown.net/agents/slash-commands.md): Two /rqb commands for Claude Code and Codex CLI — each handles a complex, multi-step task that benefits from LLM reasoning rather than a fixed script.
- [Reqbook CLI for API Testing](https://docs.markapidown.net/cli/overview.md): Run Reqbook from the terminal to validate, execute, flow-test, import, and package markdown API specs for coding agents.
- [rqb request](https://docs.markapidown.net/cli/request.md): Send an ad-hoc HTTP request from the terminal without creating a spec file first.
- [Markdown Endpoint Files](https://docs.markapidown.net/essentials/endpoint-files.md): Write every Reqbook endpoint as a markdown file with YAML frontmatter, an HTTP request block, and an expected response block.
- [API Flow Testing Pipelines](https://docs.markapidown.net/essentials/pipelines.md): Chain markdown endpoint specs into executable API flows that capture response values and inject them into later steps.
- [Security](https://docs.markapidown.net/essentials/security.md): Reqbook prevents secrets from being committed to version control. Learn about secret detection, allowed secret locations, and output masking.
- [Variables & environments](https://docs.markapidown.net/essentials/variables.md): Reqbook resolves {{variable}} placeholders from six sources in strict priority order. Learn how to configure environments, use .env.local, and pass secrets safely.
- [API Testing for AI Coding Agents](https://docs.markapidown.net/guides/ai-agents.md): Use Reqbook with Claude Code, Cursor, Copilot, Codex CLI, Antigravity, OpenCode, and Windsurf to read, write, validate, and run API specs.
- [Markdown API Testing in CI/CD](https://docs.markapidown.net/guides/ci-cd.md): Run Reqbook in GitHub Actions, GitLab CI, or any CI system and gate deployments on executable markdown API specs.
- [Desktop smoke testing](https://docs.markapidown.net/guides/desktop-smoke.md): Start the Tauri desktop app, verify the embedded Reqbook web/API surface, and shut it down automatically.
- [E2E testing](https://docs.markapidown.net/guides/e2e-testing.md): Run Reqbook end-to-end checks for the flow canvas, embedded preview server, and desktop smoke path.
- [Migrating from other tools](https://docs.markapidown.net/guides/migration.md): Import existing API specs from Postman, Insomnia, or OpenAPI into Reqbook with a single command.
- [Agent API Workflow](https://docs.markapidown.net/guides/vibe-coding.md): Use Reqbook as the API memory and execution layer for coding agents that need runnable specs, flows, and bounded context.
- [VS Code extension](https://docs.markapidown.net/guides/vscode-extension.md): Preview, validate, run, and inspect Reqbook specs from VS Code.
- [Browser API Runner](https://docs.markapidown.net/guides/web-preview.md): Use the Reqbook browser UI to browse, execute, edit, import, and connect markdown API specs in a local workspace.
- [Install Reqbook CLI and Desktop](https://docs.markapidown.net/installation.md): Install Reqbook on macOS, Linux, or Windows using the shell installer, Cargo, npm, Docker, Homebrew, or MSI.
- [Executable Markdown API Docs](https://docs.markapidown.net/introduction.md): Reqbook stores API documentation as runnable markdown specs for developers, CI, local UI, and AI coding agents.
- [Reqbook API Testing Quickstart](https://docs.markapidown.net/quickstart.md): Install Reqbook, create markdown API specs, open the browser UI, and run an agent-friendly API test in minutes.
- [CLI reference](https://docs.markapidown.net/reference/cli.md): Complete reference for all rqb subcommands, flags, and exit codes.
- [Configuration reference](https://docs.markapidown.net/reference/configuration.md): Project config (reqbook.md), environment config (env.md), auth modes, retry policy, and the web preview settings.
- [Exit codes](https://docs.markapidown.net/reference/exit-codes.md): Reqbook returns stable exit codes so CI pipelines can act on pass, failure, invalid spec, or secret detection independently.
- [New Request](https://docs.markapidown.net/ui/new-request.md): Send any HTTP request from the browser without creating a spec file first.
- [Reqbook Browser UI](https://docs.markapidown.net/ui/overview.md): Use the local Reqbook browser UI to run endpoint specs, inspect responses, edit markdown, and build API flows.