Playbook

Procedures as JSON. Search them by intent, walk titles, load one do at a time.

Playbook is a small CLI and MCP server so an agent (or you) can write, find, and follow how-tos without dumping the whole playbook into context. CLI verbs stay split. MCP compresses related verbs into fewer tools. Everything is JSON.

Python 3.10+, stdlib only at runtime.

Install

pip install -e .
playbook search

PyPI is not published yet.

Related MCP server: servicenow-platform-mcp

Where files live

One JSON file per procedure, in the platform data dir:

Honor XDG_DATA_HOME / APPDATA / LOCALAPPDATA. Commands take a procedure id, not a path.

Shape

{
  "id": "follow-playbook",
  "title": "Follow a playbook procedure",
  "description": "When to pick this file. Can be verbose.",
  "tags": ["playbook", "follow"],
  "steps": [
    {
      "id": "a1b2c3…",
      "title": "Search by intent",
      "do": "Call playbook_search with a sentence for the job."
    }
  ]
}

• title — short name on search cards

• description — when to pick this procedure

• steps — serial. Unique titles. Random step ids. do is the work.

CLI

Every command prints JSON (including errors).

playbook create demo --title "Demo" --description "when to pick this" --tags demo
playbook add-step demo --title "First" --do "Do the first thing."
playbook add-step demo --title "Middle" --do "Do the middle." --after "First"
playbook edit demo --title "Better title"
playbook search "I want to follow a procedure"
playbook load demo
playbook load demo --full
playbook start demo --title "First"
playbook validate demo
playbook mcp

search is BM25 plus character n-grams. Hits are id, title, description only (default 8, cap 50). Weak matches are dropped.

load is titles only. --full includes every do. start is one do plus before / after titles.

MCP (Grok)

grok mcp add --scope user playbook -- playbook mcp

Use an absolute path to playbook if the spawned process will not have your shell PATH. Then /mcps and r, or a new session.

Tests

pip install -e .
python -m pytest tests/ -q

License

MIT