> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lunary.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Docs MCP

> Search and read Lunary developer docs from your editor using MCP

Search and read Lunary developer docs from your editor.

Lunary hosts a public Model Context Protocol (MCP) server for documentation on docs.lunary.ai.

**Server URL (streamable HTTP):** `https://docs.lunary.ai/mcp`

## What it provides

* Read-only access to Lunary documentation (search + page content).
* A way to pull documentation into your agent's context while you work.

<Note>
  This MCP server is documentation-only. It does not call the Lunary API on your
  behalf.
</Note>

## Quickstart

<Tabs>
  <Tab title="Codex">
    You can connect Codex to MCP servers in the CLI or IDE extension.
    Configuration is shared between both, so you only set it up once.

    Add the server with the Codex CLI:

    ```bash theme={null}
    codex mcp add lunaryDocs --url https://docs.lunary.ai/mcp
    ```

    Verify it is configured:

    ```bash theme={null}
    codex mcp list
    ```

    You can also add it in `~/.codex/config.toml` directly:

    ```toml theme={null}
    [mcp_servers.lunaryDocs]
    url = "https://docs.lunary.ai/mcp"
    ```

    To have Codex reliably use the MCP server, add this snippet to your `AGENTS.md`:

    ```md wrap theme={null}
    Always use the Lunary documentation MCP server if you need to work with Lunary API or SDK docs without me having to explicitly ask.
    ```
  </Tab>

  <Tab title="Claude Code">
    Claude Code supports remote MCP servers. Add the Lunary Docs server:

    ```bash theme={null}
    claude mcp add --transport http lunaryDocs https://docs.lunary.ai/mcp
    ```

    If your Claude Code workflow uses project MCP config, create a `.mcp.json` in the project root:

    ```json theme={null}
    {
      "mcpServers": {
        "lunaryDocs": {
          "type": "http",
          "url": "https://docs.lunary.ai/mcp"
        }
      }
    }
    ```

    To have Claude Code reliably use the MCP server, add this snippet to your `AGENTS.md`:

    ```md wrap theme={null}
    Always use the Lunary documentation MCP server if you need to work with Lunary API or SDK docs without me having to explicitly ask.
    ```

    Ask Claude Code a Lunary-related question like:

    ```md wrap theme={null}
    Look up the endpoint for ingesting runs in Lunary docs and summarize the required fields.
    ```
  </Tab>

  <Tab title="VS Code">
    VS Code supports MCP servers when using GitHub Copilot in Agent mode.

    You can manually add a `.vscode/mcp.json` in your project root:

    ```json theme={null}
    {
      "servers": {
        "lunaryDocs": {
          "type": "http",
          "url": "https://docs.lunary.ai/mcp"
        }
      }
    }
    ```

    To have VS Code reliably use the MCP server, add this snippet to your `AGENTS.md`:

    ```md wrap theme={null}
    Always use the Lunary documentation MCP server if you need to work with Lunary API or SDK docs without me having to explicitly ask.
    ```

    Open Copilot Chat, switch to Agent mode, enable the server in the tools picker, and ask:

    ```md wrap theme={null}
    Look up the endpoint for ingesting runs in Lunary docs and summarize the required fields.
    ```
  </Tab>

  <Tab title="Cursor">
    Cursor has native MCP support and reads configuration from `mcp.json`.

    Create `~/.cursor/mcp.json` (macOS/Linux) and add:

    ```json theme={null}
    {
      "mcpServers": {
        "lunaryDocs": {
          "url": "https://docs.lunary.ai/mcp"
        }
      }
    }
    ```

    To have Cursor reliably use the MCP server, add this snippet to your `AGENTS.md`:

    ```md wrap theme={null}
    Always use the Lunary documentation MCP server if you need to work with Lunary API or SDK docs without me having to explicitly ask.
    ```

    Restart Cursor and ask Cursor's agent a Lunary-related question like:

    ```md wrap theme={null}
    Look up the endpoint for ingesting runs in Lunary docs and summarize the required fields.
    ```
  </Tab>
</Tabs>

## Tips

* If you do not add the AGENTS.md snippet, explicitly ask your agent to use the Lunary Docs MCP
  server when answering.
* The currently exposed Lunary docs tool is `SearchLunaryApiReference`.
