Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.peaka.com/llms.txt

Use this file to discover all available pages before exploring further.

The published @peaka/mcp-server-peaka package runs the server over stdio. Your MCP client launches it on demand with npx, and authentication is a single environment variable. This is the right choice when you want:
  • A locally-running server, no remote dependency.
  • API-key auth (for CI, headless scripts, or pinning to a specific Peaka identity).
  • Faster cold-starts than a remote round-trip.
For the zero-install path, see Remote.

​
Configure your client

Add the server to your MCP client config: 
{
  "mcpServers": {
    "peaka": {
      "command": "npx",
      "args": ["-y", "@peaka/mcp-server-peaka@latest"],
      "env": {
        "PEAKA_API_KEY": "<YOUR_API_KEY>"
      }
    }
  }
}
Replace <YOUR_API_KEY> with a Peaka API key. Restart the client after editing the config. Supported clients shows where each client’s config file lives.

​
Get an API key

You can use either a Project or Partner API key:
  • Project API key — bound to a single Peaka project. Simplest. Good for everyday use against one project. See How to generate API keys.
  • Partner API key — enumerates projects across organizations and workspaces. Use this if you want the assistant to discover and switch between projects. See How to manage Partner API keys.
Full breakdown in Authentication.

​
Environment variables

NameDescription
PEAKA_API_KEYProject or Partner API key for authenticating with Peaka. Required.

​
Verify it’s working

After your client restarts:
  1. Confirm the peaka server shows up in your client’s MCP server list.
  2. Ask your assistant: “List my Peaka projects.”
  3. The first response should call peaka_list_projects and return the projects your key can see.
If nothing happens, see Troubleshooting.

​
Updating

Because the config uses @latest, every cold start picks up the newest server release. To pin a version: 
"args": ["-y", "@peaka/mcp-server-peaka@0.7.0"]
Releases live on npm and GitHub.