Pearl APIDocsReference

Using local Pearl API MCP Server

Local Pearl API MCP Server source code is available on GitHub https://github.com/Pearl-com/pearl_mcp_server

InstallationCopied!

Clone the repository:

git clone https://github.com/Pearl-com/pearl_mcp_server.git
cd pearl_mcp_server

Create a virtual environment and activate it:

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

Install dependencies:

pip install -e .

ConfigurationCopied!

Create a .env file in the src directory:

PEARL_API_KEY=your-api-key-here

Running the ServerCopied!

Local Development

Start the server using either stdio (default) or SSE transport:

# Using stdio transport (default)
pearl-mcp-server --api-key your-api-key

# Using SSE transport on custom port
pearl-mcp-server --api-key your-api-key --transport sse --port 8000

Connecting with MCP Clients

For connecting to a local MCP server using stdio transport, add the following configuration to your MCP client:

{
    "pearl-mcp-server": {
        "type": "stdio",
        "command": "pearl-mcp-server",
        "args": ["--api-key", "your-api-key"],
        "env": {
            "PEARL_API_KEY": "Your Pearl Api Key"
        }
    }
}