Installation¶
Requirements¶
- Python ≥ 3.10
- Claude Code installed (the
initcommand checks for it; if absent, it prints instructions and still writes config so you can register manually) - A Postman account with a personal API key
giton your PATH (used bysyncchangesto detect what changed)
Install from PyPI¶
This single package delivers four things:
- The CLI — the
postman-mcpcommand. - The MCP server — a local stdio server that Claude Code launches.
- The slash-command markdown files — copied into your project on
init. - The engine, parsers, and Postman client that do the real work.
After install, verify it's on your PATH:
Nothing is connected yet
pip install only puts the bits on disk. All wiring — the API-key handshake,
workspace/collection selection, MCP-server registration, and slash-command install —
happens in postman-mcp init. Run it once per project.
Recommended: pipx or uv¶
To keep the CLI isolated from your project environments:
Install from source (for contributors)¶
git clone https://github.com/logesh-works/postman-mcp
cd postman-mcp
python -m venv .venv
# Windows (PowerShell): .venv\Scripts\Activate.ps1
# macOS / Linux: source .venv/bin/activate
pip install -e ".[dev]"
See the contributing guide for the full development setup.