Skip to content

Pi

Setup guide only, not run live

What Zyx serves and which gates apply: Use Zyx from your AI tool.

Pi has no MCP client of its own, by design. So Pi reaches Zyx over REST: the same tools, gates and cards as /api/mcp.

  1. In Zyx, open Manage, API & MCP and make a key for the person Pi acts as.

  2. export ZYX_KEY=<key>, and give Pi a skill (or an AGENTS.md note) with these calls:

    Terminal window
    # what Zyx offers this key
    curl -s https://zyx.example.com/api/v1/tools -H "Authorization: Bearer $ZYX_KEY"
    # call one tool; the body is its input; add ?folder=<folder> to work in one folder
    curl -s -X POST https://zyx.example.com/api/v1/tools/search_notes \
    -H "Authorization: Bearer $ZYX_KEY" \
    -H "content-type: application/json" \
    -d '{"query":"discount terms"}'
    Answer Means
    200 the result
    202 a card waits for a person; the approval runs the call, so do not call again. Read the result with zyx_card or GET /api/v1/approvals/<card>
    403 refused
    404 no such tool for this key
    400 bad input

The input above is an example. GET /api/v1/tools returns each tool’s real schema.

A community extension adds MCP to Pi. It is neither Zyx’s nor Pi’s own and was not reviewed or tried; treat it like any third-party code before installing it.

  • Nothing with Pi itself. The REST routes are covered by Zyx’s own tests.