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 fastest way to get started is the remote server. Point your client at: 
https://mcp.peaka.studio/mcp
The first request triggers OAuth. Approve the consent screen and the assistant can act as you in Peaka.
Remote MCP clients
{
  "mcpServers": {
    "peaka": {
      "url": "https://mcp.peaka.studio/mcp"
    }
  }
}
Not sure which form your client wants? See Supported clients — each row shows the right config snippet and a link to the client’s “add an MCP server” docs.
Restart the client after editing its config.

​
NPM (local)

If you’d rather run the server yourself with a Peaka API key: 
{
  "mcpServers": {
    "peaka": {
      "command": "npx",
      "args": ["-y", "@peaka/mcp-server-peaka@latest"],
      "env": {
        "PEAKA_API_KEY": "<YOUR_API_KEY>"
      }
    }
  }
}
Get an API key from How to generate API keys. Either a Project or Partner key works — see Authentication for the trade-offs.

​
First prompts to try

Once the server is connected, give your assistant a try:
  • “List my Peaka projects.”
  • “What catalogs and schemas are in project <id>?”
  • “Find me the top 10 customers by revenue last quarter.”
  • “Cache the orders table and schedule an incremental refresh every hour.”
  • “Save this query as monthly_active_users and surface it in a semantic catalog.”
On the remote server, the assistant is instructed to ask which project you want to work with once per session — unless you mention a specific project up front.

​
Next steps

Remote install details

OAuth flow, scopes, and screenshots.

Tools reference

Everything the assistant can do via the server.