> For the complete documentation index, see [llms.txt](https://docs.openalgo.in/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openalgo.in/mcp.md).

# MCP

OpenAlgo exposes trading, account, market-data, calendar, and research functions through the Model Context Protocol. Local and remote transports use the same tool implementation.

| Transport       | Intended client                                             | Authentication                               | Default   |
| --------------- | ----------------------------------------------------------- | -------------------------------------------- | --------- |
| Local stdio     | Claude Desktop, Cursor, Windsurf, or another local MCP host | OpenAlgo API key passed to the local process | Available |
| Remote HTTP/SSE | Hosted clients that connect over HTTPS                      | OAuth 2.1 bearer token and per-tool scope    | Disabled  |

Enabling Remote MCP does not change the local stdio setup.

## Prerequisites

1. Run OpenAlgo and complete broker authentication.
2. Generate an application API key from **Profile -> API Keys**.
3. Locate the Python executable in the OpenAlgo virtual environment and the absolute path to `mcp/mcpserver.py`.

Node.js is not required for the Python MCP server.

## Local Stdio Setup

Add an MCP server entry to the local client's configuration. Replace all placeholders with paths and values for the machine running OpenAlgo.

```json
{
  "mcpServers": {
    "openalgo": {
      "command": "/absolute/path/to/openalgo/.venv/bin/python3",
      "args": [
        "/absolute/path/to/openalgo/mcp/mcpserver.py",
        "YOUR_OPENALGO_API_KEY",
        "http://127.0.0.1:5000"
      ]
    }
  }
}
```

On Windows, use the virtual-environment executable ending in `.venv\\Scripts\\python.exe` and Windows-style absolute paths. The server requires the API key as the first argument and the OpenAlgo host as the second argument.

Common configuration locations include:

| Client         | macOS/Linux                                                                | Windows                                         |
| -------------- | -------------------------------------------------------------------------- | ----------------------------------------------- |
| Claude Desktop | `~/Library/Application Support/Claude/claude_desktop_config.json` on macOS | `%APPDATA%\\Claude\\claude_desktop_config.json` |
| Windsurf       | `~/.config/windsurf/mcp_config.json`                                       | `%APPDATA%\\Windsurf\\mcp_config.json`          |
| Cursor         | Client-specific MCP settings                                               | Client-specific MCP settings                    |

Restart the MCP client after changing its configuration. Confirm that OpenAlgo is running and that the broker session is valid before calling account or trading tools.

{% embed url="<https://www.youtube.com/watch?v=oczs8KOrxIo>" %}

## Remote Setup

Hosted clients connect to:

```
https://<your-openalgo-domain>/mcp
```

Remote MCP requires HTTPS, OAuth configuration, and deliberate review of approval and write-scope controls. It is disabled by default. See [Remote MCP](/mcp/remote-mcp.md) for installation, OAuth consent, client setup, audit, and revocation guidance.

## Tool Groups

The shared registry includes:

* Regular, smart, options, basket, split, modify, cancel, and close operations.
* Orders, trades, positions, holdings, funds, and margin reads.
* Quotes, batches, depth, history, option-chain, symbol, expiry, and instrument lookup.
* Analyzer-mode controls, market holidays and timings, and Telegram notifications.
* Technical indicators, scanners, and multi-timeframe research helpers.

See [Tool References](/mcp/tool-references.md) for parameters and prompt examples. A client should rely on the tool schemas returned by the running server when a static example differs from the installed version.

## Safety

* Start order workflows in Analyzer mode and inspect the result before using live mode.
* Local stdio configuration contains the OpenAlgo API key. Restrict access to the client configuration file.
* Remote read and write scopes are separate. Do not grant `write:orders` unless the client is intended to trade.
* Review symbol, exchange, product, quantity, order type, and current application mode before confirming an order tool.
* Broker access and risk checks remain authoritative; a successful MCP tool call does not bypass broker validation.

## Troubleshooting

| Symptom                           | Check                                                                        |
| --------------------------------- | ---------------------------------------------------------------------------- |
| MCP process exits immediately     | Python path, script path, API-key argument, and host argument                |
| Authentication error              | API key validity and OpenAlgo application state                              |
| Account tools fail                | Current broker login and broker session                                      |
| Tool is unavailable               | Tool list returned by the installed server and client-side tool permissions  |
| Remote connector cannot authorize | Remote MCP enablement, public URL, OAuth settings, and client approval state |