Use with AI
MCP server
Deployment Playbook has a remote Model Context Protocol server so AI assistants can look up templates and plans, create plans and check gates for you.
- URL:
https://deployment-playbook.com/api/mcp(Streamable HTTP) - Auth:
Authorization: Bearer <workspace API token>(Admin → Connections & webhooks → Create API token)
| Tool | What it does |
|---|---|
list_templates |
Templates in the workspace (id, name, version, archived, step counts). |
get_template |
One template with its current steps per phase. |
create_plan |
Create a plan from a template id (idempotent by repository + ref). |
list_plans |
Recent plans, optionally filtered by status. |
get_plan |
A plan with phases, step ids and statuses, approvals count and link. |
check_gate |
Same as GET /api/gate (phase / step). |
Approvals stay human. No tool can approve, reject, skip or submit evidence: those decisions are made by people in the app (with four-eyes where configured). The token's permissions are those described in the API reference.
Cursor
.cursor/mcp.json in your project (or ~/.cursor/mcp.json):
{
"mcpServers": {
"deployment-playbook": {
"url": "https://deployment-playbook.com/api/mcp",
"headers": { "Authorization": "Bearer ${env:PLAYBOOK_API_TOKEN}" }
}
}
}
Claude Code
claude mcp add --transport http deployment-playbook https://deployment-playbook.com/api/mcp \
--header "Authorization: Bearer $PLAYBOOK_API_TOKEN"
Claude Desktop
Settings → Developer → Edit config (claude_desktop_config.json), using the mcp-remote bridge:
{
"mcpServers": {
"deployment-playbook": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://deployment-playbook.com/api/mcp", "--header", "Authorization:${PLAYBOOK_AUTH}"],
"env": { "PLAYBOOK_AUTH": "Bearer dpk_your_token" }
}
}
}
VS Code (GitHub Copilot)
.vscode/mcp.json:
{
"inputs": [{ "type": "promptString", "id": "playbook-token", "description": "Deployment Playbook API token", "password": true }],
"servers": {
"deployment-playbook": {
"type": "http",
"url": "https://deployment-playbook.com/api/mcp",
"headers": { "Authorization": "Bearer ${input:playbook-token}" }
}
}
}
Any other client
Any MCP client that supports Streamable HTTP: URL https://deployment-playbook.com/api/mcp, header
Authorization: Bearer <token>. Quick test with the inspector:
npx @modelcontextprotocol/inspector@latest --cli https://deployment-playbook.com/api/mcp --transport http \
--header "Authorization: Bearer $PLAYBOOK_API_TOKEN" --method tools/list
Treat the token like a password: keep it in an environment variable or your client's secret store, never in a committed file.
llms.txt
Machine-readable docs for AI tools, following llmstxt.org:
- /llms.txt: index with links to every docs page.
- /llms-full.txt: all docs in one Markdown file.