Paper

Official MCP server for Paper's trading platform - enables AI assistants to interact with Paper's API

javascript

19

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "paperinvest-mcp-server": {
      "command": "paper-mcp-server",
      "args": [],
      "env": {
        "PAPER_API_KEY": "YOUR_API_KEY",
        "PAPER_API_BASE_URL": "https://api.paperinvest.io"
      }
    }
  }
}

You can run the Paper MCP Server to let AI coding assistants interact with Paper’s Trading API. It enables you to fetch quotes, simulate orders, and inspect portfolios through an MCP client or IDE integrations.

How to use

Set up and run the MCP server locally, then connect your MCP client or IDE integration to the server. You’ll use it to retrieve real-time quotes, place sandbox orders, and view your simulated portfolio. Start the server in your shell, provide your API credentials, and point your client at the local server entry point. Once running, restart your clients to establish the connection and begin sending prompts that request quotes, orders, or portfolio data.

How to install

Prerequisites: Node.js 16 or later.

Install the MCP server globally for CLI usage or run it via npx.

# Global install (recommended for CLI usage)
npm i -g @paperinvest/mcp-server

# Or run with npx
npx @paperinvest/mcp-server --help

Configuration and usage notes

Provide Paper API credentials through environment variables in your shell or a .env file.

export PAPER_API_KEY=your_api_key
# Optional override
export PAPER_API_BASE_URL=https://api.paperinvest.io

Additional sections

IDE integrations are supported to streamline your workflow. You can configure the MCP server in your IDE’s MCP configuration to automatically connect to Paper’s MCP server using your API key.

Examples of integration configurations are provided for Cursor and Claude Desktop to demonstrate how to wire your MCP server into your editor or assistant.

Troubleshooting

Ensure the MCP server binary is discoverable in your PATH. On some systems, you may need to verify the global npm bin path and add it to PATH.

Make sure PAPER_API_KEY is set in the same environment as your MCP client, and restart the client after changing credentials.

Check connectivity to the Paper API base URL if you override it.

Notes and examples

You can reference example configurations and scripts to see how the MCP server is wired into common clients like Cursor and Claude. These examples illustrate how to load your API key and run the server in tandem with your IDE.

Links and support

Explore more tools and usage examples, and reach out for support if you encounter issues.

Available tools

paper.quote

Get real-time NBBO quote for a symbol.

paper.quotesBatch

Get quotes for multiple symbols in a single request.

paper.order

Place a simulated order (market/limit/stop, etc.).

paper.portfolio

Retrieve portfolio positions and P&L.