mkdocs-agentready

MkDocs plugin that submits your docs site to AgentReady after every build, making it instantly queryable by AI agents (Claude, Cursor, Windsurf, and any MCP client) with cited, multi-page answers.

Installation

pip install mkdocs-agentready

Usage

Add the plugin to your mkdocs.yml:

site_url: https://docs.yoursite.com  # used to infer domain automatically

plugins:
  - search
  - agentready

If you don't have site_url set, specify the domain explicitly:

plugins:
  - search
  - agentready:
      domain: docs.yoursite.com

After each mkdocs build or mkdocs gh-deploy:

INFO  -  [AgentReady] ✓ Indexed docs.yoursite.com. AI agents can now query it.
INFO  -  [AgentReady]   MCP:  https://www.agentready.it.com/api/mcp

How it works

After your site builds, the plugin posts your domain to AgentReady's indexing webhook. AgentReady crawls your docs and makes them queryable via:

• MCP server — https://www.agentready.it.com/api/mcp (works in Claude, Cursor, Windsurf, and any MCP client)
• REST endpoint — POST https://www.agentready.it.com/api/sites/{id}/ask
• llms.txt — https://www.agentready.it.com/api/sites/{id}/llms.txt

Connecting to your AI tools

Claude Code / Claude Desktop

claude mcp add agentready npx @agentreadyweb/mcp

VS Code (GitHub Copilot)

// .vscode/mcp.json
{
  "servers": {
    "agentready": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@agentreadyweb/mcp"]
    }
  }
}

Then ask your AI: "Ask agentready: how do I configure X in [your docs]?"

Configuration

License

MIT © AgentReady