PACKAGE EXPLORERView in registry

@0gzk/mcp

npm

MCP server for 0gzk: circuit discovery over the catalog and live registries, plus circuit authoring tools

Versions collected1

Direct dependencies10From release 0.1.0

Last observed20 Oct, 22:11 UTC

README

Current package documentation

@0gzk/mcp

MCP (Model Context Protocol) server for the 0gzk circuit ecosystem: lets AI agents discover ZK circuits (from the repo catalog or the live on-chain registries), inspect their input/output schemas, check a user's values against them, generate proofs, and author new circuits — scaffold, validate, build — over stdio.

npx -y @0gzk/mcp

Tools

Tool	Mode	What it does
`search_circuits`	both	Weighted search over names, tags, keywords, use cases, descriptions (registry name-match in discovery mode)
`list_circuits`	both	List catalog circuits or page through a live registry
`get_circuit`	both	Full record for one circuit: metadata, constraints, example input, publications, how-to-prove; can fetch published bundles into the cache
`get_example_input`	both	The committed `example_input.json` for a catalog circuit
`resolve_circuit`	both	Resolve `name[@version]` against all registries → rootHash/vkeyHash/verifier per chain
`validate_inputs`	both	Check candidate inputs against a circuit's signal schema without proving → `{valid, errors, schema}`; call it with no inputs to get the schema (and `missing`) so you can ask the user for exactly what is needed
`read_input_file`	both	Read a local JSON input file and report only the signal names and value types — the values stay on the machine; pass the path to `prove_circuit` as `inputFile`
`prove_circuit`	both	Generate + locally verify a proof from a repo bundle (`name`), a bundle dir, or a published rootHash. Inputs inline or via `inputFile`; `outDir` writes `proof.json`, `public.json`, `result.json`
`scaffold_circuit`	repo	Create `circuits/<name>/` with a `.circom` skeleton, `metadata.json`, `build.sh`, empty `example_input.json`
`validate_metadata`	repo	Validate a `metadata.json` → `{valid, errors, warnings}`
`build_circuit`	repo	circom compile + Groth16 phase-2 setup → publish-ready `circuit_bundle/` (needs `circom` on PATH)

That is 11 tools in repo mode, 8 in discovery mode. Chain-aware tools default to base.

Resources: ogzk://guide/circom-authoring (the authoring guide) and ogzk://catalog (the raw circuits/index.json, repo mode only). The scheme is ogzk because URI schemes cannot start with a digit.

Repo mode vs discovery mode

Repo mode — the server found a 0gzk checkout (via --repo-root, OGZK_REPO_ROOT, walking up from the cwd, or an explicit --catalog path/to/index.json). The catalog powers search/list/get, and all four authoring tools are registered: 11 tools total.
Discovery mode — no checkout, no catalog. The five discovery tools plus validate_inputs, read_input_file and prove_circuit are registered (8 total), answered from the live registries; get_circuit and prove_circuit fetch published bundles into ~/.0gzk/bundles/<rootHash>/ on demand.

Client configuration

Claude Code:

claude mcp add 0gzk -- npx -y @0gzk/mcp

Claude Desktop / Cursor (JSON config):

{
  "mcpServers": {
    "0gzk": {
      "command": "npx",
      "args": ["-y", "@0gzk/mcp"]
    }
  }
}

Working inside the 0gzk repo itself, use the checked-in .mcp.json (points at packages/mcp/dist/bin.js), or pass --repo-root <path>.

Environment variables

Variable	Effect
`OG_NETWORK` / `OGZK_NETWORK`	Selects the network that `OG_RPC_URL` applies to (`base` — the default — `base-sepolia`, `0g-mainnet`, `0g-testnet`)
`OG_RPC_URL`	RPC override for the selected network only
`OGZK_REGISTRY_ADDRESS_BASE`	Override the built-in CircuitRegistry address on Base
`OGZK_REGISTRY_ADDRESS_BASE_SEPOLIA`	Override the built-in CircuitRegistry address on Base Sepolia
`OGZK_REPO_ROOT`	Path to a 0gzk checkout (enables repo mode)
`OGZK_CACHE_DIR`	Bundle cache dir (default `~/.0gzk/bundles`)

Library usage

The package is also importable: @0gzk/mcp (server + context), @0gzk/mcp/catalog (catalog generate/load/search/README table), and @0gzk/mcp/tools (transport-agnostic tool definitions).

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases

Version	Published	Direct dependencies	Open version
0.1.0Registry latest	2 Sept 2026	10

Package advisories

No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING

0gzk/core

Shared repository data · GitHub

License detected in repository: Not collected

Metadata history

Meaningful changes

Current collected state Current

Observed since 20 Oct, 22:11 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:61d1834071ba3cb7b45a16b95599579a2e34758a82c80f8690789d0b397c9679