# MCP Server (/docs/developer-resources/ai-development-tools/mcp-server)

The Monime docs MCP server gives AI agents the Monime documentation as tools. Your agent can search the guides and the API reference, read any page, look up an API operation by name, and look up a Dash Dots component or Dash call. It answers from the current docs, rather than from what the model remembers.

The server is public and read-only. It needs no API key, and it never calls the Monime API or sees your account's data.

Server URL: `https://docs.monime.io/mcp`

## Add it to your client

**Tab: Claude Code**

```bash
claude mcp add --transport http monime-docs https://docs.monime.io/mcp
```

Add `--scope project` to share it with your team through the project's `.mcp.json`.

**Tab: Claude**

In Claude on the web or desktop, open **Settings → Connectors**, choose **Add custom connector**, and enter:

- **Name:** `Monime docs`
- **URL:** `https://docs.monime.io/mcp`

Turn it on for a chat from the tools menu.

**Tab: Cursor**

Use **Add to Cursor** above, or add the server to `.cursor/mcp.json` in your project, or `~/.cursor/mcp.json` for every project:

```json title=".cursor/mcp.json"
{
  "mcpServers": {
    "monime-docs": {
      "url": "https://docs.monime.io/mcp"
    }
  }
}
```

**Tab: VS Code**

Use **Add to VS Code** above, or add the server to `.vscode/mcp.json` in your project:

```json title=".vscode/mcp.json"
{
  "servers": {
    "monime-docs": {
      "type": "http",
      "url": "https://docs.monime.io/mcp"
    }
  }
}
```

Use it from Copilot Chat in agent mode.

**Tab: Other clients**

Any client that supports MCP over Streamable HTTP can connect to `https://docs.monime.io/mcp`. There is nothing to install or run, and no key to set.

To check the connection, ask your agent which Monime tools it has.

## Tools

| Tool                             | What it does                                                                                            | Takes                                                                                                       |
| -------------------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `search_monime`                  | Searches the guides and the API reference, and returns the best matches with their URLs                 | `query`, and optionally an API `version`                                                                    |
| `get_page_monime`                | Returns one page as Markdown, such as a page that search found                                          | A page `url` or path, such as `/docs/developer-resources/api-basics/idempotency`                            |
| `get_api_operation_monime`       | Returns an API operation's reference: its endpoint, parameters, request body, responses and examples    | An `operation`, such as `CreateCheckoutSession` or `POST /v1/checkout-sessions`, and optionally a `version` |
| `get_dash_dots_reference_monime` | Returns a Dash Dots component's props, events and example, or a Dash call's signature and types         | A `name`, such as `Stack`, `AmountInput`, `dash.media.scanCode` or `dot.json`                               |
| `query_docs_filesystem_monime`   | Runs read-only commands, such as `rg`, `cat` and `tree`, over the docs as files, for exact text matches | A `command`, such as `rg -i "idempotency" /docs`                                                            |

When a page, operation or name isn't found, the tool suggests the closest matches. API operations come from the current API version, `caph.2025-08-23`, unless you pass another.

## What to ask

Once it's connected, ask your agent about Monime in your own words. It looks up what it needs:

- "Create a checkout session for SLE 250 for a Freetown ticket, and handle the webhook when it's paid."
- "What does a `409 idempotency_key_in_use` error mean, and how should my code retry?"
- "Which fields does `POST /v1/payment-codes` take?"
- "In a dot, how do I scan a ticket's QR code, and which permission does it need?"
- "Which props does the Dash Dots `Stack` component take?"

## Pair it with the agent rules

The [agent rules](/docs/developer-resources/ai-development-tools/agent-rules) tell your agent the conventions every Monime integration follows, such as keeping tokens on your server and sending an `Idempotency-Key` with every create. With the MCP server as well, the agent knows the rules and can look up the details.

## Troubleshooting

**The client can't connect**

Check that the URL is exactly `https://docs.monime.io/mcp`, and that your client supports MCP over Streamable HTTP. Some older clients only support local servers, run as a command. Opening the URL in a browser shows "Method not allowed": that's expected, because clients connect with `POST`.

**The agent doesn't use the tools**

Make sure the server is turned on for the chat or project, then ask for something only the docs can answer, such as "Use the Monime docs to find how idempotency keys work."

## Privacy

The server reads only Monime's public documentation. It doesn't need or accept credentials, and it doesn't call the Monime API. Your client sends it only the tool calls your agent makes, such as a search query or a page path.