Overview
What is peaka-mcp-server?
peaka-mcp-server is a Model Context Protocol (MCP) server that gives LLMs access to Peaka's text2SQL capabilities. It enables AI agents to inspect database schemas and execute SQL queries on Peaka projects.
How to use peaka-mcp-server?
Install by adding a configuration entry to your MCP client's config file (e.g., Claude Desktop's claude_desktop_config.json). Run the server via npx -y @peaka/mcp-server-peaka@latest and set the PEAKA_API_KEY environment variable. For packaged installation, run npm run pack to produce a .mcpb bundle and install it as a Claude Desktop extension.
Key features of peaka-mcp-server
- List and manage Peaka projects and connections
- Inspect database schemas, tables, and columns
- Execute raw SQL queries via Peaka
- Query and create golden question/SQL pairs
- Manage table caches (create, refresh, update, delete)
- Create and manage saved queries and semantic catalogs
Use cases of peaka-mcp-server
- LLM agents exploring and querying a Peaka project’s schema
- Automating SQL query generation from natural language questions
- Managing cache policies to improve query performance
- Building and maintaining semantic layers with saved queries
- Refreshing stale project metadata for up-to-date schema info
FAQ from peaka-mcp-server
What does peaka-mcp-server do?
It provides MCP tools that let LLMs list projects, inspect schemas, execute SQL queries, and manage caches and saved queries on Peaka projects.
How is peaka-mcp-server authenticated?
Set the PEAKA_API_KEY environment variable with a valid Peaka API key (either Partner or Project key). See Peaka documentation for generating API keys.
What are the runtime dependencies?
Node.js and npm are required to run the server via npx. The server is published as an npm package @peaka/mcp-server-peaka.
Where does the data live and how is it accessed?
All data resides within the configured Peaka project(s). The server communicates with Peaka’s partner API (default: https://partner.peaka.studio/api/v1) and does not store any data locally.
What transport does peaka-mcp-server use?
The server runs as a subprocess using stdio transport, as is standard for MCP servers invoked via npx. It also supports MCP’s HTTP streaming mode (not described in detail in the README).
