Metadata-Version: 2.4
Name: mkdocs-agentready
Version: 1.0.0
Summary: MkDocs plugin that submits your docs site to AgentReady after every build, making it instantly queryable by AI agents via MCP.
Project-URL: Homepage, https://www.agentready.it.com
Project-URL: Repository, https://github.com/AshutoshRaj97/agentready-mcp/tree/main/mkdocs-plugin
Project-URL: Bug Tracker, https://github.com/AshutoshRaj97/agentready-mcp/issues
License: MIT
Keywords: agents,ai,documentation,llms,mcp,mkdocs,plugin
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.8
Requires-Dist: mkdocs>=1.4
Description-Content-Type: text/markdown

# mkdocs-agentready

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

## Installation

```bash
pip install mkdocs-agentready
```

## Usage

Add the plugin to your `mkdocs.yml`:

```yaml
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:

```yaml
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**

```bash
claude mcp add agentready npx @agentreadyweb/mcp
```

**VS Code (GitHub Copilot)**

```json
// .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

| Option | Default | Description |
|--------|---------|-------------|
| `domain` | _(inferred from `site_url`)_ | Domain of your docs site (e.g. `docs.example.com`) |

## License

MIT © [AgentReady](https://www.agentready.it.com)
