Getting started
Overview
Run zkMCP locally and understand the pieces involved in a protected MCP call.
zkMCP is currently a monorepo prototype rather than a published npm package. The fastest way to evaluate it is to run the repository directly.
Prerequisites
- Node.js 22+
- Docker Desktop with Docker Compose
- Compact compiler
0.31.1 - macOS or Linux
Repository packages
@zkmcp/core typed errors and privacy-safe observability
@zkmcp/midnight Midnight wallet, Compact contract connection, proving
@zkmcp/gateway MCP proxy and authorization boundary
@zkmcp/web Fumadocs documentation and playgroundThe packages are workspace-local today. They are intentionally documented by their future package boundaries, but they are not published to npm yet.
Recommended path
- Install the repository.
- Run the local stack.
- Read Your first protected tool.
- Open the Playground.