Playbooks tools include field-level argument descriptions and runnable examples for MCP clients.
Tools Covered
| Tool | Mutation | Backend Routes |
|---|---|---|
playbook_list |
No | /view-all-pitches-streams-sorted |
playbook_open |
No | /retrieve-pitch |
playbook_list
List playbooks with search/sort/pagination.
Backend routes: /view-all-pitches-streams-sorted
Arguments
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
sort_order |
string (ASC | DESC) | No | Sort direction. | DESC |
page |
number | No | Pagination page number (1-based). Defaults to 1. | 1 |
page_size |
number | No | Number of rows per page. Defaults to 50, maximum 200. | 50 |
search |
string | No | Free-text search term for list endpoints. | banking |
archived |
boolean | No | When true, list archived records. | false |
viewer_id |
string | No | Optional explicit user context override. If omitted, MCP resolves this from the authenticated token/session. | IGH6969811447860000000000 |
organisation_id |
string | No | Optional explicit organisation context override. If omitted, MCP resolves this from the authenticated token/session. | PDX7478889578460000000000 |
Example Request
List active playbooks
{
"jsonrpc": "2.0",
"id": "playbook_list-1",
"method": "tools/call",
"params": {
"name": "playbook_list",
"arguments": {
"page": 1,
"page_size": 50,
"sort_order": "DESC",
"search": "Openspace",
"archived": false
}
}
}
Example Success
{
"success": true,
"data": {
"tool": "playbook_list",
"note": "Payload shape depends on tenant data and backend route output."
},
"error": null
}
Example Failure
{
"success": false,
"data": null,
"error": {
"code": "INVALID_ARGUMENTS",
"message": "Missing or invalid parameters for playbook_list.",
"status": 400,
"retryable": false
}
}
playbook_open
Open playbook and return canonical metadata.
Backend routes: /retrieve-pitch
Arguments
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
pitch_id |
string | Yes | Deal room / playbook pitch identifier. | PCH1774126974294428638749 |
viewer_id |
string | No | Optional explicit user context override. If omitted, MCP resolves this from the authenticated token/session. | IGH6969811447860000000000 |
organisation_id |
string | No | Optional explicit organisation context override. If omitted, MCP resolves this from the authenticated token/session. | PDX7478889578460000000000 |
Example Request
Open one playbook
{
"jsonrpc": "2.0",
"id": "playbook_open-1",
"method": "tools/call",
"params": {
"name": "playbook_open",
"arguments": {
"pitch_id": "ITV8581355464240000000000"
}
}
}
Example Success
{
"success": true,
"data": {
"tool": "playbook_open",
"note": "Payload shape depends on tenant data and backend route output."
},
"error": null
}
Example Failure
{
"success": false,
"data": null,
"error": {
"code": "INVALID_ARGUMENTS",
"message": "Missing or invalid parameters for playbook_open.",
"status": 400,
"retryable": false
}
}