# MarkApiDown

> Local-first, markdown-native API workspace — design specs, send requests, validate contracts, and work with AI coding agents.

## Docs

- [MarkApiDown MCP Server: Tools for AI Agent Automation](https://docs.markapidown.net/docs/agents/mcp.md): MarkApiDown exposes MCP tools so agents can list, read, validate, execute, and author specs without parsing shell output. Register with mad install mcp.
- [MarkApiDown Agent Setup: Skills, MCP, and Slash Commands](https://docs.markapidown.net/docs/agents/setup.md): Install MarkApiDown skills for Claude Code, Cursor, GitHub Copilot, Codex CLI, and other AI coding agents using mad install in one command.
- [MarkApiDown Skills: What the mad Skill Teaches Your Agent](https://docs.markapidown.net/docs/agents/skills.md): MarkApiDown installs a SKILL.md into your agent's config. Learn what the mad skill teaches about spec format, project layout, and MCP tools.
- [Slash Commands: /mad and /mad-debug in Claude Code](https://docs.markapidown.net/docs/agents/slash-commands.md): Install /mad and /mad-debug in Claude Code or Codex CLI. /mad scans, enriches, and builds flows; /mad-debug diagnoses failing endpoint specs.
- [Assertions: Validate API Responses in Markdown](https://docs.markapidown.net/docs/essentials/assertions.md): Assertions validate HTTP responses against expected values in MarkApiDown. Learn status checks, body path assertions, header checks, and regex operators.
- [Endpoint Spec Files: Defining APIs in Markdown](https://docs.markapidown.net/docs/essentials/endpoint-files.md): MarkApiDown endpoint specs are plain markdown files. Learn the frontmatter fields, Request section, Expected response, Assertions, and Tests sections.
- [Environments and Variables in MarkApiDown](https://docs.markapidown.net/docs/essentials/environments.md): Manage base URLs and per-environment variables in _shared/env.md. Override values with .env.local, MAD_* env vars, or --var flags on the command line.
- [Flow Pipelines: Chaining API Calls in Markdown](https://docs.markapidown.net/docs/essentials/pipelines.md): Flow pipelines chain multiple endpoint specs, capture response values, and inject them into downstream steps — all in a single MarkApiDown markdown file.
- [Validate Your API Contracts in CI/CD with MarkApiDown](https://docs.markapidown.net/docs/guides/ci-cd.md): Run MarkApiDown in CI to validate specs and run contract tests. Use exit codes, JUnit output, and the npm wrapper for easy integration with any CI system.
- [Import Specs from cURL, Postman, OpenAPI, and More](https://docs.markapidown.net/docs/guides/import.md): Import API definitions into MarkApiDown from cURL commands, Postman collections, Insomnia exports, OpenAPI specs, or by scanning your project source code.
- [Run a Standalone Mock Server from Your API Spec Files](https://docs.markapidown.net/docs/guides/mock-server.md): Use mad mock to serve recorded API responses without a live backend. Configure port, artificial latency, and enable mock mode in the browser UI.
- [Vibe Coding: Use MarkApiDown in Your AI Agent Loop](https://docs.markapidown.net/docs/guides/vibe-coding.md): Use MarkApiDown as the API layer in your AI agent coding loop. Document routes, run endpoints, build flows, and review API changes in your pull request.
- [Explore the mad-ui Browser Interface for Your APIs](https://docs.markapidown.net/docs/guides/web-preview.md): Start mad serve to open the MarkApiDown browser UI. Browse endpoints, run requests, manage variables, import cURL, and build flow pipelines visually.
- [Install MarkApiDown: macOS, Linux, and Windows Guide](https://docs.markapidown.net/docs/installation.md): Install MarkApiDown using the shell installer, Cargo, Homebrew, npm, Docker, or Windows MSI. Includes shell completions and upgrade instructions.
- [MarkApiDown: Local-First API Workspace in Markdown](https://docs.markapidown.net/docs/introduction.md): MarkApiDown is a local-first API workspace where every spec is plain markdown. Design, run, and validate APIs from the CLI, browser, or your coding agent.
- [Quickstart: Run Your First API Spec in Five Minutes](https://docs.markapidown.net/docs/quickstart.md): Install MarkApiDown, initialize a project workspace, open the browser UI, and run your first API spec from the CLI — all in under five minutes.
- [mad CLI Reference: All Subcommands, Flags, and Usage](https://docs.markapidown.net/docs/reference/cli.md): Complete reference for the mad CLI binary — every subcommand, flag, default, and copy-paste example, from mad exec to mad import to mad install.
- [Environment Configuration Reference: _shared/env.md](https://docs.markapidown.net/docs/reference/env-config.md): Define per-environment variables — base URLs, API versions, and custom values — in api-docs/_shared/env.md. Secrets go in .env.local, never in env.md.
- [MarkApiDown Exit Codes Reference for CI and Scripting](https://docs.markapidown.net/docs/reference/exit-codes.md): MarkApiDown exit codes are stable across releases so CI pipelines and shell scripts can branch on test failures, invalid specs, or network errors.
- [Endpoint Spec Frontmatter Fields: Complete Reference](https://docs.markapidown.net/docs/reference/frontmatter.md): Complete reference for all frontmatter fields in MarkApiDown endpoint spec files — resource, method, path, auth, timeout, retry, tags, and more.
- [Project Configuration Reference: api-docs/mad.md File](https://docs.markapidown.net/docs/reference/mad-config.md): The mad.md file at the root of your api-docs/ sets the project name, default environment, timeouts, retries, web preview settings, and auth defaults.
- [mad Output Formats: console, json, junit, markdown](https://docs.markapidown.net/docs/reference/output-formats.md): MarkApiDown's four output formats — console, json, junit, and markdown — work identically across mad exec, mad flow, and mad request.

## Optional

- [GitHub](https://github.com/ngoclinh93qt/MarkApiDown)
- [Changelog](https://github.com/mark-api-down/mad/releases)