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

# MCP server

> Connect Claude, ChatGPT, Cursor, Claude Code or any MCP client to the data.

The MCP server is at `https://api.numi.sh/mcp`, over the Streamable HTTP transport. It takes an API key, as `Authorization: Bearer <key>` or in the `X-API-Key` header, or an OAuth sign-in with your numi account.

For a client that supports OAuth, the details of the sign-in are at `https://api.numi.sh/.well-known/oauth-protected-resource/mcp`. Each tool call counts as one request toward the limits of the account's [plan](https://docs.numi.sh/plans.md), the same limits as REST requests. On the sandbox plan, the tools return data for the [sandbox companies](https://docs.numi.sh/plans.md#the-sandbox) only, as REST does, and `search_companies` returns any company.

## Tools

| Tool | Returns |
| - | - |
| `search_companies` | Companies whose ticker or name matches a query |
| `get_company` | A company and its filings |
| `get_segments` | The segments of a filing by axis, with the `reconciliation` of each axis |
| `get_segment_history` | One axis across every filing of a company |
| `get_fundamentals` | The line items of a filing as filed |
| `get_segment_note` | The segment note of a filing as text |
| `get_bulk_download` | Links to the bulk files of the account's plan |

The tools take the same values as the REST API: a company as a ticker or as `cik:` and its digits, an `axis`, a `period_type` and a `filing_id`. See [segments](https://docs.numi.sh/segments.md) for the meaning of the responses.

## Connect a client

> [!NOTE]
>
> Client menus change between releases, so a step below may not match what you see. In each client, the setting to use is the one where you add a remote MCP server or connector.

**Claude**

1. In Claude, open **Settings**, then **Connectors**.
2. Add a custom connector with the URL `https://api.numi.sh/mcp`.
3. Sign in to numi on the page that Claude opens.

The tools are available after you sign in.

**ChatGPT**

1. In ChatGPT, open **Settings**, then **Apps and connectors**.
2. Add a connector with the URL `https://api.numi.sh/mcp` and OAuth as its authentication.
3. Sign in to numi on the page that ChatGPT opens.

**Cursor**

Add the server to `~/.cursor/mcp.json`, or to `.cursor/mcp.json` in a project:

```json theme={null}
{
  "mcpServers": {
    "numi": {
      "url": "https://api.numi.sh/mcp",
      "headers": { "Authorization": "Bearer YOUR_NUMI_API_KEY" }
    }
  }
}
```

**Claude Code**

Run:

```bash theme={null}
claude mcp add --transport http numi https://api.numi.sh/mcp \
  --header "Authorization: Bearer YOUR_NUMI_API_KEY"
```

To connect any other client that supports the Streamable HTTP transport, give it the URL and an `Authorization: Bearer` header with an API key.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.