Servers Playground How we check Add a server Log in

ZeroWidth Compass

Working · 1.3 s

ai.zerowidth/compassv1.0.0 Domain verified

Read and update your Compass map: pages, changes, opportunities and interviews.

Productivity

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://api.zerowidth.ai/mcp/x/compass

Authorization (optional)

Bearer token: a workspace API key or personal access token from accounts.zerowidth.ai

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

comments_create

Posts a comment on a workspace entity — a new thread, or a reply when rootId is given. Use it to leave findings where the discussion already lives (an eval result on the flow being debated, a summary on a long thread). Mention people via mentionedUserIds (from workspace member ids) to ring their notification bell; never mention someone who didn't ask to be pulled in.

bodystring, required

entityIdstring, required

entityKindstring, required

What the thread hangs on.

rootIdstring

Reply into this thread; omit to start a new one.

workspacestring

Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

approvalIdstring

mentionedUserIdsarray

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

ZeroWidth Compass MCP server | mcptry

ZeroWidth Compass

Working · 1.3 s

ai.zerowidth/compassv1.0.0 Domain verified

Read and update your Compass map: pages, changes, opportunities and interviews.

Productivity

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://api.zerowidth.ai/mcp/x/compass

Authorization (optional)

Bearer token: a workspace API key or personal access token from accounts.zerowidth.ai

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

comments_create

bodystring, required

entityIdstring, required

entityKindstring, required

What the thread hangs on.

rootIdstring

Reply into this thread; omit to start a new one.

workspacestring

Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

approvalIdstring

mentionedUserIdsarray

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Tools (62)

comments_create

Argument	Type	Description
body*	string
rootId	string	Reply into this thread; omit to start a new one.
entityId*	string
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string
entityKind*	string	What the thread hangs on.
mentionedUserIds	array

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "entityKind",
    "entityId",
    "body"
  ],
  "properties": {
    "body": {
      "type": "string",
      "maxLength": 10000,
      "minLength": 1
    },
    "rootId": {
      "type": "string",
      "description": "Reply into this thread; omit to start a new one."
    },
    "entityId": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string"
    },
    "entityKind": {
      "enum": [
        "workbench_flow",
        "compass_page",
        "compass_opportunity",
        "caliper_review",
        "caliper_dataset",
        "caliper_rubric",
        "caliper_eval",
        "caliper_spec",
        "napkin_board",
        "napkin_diagram",
        "napkin_doc",
        "napkin_sheet",
        "napkin_interface",
        "ledger_entry",
        "prism_field",
        "workspace_file"
      ],
      "type": "string",
      "description": "What the thread hangs on."
    },
    "mentionedUserIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 20
    }
  }
}

comments_list

Lists the comment threads on one workspace entity (open first, then resolved) with authors and timestamps. Read this before weighing in on contested work — the threads are where disagreement lives before it becomes a decision.

read-only

Argument	Type	Description
entityId*	string
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
entityKind*	string	What the thread hangs on.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "entityKind",
    "entityId"
  ],
  "properties": {
    "entityId": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "entityKind": {
      "enum": [
        "workbench_flow",
        "compass_page",
        "compass_opportunity",
        "caliper_review",
        "caliper_dataset",
        "caliper_rubric",
        "caliper_eval",
        "caliper_spec",
        "napkin_board",
        "napkin_diagram",
        "napkin_doc",
        "napkin_sheet",
        "napkin_interface",
        "ledger_entry",
        "prism_field",
        "workspace_file"
      ],
      "type": "string",
      "description": "What the thread hangs on."
    }
  }
}

comments_resolve

Sets a comment thread's resolved state (rootId = the thread's root comment id). Resolve ONLY when the human asked or the thread's question is demonstrably settled — and say what settled it in a reply first. Reopening is for new evidence.

destructive

Argument	Type	Description
rootId*	string
resolved*	boolean
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "rootId",
    "resolved"
  ],
  "properties": {
    "rootId": {
      "type": "string",
      "maxLength": 60,
      "minLength": 1
    },
    "resolved": {
      "type": "boolean"
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string"
    }
  }
}

compass_change_effects_set

Replace a change's effects: for each step it reaches (workflowPageId + nodeId from compass_workflow_steps — a sub-workflow's steps included), one of eliminate, automate (reviewMinutes: what a person still spends checking), parallelize (its wait comes off the critical path), relax_gate (keepShare: share of the wait left, default 0.25), assist (keepShare: share of hands-on time left, default 0.5), reassign (toSubjectPageId). Eliminating or automating every step of a sub-workflow collapses the step that is that sub-workflow. Then project with compass_workflow_rollup changeIds. May return `needs_confirmation`.

destructive

Argument	Type	Description
effects*	array
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
opportunityId*	string	The change's key (e.g. ACME-12) or id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "opportunityId",
    "effects"
  ],
  "properties": {
    "effects": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "workflowPageId",
          "nodeId",
          "effect"
        ],
        "properties": {
          "note": {
            "type": "string",
            "maxLength": 400
          },
          "effect": {
            "enum": [
              "eliminate",
              "automate",
              "parallelize",
              "relax_gate",
              "assist",
              "reassign"
            ],
            "type": "string"
          },
          "nodeId": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          },
          "keepShare": {
            "type": "number",
            "maximum": 1,
            "minimum": 0
          },
          "reviewMinutes": {
            "type": "object",
            "required": [
              "low",
              "high"
            ],
            "properties": {
              "low": {
                "type": "number",
                "maximum": 100000,
                "minimum": 0
              },
              "high": {
                "type": "number",
                "maximum": 100000,
                "minimum": 0
              }
            }
          },
          "workflowPageId": {
            "type": "string",
            "minLength": 1
          },
          "toSubjectPageId": {
            "type": "string",
            "minLength": 1
          }
        }
      },
      "maxItems": 100
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "opportunityId": {
      "type": "string",
      "description": "The change's key (e.g. ACME-12) or id."
    }
  }
}

compass_changes_upsert

Create or update up to 100 changes in one call, each matched by `url` — the GitHub issue, Linear or Jira ticket, PR or doc it mirrors. A url already linked to a change updates that change (label, description, status, tags, experiment, workflow — omitted fields are left alone); any other url creates a change with that link. Run it again with the same urls to keep Compass in step; nothing duplicates. Statuses are by name (compass_statuses_list). Returns one result per item — created / updated with the change's key, or failed with why; a failed item doesn't stop the rest. Summarize what you're about to bring in before calling. May return `needs_confirmation` — one approval covers the whole batch.

destructive

Argument	Type	Description
items*	array
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "url",
          "label"
        ],
        "properties": {
          "url": {
            "type": "string",
            "format": "uri",
            "maxLength": 2000
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[a-zA-Z0-9](?:[a-zA-Z0-9 -]*[a-zA-Z0-9])?$",
              "maxLength": 40,
              "minLength": 1
            },
            "maxItems": 50
          },
          "label": {
            "type": "string",
            "maxLength": 200,
            "minLength": 2
          },
          "linkTitle": {
            "type": "string",
            "maxLength": 300
          },
          "experiment": {
            "type": "boolean"
          },
          "statusName": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "description": {
            "type": "string",
            "maxLength": 5000
          },
          "workflowPageId": {
            "anyOf": [
              {
                "type": "string",
                "minLength": 1
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "maxItems": 100,
      "minItems": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved."
    }
  }
}

compass_gaps_create

Records something you don't yet know — the gap registry is your working memory, so use it liberally while mapping or interviewing. Give one clear question, WHY it matters (what answering it unblocks), and how you'd resolve it (ask the user / interview a specific person / connect a source). No approval needed — noting your own uncertainty isn't acting on the user's behalf. Attach it to a subject (subjectType/subjectId) when it's ABOUT a specific page or person.

Argument	Type	Description
question*	string	The open question, plainly ('Who approves refunds over $500?').
rationale	string	Why it matters / what answering it unblocks.
subjectId	string	Id of the subject.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
subjectType	string	What it's about, e.g. compass_page.
suggestedResolution	string	How to resolve it: 'ask the user', 'interview Dana', 'connect Drive'.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "question"
  ],
  "properties": {
    "question": {
      "type": "string",
      "description": "The open question, plainly ('Who approves refunds over $500?')."
    },
    "rationale": {
      "type": "string",
      "description": "Why it matters / what answering it unblocks."
    },
    "subjectId": {
      "type": "string",
      "description": "Id of the subject."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "subjectType": {
      "type": "string",
      "description": "What it's about, e.g. compass_page."
    },
    "suggestedResolution": {
      "type": "string",
      "description": "How to resolve it: 'ask the user', 'interview Dana', 'connect Drive'."
    }
  }
}

compass_gaps_list

Lists the workspace's open questions — the gap registry: what the map doesn't know yet. Defaults to OPEN gaps. This is where you keep your head — check it before asking the user something you may already have flagged, and compose interview briefs from a subject's open questions.

read-only

Argument	Type	Description
status	string	Filter by lifecycle stage. Default OPEN.
subjectId	string	Only gaps ABOUT this subject id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
subjectType	string	Only gaps ABOUT this subject type (e.g. compass_page).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "status": {
      "enum": [
        "OPEN",
        "INTERVIEW_SENT",
        "ANSWERED",
        "DISMISSED"
      ],
      "type": "string",
      "description": "Filter by lifecycle stage. Default OPEN."
    },
    "subjectId": {
      "type": "string",
      "description": "Only gaps ABOUT this subject id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "subjectType": {
      "type": "string",
      "description": "Only gaps ABOUT this subject type (e.g. compass_page)."
    }
  }
}

compass_gaps_resolve

Closes a gap once you've learned the answer (ANSWERED, with the resolution) or decided it doesn't matter (DISMISSED). Keep the registry honest — resolve gaps as their answers land (from an interview, a doc, or the user) so it always reflects what's still unknown. The resolution alone isn't the map: when the answer says something about a page (who does a step, a tool they use, how a decision gets made), write it there too in the same turn, on the page it's about or as the step, person or system it names. Gaps you raised close without a card; a question a person wrote needs their approval.

destructive

Argument	Type	Description
gapId*	string	Id of the gap (from compass_gaps_list).
status*	string	ANSWERED (you learned it) or DISMISSED (irrelevant).
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Re-call with the approvalId from a needs_confirmation response after the user approves.
resolution	string	The answer / note, when marking ANSWERED.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "gapId",
    "status"
  ],
  "properties": {
    "gapId": {
      "type": "string",
      "description": "Id of the gap (from compass_gaps_list)."
    },
    "status": {
      "enum": [
        "ANSWERED",
        "DISMISSED"
      ],
      "type": "string",
      "description": "ANSWERED (you learned it) or DISMISSED (irrelevant)."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Re-call with the approvalId from a needs_confirmation response after the user approves."
    },
    "resolution": {
      "type": "string",
      "description": "The answer / note, when marking ANSWERED."
    }
  }
}

compass_gaps_update

Edits an open question's wording, rationale, or suggested resolution — for sharpening a vague question or fixing one you phrased badly. Closing a gap is compass_gaps_resolve, not this. Gap ids come from compass_gaps_list. May return `needs_confirmation`.

destructive

Argument	Type	Description
gapId*	string	Id of the gap (from compass_gaps_list).
question	string	New wording of the question.
rationale	string	Why it matters / what answering it unblocks.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
suggestedResolution	string	How to resolve it: 'ask the user', 'interview Dana', 'connect Drive'.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "gapId"
  ],
  "properties": {
    "gapId": {
      "type": "string",
      "description": "Id of the gap (from compass_gaps_list)."
    },
    "question": {
      "type": "string",
      "description": "New wording of the question."
    },
    "rationale": {
      "type": "string",
      "description": "Why it matters / what answering it unblocks."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "suggestedResolution": {
      "type": "string",
      "description": "How to resolve it: 'ask the user', 'interview Dana', 'connect Drive'."
    }
  }
}

compass_inbox_list

The Compass Inbox in one read: finished interviews awaiting review (transcript in, not yet turned into pages), AI-proposed opportunities awaiting accept / dismiss, and the caller's pending approval cards for Compass writes. THE place to answer 'what needs me?' for the map. Also `fillIn`: what the map is missing to say who's responsible for what (priorities with no owner, business units with no lead, people and roles in no unit, priorities with no workflow behind them); not counted in `total`. Next moves: compass_interviews_get to read a transcript, then propose pages from it with compass_pages_create; compass_opportunities_accept or compass_opportunities_delete for a proposal. For fillIn, ask the user who owns or leads it, or which unit someone sits in, then compass_links_create with kind owns (person or role → priority or unit) or part_of (person, role or unit → unit); never guess an owner.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_interview_invite

Emails the guest link for an existing interview, framed as coming from the REQUESTING USER (their name signs it; replies go to them). Author `message` in their voice — short, human, says why THEIR knowledge matters and that it takes ~15 minutes, no account needed. The approval card shows the exact subject + message before anything sends. Limit: the invite plus ONE reminder; a third ask is the user's conversation to have. Completion arrives as a notification with draft-page counts — don't poll.

Argument	Type	Description
email*	string	The interviewee's email address.
message*	string	The body, written in the requesting user's voice. Greeting + link + signature are added automatically — write only the middle.
subject*	string	Email subject, e.g. '15 minutes on how refunds actually work?'
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
interviewId*	string	Interview id from compass_interviews_create.

Input schema (JSON)

compass_interview_targets

Ranks the PEOPLE the map says know about a page (workflow, system, pain point): `owns` links first, then `involved_in`, then weaker edges. Each target carries contact email + role from their PERSON page and their latest interview (skip someone who just gave one — interview fatigue is real). Empty result = the map doesn't know an owner: ASK THE USER who runs this, create the PERSON page + owns link from the answer, and the map gets smarter. Use before compass_interviews_create to pick the interviewee.

read-only

Argument	Type	Description
pageId*	string	The page the knowledge gap is about.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "pageId": {
      "type": "string",
      "description": "The page the knowledge gap is about."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_interviews_create

Mints a stakeholder-interview invite: a no-account guest link where the person talks to an interviewer agent briefed by your focusPrompt, and the transcript flows back into Compass as reviewable draft pages. THE KNOWLEDGE-GAP MOVE: when caliper_flow_performance shows failures clustered on missing company facts (the judge says the flow invented a policy, missed a rule, didn't know who owns something), the fix is usually not a prompt edit — it's asking the human who actually knows. Write a focusPrompt that names the SPECIFIC gaps (cite the eval run id), pick the owner of the relevant workflow as interviewee when the map knows one. When you have their email, send the link with compass_interview_invite next rather than asking the user to forward it; otherwise hand the user the link. May return `needs_confirmation` — tell the user who you want to interview and why, then wait.

Argument	Type	Description
anonymous	boolean	The guest is told it's anonymous and never asked who they are; no name or email is kept, so leave intervieweeName and intervieweeEmail out, and the link isn't emailed from here. Use when the user asks for anonymous interviews.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
focusPrompt*	string	The interviewer's aim (≤2000 chars), never shown to the guest: why the team is asking, in one sentence; 2–3 things to come away knowing, each describable from experience (who does a step, what happens when it goes wrong, how long it waits, why a check exists), aimed at what the map doesn't know; and what the answers feed. No opinion or preference questions.

compass_interviews_get

One interview in full — metadata plus the transcript of what the guest actually said. Read this before summarizing an interview or drafting pages from it: the transcript is the source you work from, and your compass skill has the rules for typing and splitting what's in it. Ids come from compass_interviews_list or compass_inbox_list.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
interviewId*	string	Interview id (from compass_interviews_list).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "interviewId"
  ],
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "interviewId": {
      "type": "string",
      "description": "Interview id (from compass_interviews_list)."
    }
  }
}

compass_interviews_list

Every stakeholder interview in the workspace, newest first: who was invited, status (INVITED / IN_PROGRESS / COMPLETED), focus, message count, whether the transcript was already reviewed (documentPageId set), and the invite URL while the link is still live. Check this before inviting someone again — interview fatigue is real — and to answer 'who have we already asked?'. Read one in full with compass_interviews_get.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_interviews_revoke

Kills an interview's invite link — the guest's next visit sees that the link is no longer active. Use when an invite went to the wrong person, the user changed their mind, or the link leaked. Idempotent. Ids come from compass_interviews_list. May return `needs_confirmation`.

destructive

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
interviewId*	string	Interview id (from compass_interviews_list).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "interviewId"
  ],
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "interviewId": {
      "type": "string",
      "description": "Interview id (from compass_interviews_list)."
    }
  }
}

compass_links_create

Creates a typed, directed edge between two pages — the knowledge graph's connective tissue. Canonical directions: PERSON or ROLE owns WORKFLOW/SYSTEM/PRIORITY, PERSON or ROLE involved_in WORKFLOW, PERSON holds ROLE, WORKFLOW uses SYSTEM, SYSTEM uses SYSTEM, PAIN_POINT affects WORKFLOW/SYSTEM/PERSON/ROLE, DOCUMENT documents anything, PRIORITY contributes_to PRIORITY (a priority that ladders up to a bigger one; each ladders up to at most one, and choosing a new one moves it; a priority has one owner the same way), UNIT part_of UNIT and ROLE or PERSON part_of UNIT (the org chart: one parent each; a UNIT's lead owns it, one owner), relates_to as fallback. Prefer attaching responsibilities to the ROLE and linking the PERSON to it with holds — the role outlasts whoever is in it. Pass validFrom / validTo when the source says when it was true ('took over approvals in March'), and sourceKind + sourceId for who said so (the interview or page you learned it from). Idempotent on an open (from, to, kind) edge — re-creating one returns it. May return `needs_confirmation`; tell the user what you're proposing, wait for their approval, then re-call with the approvalId.

Argument	Type	Description
kind*	string	Edge type, in canonical direction.
note	string	≤500-char qualifier when the kind alone undersells it.
source	string	Provenance label. Defaults AI_ACCEPTED (agent writing under live human direction); pass USER for human-driven scripts.
validTo	any	When it stopped being true (YYYY-MM-DD). Only for a relationship that has already ended — recording history.
sourceId

compass_links_delete

Deletes one edge from the graph (the pages stay). Use only when a connection was never true — the system isn't used by that workflow, it was recorded by mistake. When a relationship WAS true and has stopped (the person left the team, moved roles), end it with compass_links_update `validTo` instead, so the history stays. Link ids come from compass_page_links_list. Re-creating the same edge later revives it. May return `needs_confirmation`.

destructive

Argument	Type	Description
linkId*	string	Id of the link (from compass_page_links_list).
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "linkId"
  ],
  "properties": {
    "linkId": {
      "type": "string",
      "description": "Id of the link (from compass_page_links_list)."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    }
  }
}

compass_links_update

Edits an existing edge between two pages: its `kind` (how the two relate), its `note`, and/or when it was true (`validFrom` / `validTo`). Use kind to CORRECT a connection typed wrongly — 'Dana doesn't own billing, she's involved in it'. Use validTo to END one that used to be true — 'Dana handed approvals to Sam in March' ends Dana's edge in March (then create Sam's from March); the old edge stays as history. Don't delete a relationship that ended; end it. Link ids come from compass_page_links_list. Fails with conflict when the new reading already exists between the same two pages (delete this one instead). May return `needs_confirmation`.

destructive

Argument	Type	Description
kind	string	New edge type, in canonical direction.
note	string	New qualifier note (≤500 chars); empty string clears it.
linkId*	string	Id of the link (from compass_page_links_list).
validTo	any	When it stopped being true (YYYY-MM-DD) — ends the relationship; null reopens it.
validFrom	any	When it started being true (YYYY-MM-DD); null clears it.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

compass_map_view

Renders the workspace's visual map to an image and returns it so you can SEE it the way the user does when they open Map: a transit-style map seen from above. Each workflow is a colored tile with a short code; people are round figures, systems are small squares with a drum, other pages are plain tiles, each named underneath. Lines along the grid join linked pages, solid between a workflow and what it touches, dashed between other pages; pages that link to each other more than to the rest gather into named regions on a pale ground plate, and pages connected to nothing sit together in a "Not connected" plate. zv1's drafts that nobody has accepted are drawn faint. Use this when the user asks about the shape of their map, where things cluster, what connects to what, or anything spatial. The text part counts the pages of each type, the links, and how many pages are unconnected, plus `mapUrl`. The image is for you to look at; do NOT put it in your reply as a markdown image (the chat can't show it). When the user should see the map, link `mapUrl` — e.g. `[Open your map](mapUrl)` — and describe what you saw.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_opportunities_accept

The review verb for the Inbox: promotes an AI-PROPOSED opportunity (from compass_opportunities_propose or the opportunity scout) into the workspace's own pipeline. compass_opportunities_set_status does NOT do this — a proposal stays in the Inbox until accepted. Optional `status` decides its lane in the same step (BACKLOG to park it, EXPERIMENTING to start it); omitted, it lands in NEW. Fails with not_proposed when the row isn't an AI proposal. Ids come from compass_inbox_list / compass_opportunities_list. May return `needs_confirmation` — name the proposal and wait.

destructive

Argument	Type	Description
status	string	Lane to place it in on accept (default NEW).
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
opportunityId*	string	The AI-proposed opportunity's id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "opportunityId"
  ],
  "properties": {
    "status": {
      "enum": [
        "NEW",
        "QUALIFYING",
        "BACKLOG",
        "EXPERIMENTING",
        "SETTLED",
        "REJECTED"
      ],
      "type": "string",
      "description": "Lane to place it in on accept (default NEW)."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "opportunityId": {
      "type": "string",
      "description": "The AI-proposed opportunity's id."
    }
  }
}

compass_opportunities_create

Record a change — a fix, a chore, a new step, or an experiment worth trying. Anchor it to a workflow page when one fits (compass_pages_list); leave unanchored otherwise. It lands in the board's first status unless you name another (compass_statuses_list). Set `experiment` only when the user wants it measured against the Ledger. May return `needs_confirmation` — summarize and wait for approval.

Argument	Type	Description
tags	array	Tags to file it under.
label*	string	≤200 chars, the change in one line.
links	array	Where the work also lives — issue, ticket, PR or doc URLs.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
experiment	boolean	Measure it against the Ledger. Default false.
statusName	string	Start in this status (a name from compass_statuses_list).
description	string

compass_opportunities_delete

Removes an opportunity from the pipeline (soft delete). For an AI proposal the user doesn't want, this is the dismiss verb; for a captured experiment that was a duplicate or a mistake, the remove verb. To conclude a real experiment without evidence, prefer compass_opportunities_set_status REJECTED — that keeps the record. Ids come from compass_opportunities_list. May return `needs_confirmation`.

destructive

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
opportunityId*	string	The change's key (e.g. ACME-12) or id, from compass_opportunities_list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "opportunityId"
  ],
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "opportunityId": {
      "type": "string",
      "description": "The change's key (e.g. ACME-12) or id, from compass_opportunities_list."
    }
  }
}

compass_opportunities_list

The workspace's changes — fixes, chores, new steps, experiments. Each carries `statusName` (the workspace's own word for where it is) and `statusCategory` (TRIAGE undecided, BACKLOG not started, ACTIVE in progress, DONE, CANCELED dropped), plus the older lane key in `status`. `experiment: true` marks a change measured against the Ledger: `ledgerEntryId` null means no expectation registered; `ledger.verdict` carries confirmed/missed after settlement. Scores (value/feasibility/risk) and a workflow anchor are optional. Filter by lane key in `status` or by workflowPageId; compass_statuses_list has the status names.

read-only

Argument	Type	Description
status	string	Filter to one lane.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
workflowPageId	string	Only opportunities anchored to this workflow page.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "status": {
      "enum": [
        "NEW",
        "QUALIFYING",
        "BACKLOG",
        "EXPERIMENTING",
        "SETTLED",
        "REJECTED"
      ],
      "type": "string",
      "description": "Filter to one lane."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "workflowPageId": {
      "type": "string",
      "description": "Only opportunities anchored to this workflow page."
    }
  }
}

compass_opportunities_mark_implemented

The measurement window's boundary: when the user says the experiment's change actually shipped / went live / rolled out, record the landing date. Readings before it are baseline; after it, evidence of effect. Recorded once — it cannot move afterward, so confirm the date. Attaches to the linked Ledger entry as evidence. May return `needs_confirmation`.

Argument	Type	Description
at	string	ISO date the change landed — omit for today.
note	string	What shipped, if worth recording.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
applyToMap	boolean	Also move the map from the landing date: who does the change's steps, and how long they take, change as the change's effects say (automate, reassign, assist, relax a check, remove). Confirm with the user first; it can't be undone.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
opportunityId*	string	The change's key (e.g. ACME-12) or id, from compass_opportunities_list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "opportunityId"
  ],
  "properties": {
    "at": {
      "type": "string",
      "description": "ISO date the change landed — omit for today."
    },
    "note": {
      "type": "string",
      "maxLength": 1000,
      "description": "What shipped, if worth recording."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "applyToMap": {
      "type": "boolean",
      "description": "Also move the map from the landing date: who does the change's steps, and how long they take, change as the change's effects say (automate, reassign, assist, relax a check, remove). Confirm with the user first; it can't be undone."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "opportunityId": {
      "type": "string",
      "description": "The change's key (e.g. ACME-12) or id, from compass_opportunities_list."
    }
  }
}

compass_opportunities_propose

File an AI-PROPOSED opportunity into the workspace's review queue — the scouting verb (the opportunity-scout routine's main move). Unlike compass_opportunities_create this needs NO approval: the proposal itself is the human gate — it lands in the Compass Inbox and the cockpit's Needs-you for accept/dismiss. Check compass_opportunities_list first so you never duplicate an idea. Anchor to a workflow page when one fits; score value/feasibility/risk 1–5.

Argument	Type	Description
label*	string	≤200 chars, the opportunity in one line.
reasoning	string	One or two sentences on why you're proposing this.
riskScore	integer
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
valueScore	integer
description*	string	What it is and why it's worth trying, grounded in the map.
workflowPageId	string	Workflow page to anchor to, when one fits.
feasibilityScore	integer

compass_opportunities_register_expectation

The honesty mechanism: write what the experiment is expected to change BEFORE evidence exists. Creates a Ledger decision entry and links it to the opportunity — never backfill an expectation to match an outcome. Bind a metric (ledger_metrics_list) + comparator + target when the expectation is measurable; readings then land on the entry as evidence automatically. One expectation per opportunity — revise by superseding in Ledger. May return `needs_confirmation`.

Argument	Type	Description
target	number	Target value, in the metric's unit (hours for time).
deadline	string	ISO date the expectation is due by.
metricId	string	Ledger metric to bind (requires target). From ledger_metrics_list.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
comparator	string
fromRollup	object	Instead of metricId: measure it off the change's workflow roll-up — a step's (nodeId) or the whole workflow's hands-on time, waiting, labor, or hard cost, per run or per month. Creates a daily-fed metric with the last 30 days rebuilt from the map's history, so the before is on record. Needs a target; comparator defaults to <=.

compass_opportunities_set_status

Move a change to one of the workspace's statuses, by name (compass_statuses_list has them — e.g. "In review"). The old lane keys (NEW / QUALIFYING / BACKLOG / EXPERIMENTING / SETTLED / REJECTED) still work and land on that lane's default status. Only changes marked as experiments follow the Ledger: when an experiment enters an In progress status with no registered expectation, offer compass_opportunities_register_expectation; when it enters Done with its Ledger entry still open, offer ledger_entries_settle. Other changes just move. May return `needs_confirmation`.

destructive

Argument	Type	Description
status	string	A lane key. Use this or `statusName`.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
statusName	string	A status name from compass_statuses_list. Use this or `status`.
opportunityId*	string	The change's key (e.g. ACME-12) or id, from compass_opportunities_list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "opportunityId"
  ],
  "properties": {
    "status": {
      "enum": [
        "NEW",
        "QUALIFYING",
        "BACKLOG",
        "EXPERIMENTING",
        "SETTLED",
        "REJECTED"
      ],
      "type": "string",
      "description": "A lane key. Use this or `statusName`."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "statusName": {
      "type": "string",
      "description": "A status name from compass_statuses_list. Use this or `status`."
    },
    "opportunityId": {
      "type": "string",
      "description": "The change's key (e.g. ACME-12) or id, from compass_opportunities_list."
    }
  }
}

compass_opportunities_update

Corrects an opportunity's content: label, description, priority, what done means, the 1–5 value / feasibility / risk scores, the owner (a PERSON page), notes, tags, workflow anchor, external link, visibility. Fields you omit are untouched; the lane is NOT here — move it with compass_opportunities_set_status. Opportunity ids come from compass_opportunities_list. May return `needs_confirmation` — say what you're changing and wait.

destructive

Argument	Type	Description
tags	array	New tag set — replaces existing tags.
label	string	New one-line label (2–200 chars).
assignee	any	The workspace member doing the work, by email or user id; null unassigns. They're notified.
doneWhen	string	What's true when it's done, that someone else could check (≤1,000 chars).
priority	any	How soon it matters; null clears it, and the map's suggestion shows again.
riskScore	integer
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

compass_page_links_list

All typed edges touching one page, both directions, each hydrated with the other endpoint's page summary. Use this to understand a subject's neighborhood before adding to it. Current connections only, unless includeEnded — then also relationships that have ended (validTo in the past), for questions like who handled this before.

read-only

Argument	Type	Description
pageId*	string	The page id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
includeEnded	boolean	Also return connections that have ended.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "pageId": {
      "type": "string",
      "description": "The page id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "includeEnded": {
      "type": "boolean",
      "description": "Also return connections that have ended."
    }
  }
}

compass_pages_create

Creates a typed page in the workspace's Compass compendium. Check `compass_pages_list` first — don't create a page for a subject the map already has; link to it instead. May return `needs_confirmation` — if so, tell the user what you're proposing, wait for their approval, then re-call with the approvalId. Only record what the human has actually told you.

Argument	Type	Description
body	string	Markdown body shaped to the type (steps for WORKFLOW, role/contact sections for PERSON, etc.).
tags	array	Optional tags.
type*	string	Page type for this subject. PERSON = a specific individual; ROLE = a job, separate from whoever holds it (people hold roles); VALUE = something the business won't sacrifice; PRIORITY = an outcome it's pushing toward; AUDIENCE = who the work is for; OFFERING = what the business delivers.
title*	string	≤80 chars, sentence case, no filler verbs.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
visibility	string

compass_pages_delete

Moves a page to the trash (soft delete — its connections and anchored opportunities go with it, and compass_pages_restore brings the whole set back). Use this to REMOVE a page you or an extraction created wrongly, or one the user says no longer belongs on the map; to fix a wrong title or body, use compass_pages_update instead. Page ids come from compass_pages_list / compass_pages_search. May return `needs_confirmation` — name the page and wait for approval.

destructive

Argument	Type	Description
pageId*	string	Id of the page to delete.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "pageId": {
      "type": "string",
      "description": "Id of the page to delete."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    }
  }
}

compass_pages_get

Fetches one Compass page by id, including its full Markdown body, header fields, and any attached Napkin sketches — view an attached sketch's actual drawing with `napkin_boards_view` (its boardId) before discussing it.

read-only

Argument	Type	Description
pageId*	string	The page id (from compass_pages_list).
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "pageId": {
      "type": "string",
      "description": "The page id (from compass_pages_list)."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_pages_list

Lists pages in the active workspace's Compass compendium. Optional `type` filter narrows to one node type (WORKFLOW, PERSON, ROLE, SYSTEM, PAIN_POINT, DOCUMENT, VALUE, PRIORITY, AUDIENCE, OFFERING). Returns summaries, 50 at a time (`limit` / `offset`, `total` and `nextOffset` in the result) — fetch one with `compass_pages_get` for the full body. When you know what you're looking for, `compass_pages_search` is the better first call.

read-only

Argument	Type	Description
type	string	Narrow to a specific page type (WORKFLOW, PERSON, ROLE, SYSTEM, PAIN_POINT, DOCUMENT, VALUE, PRIORITY, AUDIENCE, OFFERING).
limit	integer	Page size, default 50. Prefer compass_pages_search when you know what you're looking for.
offset	integer	Skip this many, for the next page.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "type": {
      "type": "string",
      "description": "Narrow to a specific page type (WORKFLOW, PERSON, ROLE, SYSTEM, PAIN_POINT, DOCUMENT, VALUE, PRIORITY, AUDIENCE, OFFERING)."
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "minimum": 1,
      "description": "Page size, default 50. Prefer compass_pages_search when you know what you're looking for."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Skip this many, for the next page."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_pages_restore

Puts a trashed page back on the map, together with exactly the connections and opportunities its delete took. Use when the user wants a deleted page back (the pageId from the earlier compass_pages_delete, or from the Compass trash). Fails with not_found when the page is already live or never existed. May return `needs_confirmation`.

Argument	Type	Description
pageId*	string	Id of the deleted page.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "pageId": {
      "type": "string",
      "description": "Id of the deleted page."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    }
  }
}

compass_pages_search

Keyword search over page titles, bodies, and tags (case-insensitive substring match), paginated. The fast way to check whether a subject already has a page before creating or linking. Returns summaries with a 300-char body snippet — fetch full text with `compass_pages_get`.

read-only

Argument	Type	Description
q*	string	Search term. Use the most distinctive word or phrase for the subject ('Zendesk', 'invoice approval') — not full sentences.
type	string	Narrow to one page type.
limit	integer	Results per page, 1-25. Default 10.
offset	integer	Pagination offset. Default 0.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "q"
  ],
  "properties": {
    "q": {
      "type": "string",
      "description": "Search term. Use the most distinctive word or phrase for the subject ('Zendesk', 'invoice approval') — not full sentences."
    },
    "type": {
      "type": "string",
      "maxLength": 40,
      "minLength": 1,
      "description": "Narrow to one page type."
    },
    "limit": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "description": "Results per page, 1-25. Default 10."
    },
    "offset": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "description": "Pagination offset. Default 0."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_pages_update

Edits an existing page's title, description, body, tags, header fields, or visibility — use this to FIX what you (or an extraction) got wrong instead of creating a duplicate. Fetch the current page with `compass_pages_get` first and preserve what the human wrote; title / body / tags replace the field wholesale, while `headerFields` MERGES over the current ones (send only the keys you're changing — 'set the owner' leaves status alone). Page ids come from compass_pages_list. May return `needs_confirmation` — tell the user what you're changing, wait for approval, then re-call with the approvalId.

destructive

Argument	Type	Description
body	string	New Markdown body — replaces the whole body.
tags	array	New tag set — replaces existing tags.
title	string	New title (≤200 chars).
pageId*	string	Id of the page to edit.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.
visibility

compass_priority_steps_find

Reads every mapped workflow against one PRIORITY (or VALUE) and proposes the steps that move it (or where the business lives the value), one marked as what holds a priority back. Proposals wait for a person to keep them on the priority's page or in the Inbox, except in workflows someone tied to it (a serves link), where they're kept at once. Steps already tied or proposed aren't proposed again, so it's safe to run as the map grows. Use it after a priority is named and workflows are mapped, or when someone asks what moves a priority.

Argument	Type	Description
pageId*	string	The PRIORITY or VALUE page id.
workspace	string	Workspace slug. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "pageId": {
      "type": "string",
      "description": "The PRIORITY or VALUE page id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Ignored for workspace API keys."
    }
  }
}

compass_process_diagram_ensure

Returns the Napkin diagram that holds a WORKFLOW page's steps, creating it when the page has none. If the page body has a ```mermaid block, it moves into the diagram verbatim (node ids kept, so changes anchored to a step still point at it) and leaves the body. Then edit the steps with napkin_diagrams_update using the returned diagramId. One diagram per workflow holds every step anyone has described — when two people describe the same process differently, add the steps to this one diagram rather than making a second. A step that is itself a workflow is a node whose meta ref is { type: 'page', id: <that workflow's page id> }. compass_pages_get returns processDiagramId when one exists. May return `needs_confirmation`.

Argument	Type	Description
pageId*	string	The WORKFLOW page id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "pageId": {
      "type": "string",
      "description": "The WORKFLOW page id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    }
  }
}

compass_role_story

One ROLE page's story: hands-on hours a month by kind of work (rote, judgment, relationship, sign-off) before its first change or Task landed and now; what landed and when; new work it took on (checks inside Tasks, Tasks it looks after, work a change added), with whether each has settled; the role's size (people × hours each, `hoursAssumed` when the hours are a full-time default) and how much of its month is documented; and the latest analysis, when someone ran one: options for where saved hours could go, each with the stage of its change (proposed = looking into, agreed, done = in place, confirmed, dropped), and skills. Saved hours in a role with under half its month documented are unproven: say so. Talk about the role, never about a person.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
rolePageId*	string	The ROLE page's id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "rolePageId"
  ],
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "rolePageId": {
      "type": "string",
      "minLength": 1,
      "description": "The ROLE page's id."
    }
  }
}

compass_roles_overview

Every role in the workspace in one row each, changed or not: hours documented against its working month, hours a month saved, saved hours by stage (looking into, agreed, in place, confirmed, not placed yet), judgment work before and now, new work, and why a role wants attention (unproven savings, saved hours nobody is placing, no documented steps, no headcount). Plus totals. Use compass_role_story for one role's detail. Talk about roles, never about people.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_scenario_changes

Changes whose effects reach a WORKFLOW's steps — or any nested workflow's — plus changes anchored to it with no effects yet, each with what it does per step. Pass their ids to compass_workflow_rollup's changeIds to project the workflow after them.

read-only

Argument	Type	Description
pageId*	string	The WORKFLOW page id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "pageId": {
      "type": "string",
      "description": "The WORKFLOW page id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_statuses_list

The statuses this workspace's changes move through, in board order — the names people use. Each sits in a group: Undecided (TRIAGE), Not started (BACKLOG), In progress (ACTIVE), Done (DONE), Dropped (CANCELED). Groups are stable across workspaces; names aren't, so use the names when talking to people and the groups when reasoning about progress. Move a change with compass_opportunities_set_status.

read-only

Argument	Type	Description
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_step_claims_list

Every claim about a WORKFLOW's steps, oldest first: the step (nodeId; null = the workflow as a whole), the role or person (subject), the relation, who says so (sourceKind + sourceLabel), when it was true (validFrom/validTo), and origin — AI_PROPOSED claims are waiting for a person to review. Claims that disagree coexist; each keeps its source.

read-only

Argument	Type	Description
nodeId	string	Narrow to one step.
pageId*	string	The WORKFLOW page id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "nodeId": {
      "type": "string",
      "description": "Narrow to one step."
    },
    "pageId": {
      "type": "string",
      "description": "The WORKFLOW page id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_step_claims_propose

Propose claims about who does what in a WORKFLOW, and what each step is done in, from what someone said. Each claim names a step (nodeId from compass_workflow_steps), a page (subjectPageId: a ROLE or PERSON, or an AUDIENCE when a customer or partner does the step; for uses a SYSTEM or DOCUMENT; for impacts a PRIORITY; for holds_to a VALUE), and a relation: owns (accountable for it), does (does the work), approves (signs off), consulted (asked for input), does_not_do (says they don't do it — an answer, not a gap), uses (the step is done in this SYSTEM, or with this DOCUMENT; a step a system runs on its own gets uses and no doer), impacts (the step moves this PRIORITY: where the priority is won or lost; pass limits: true on the one step holding it back most), holds_to (the business lives this VALUE at the step). Propose who and what in together, in one call per workflow. Claims land as proposals for a person to accept in Compass; they don't count until then, except in a conversation about the map's questions, where what the person tells you (sourceKind 'user') is kept straight away. Always say who said it: sourceKind 'interview' + the interview id, 'email_thread' + the thread id, 'prism_report' + the desk-research report id, or 'page' + the DOCUMENT or PERSON page id. Prefer the ROLE when the person speaks for their role, the PERSON when it's specific to them. Record a disagreement as its own claim rather than skipping it. When someone says a step happens that isn't in the diagram, add the step with napkin_diagrams_update first. Re-proposing an existing claim from the same source returns it.

Argument	Type	Description
claims*	array
pageId*	string	The WORKFLOW page id.
sourceId	string	The interview, email thread, Prism report or page id, for those kinds.

compass_step_measures_propose

Propose estimates from what someone said, as ranges — people know "20 minutes to an hour", not "37 minutes"; when they give one number, use it for both ends. Each item is either a `measure` or a `gate` on a step (nodeId from compass_workflow_steps): - measure.metric `working`: hands-on minutes per run (low/high). - measure.metric `waiting`: minutes the work sits idle before or inside the step — ask about this separately; it's usually most of the waste. - measure.metric `hardCost`: money that isn't anyone's time (amount, currency, per run or month). - measure.metric `frequency` with nodeId null: how often the workflow runs (low/high per day, week, month, or year); with variantId, how often that variant runs. - gate: approval, handoff, rekey (typing the same data into another system), or rework, with returnRate (0–1) when they know how often it sends work back. Pass subjectPageId (a ROLE or PERSON) when the time is one person's or role's — it prices the time through that role's rate. Always say who said it. Proposals count once someone accepts them in Compass.

Argument	Type	Description
items*	array
pageId*	string	The WORKFLOW page id.
sourceId	string	The interview, email thread, Prism report or page id, for those kinds.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
sourceKind	string

compass_step_suggestions_build

Builds a step suggestion the way Compass's Build button does: makes its change if it isn't one yet, then the thing in Workbench — a flow drafted from the step itself (who does it, its times, systems, write-up, attachments, interview notes) and its checklist; a shim named for the decision; or a task whose sentence is the steps. Use this, not workbench_flows_scaffold, whenever the work came from a step suggestion. Returns what was built and, for a flow, what the draft still needs. Fails if something's already built for it.

Argument	Type	Description
pageId*	string	The WORKFLOW page id the suggestion is on.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string
suggestionId*	string	The suggestion id, from compass_step_suggestions_list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId",
    "suggestionId"
  ],
  "properties": {
    "pageId": {
      "type": "string",
      "description": "The WORKFLOW page id the suggestion is on."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string"
    },
    "suggestionId": {
      "type": "string",
      "description": "The suggestion id, from compass_step_suggestions_list."
    }
  }
}

compass_step_suggestions_list

Your earlier read of a WORKFLOW's steps: for each suggestion, the steps it covers (nodeIds, labels), what could do them (proposal.doer: a flow and its mode, a shim, or a task), whether it does the step or helps (reach), why, and what it would take (checklist, each item met or not). state OPEN is waiting for a person; APPLIED made a change (opportunityId), and `built` is what was built for it in Workbench, if anything. Pass changeId instead of pageId to get the one suggestion a change came from. To build one, use compass_step_suggestions_build — not workbench_flows_scaffold.

read-only

Argument	Type	Description
pageId	string	The WORKFLOW page id.
changeId	string	A change (opportunity) id: the suggestion it came from.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "pageId": {
      "type": "string",
      "description": "The WORKFLOW page id."
    },
    "changeId": {
      "type": "string",
      "description": "A change (opportunity) id: the suggestion it came from."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_transformations_get

What the workflows behind a PRIORITY could become, at five levels (Assist, Automate, Re-form, Invert, Dissolve): for each, whether it fits, is already reached, or what it needs; what changes; what it does to the priority; time freed; and the change made from it, if any. Also the recommended level, or `settled` when the work is good as it is. state 'running' means a read is under way; null means none has been read (compass_transformations_read starts one).

read-only

Argument	Type	Description
workspace	string	Workspace slug. Ignored for workspace API keys.
priorityPageId*	string	The PRIORITY page id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "priorityPageId"
  ],
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Ignored for workspace API keys."
    },
    "priorityPageId": {
      "type": "string",
      "description": "The PRIORITY page id."
    }
  }
}

compass_transformations_make_change

Creates a Change from one level of a priority's transformations, with its step effects and the priority it serves, and starts drafting in Workbench up to three flows for what the level says to build (`builds`, each `drafting` until ready). Only a level that fits, once per level. May return `needs_confirmation`.

Argument	Type	Description
level*	integer	1 Assist, 2 Automate, 3 Re-form, 4 Invert, 5 Dissolve.
workspace	string	Workspace slug. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation envelope.
priorityPageId*	string	The PRIORITY page id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "priorityPageId",
    "level"
  ],
  "properties": {
    "level": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "1 Assist, 2 Automate, 3 Re-form, 4 Invert, 5 Dissolve."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation envelope."
    },
    "priorityPageId": {
      "type": "string",
      "description": "The PRIORITY page id."
    }
  }
}

compass_transformations_read

Starts reading the five levels for a PRIORITY in the background (a minute or two). Needs at least one kept step that impacts the priority. A read under way is left to finish. Check back with compass_transformations_get.

Argument	Type	Description
workspace	string	Workspace slug. Ignored for workspace API keys.
priorityPageId*	string	The PRIORITY page id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "priorityPageId"
  ],
  "properties": {
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Ignored for workspace API keys."
    },
    "priorityPageId": {
      "type": "string",
      "description": "The PRIORITY page id."
    }
  }
}

compass_transformations_respond

Records what someone told you about one level of a PRIORITY's current transformations, in their words or a faithful summary: that they already do it, what rules it out, a system that isn't ready, work still done on paper, and so on. Compass works out what it means in the background: a label for the level, facts kept on the steps they're about (every later reading of those workflows sees them), and open questions to confirm. Then it reads the priority again. Use it whenever a conversation settles something about a level, so it lands on the priority's page, not only in this chat.

Argument	Type	Description
said*	string	What's true about the level, as the person said it.
level*	integer	1 Assist, 2 Automate, 3 Re-form, 4 Invert, 5 Dissolve.
workspace	string	Workspace slug. Ignored for workspace API keys.
priorityPageId*	string	The PRIORITY page id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "priorityPageId",
    "level",
    "said"
  ],
  "properties": {
    "said": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "What's true about the level, as the person said it."
    },
    "level": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "1 Assist, 2 Automate, 3 Re-form, 4 Invert, 5 Dissolve."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Ignored for workspace API keys."
    },
    "priorityPageId": {
      "type": "string",
      "description": "The PRIORITY page id."
    }
  }
}

compass_workflow_learning

Newest first: steps added to or dropped from the diagram (and by whom), and claims about who does what or what a step takes — said, corrected (with what they replaced), withdrawn, or accepted from a proposal — each with its source. This is when we LEARNED things; when they were true is each claim's validFrom/validTo. Use it to brief someone on what changed in the picture, or to see what an interview added.

read-only

Argument	Type	Description
since	any	Only what was learned on or after this date.
pageId*	string	The WORKFLOW page id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "since": {
      "anyOf": [
        {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
        },
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      ],
      "description": "Only what was learned on or after this date."
    },
    "pageId": {
      "type": "string",
      "description": "The WORKFLOW page id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

compass_workflow_rollup

Per run and per month: hands-on minutes, waiting minutes, labor cost (hands-on time priced through each role's hourly rate), and hard costs, each as a low–high range, with every step's share and its gates (approvals, handoffs, re-keying, rework). A step that is itself a workflow uses that workflow's roll-up unless it has its own estimate. `coverage` says how many steps are timed — always say how much of the total rests on estimates before quoting it, and never present a range as one number. `unpricedRoles` are roles doing timed work with no hourly rate; their time counts and its cost doesn't. Where the waiting dwarfs the hands-on time, or a gate rarely sends anything back, is usually where the improvement is. `at` reads the estimates as of a date; `variantId` rolls up one variant.

read-only

Argument	Type	Description
at	any	How things were on this date (YYYY-MM-DD). Default today.
pageId*	string	The WORKFLOW page id.
knownAt	any	Count only what had been said by this date — the picture as we knew it then.
changeIds	array	Project the workflow as these changes would leave it (ids from compass_scenario_changes). Compare with a call without them: before vs after, what stays human, overlapping changes.
variantId	string	A variant id from compass_workflow_steps.
workspace

compass_workflow_steps

Every step in a WORKFLOW page's steps diagram, in diagram order, with its phase, whether it is itself a workflow (subWorkflowPageId), and who the map says owns, does, approves, is consulted on, or doesn't do it, and `uses`: the systems or documents it's done in. `unknown: true` means nothing that counts says who does the step or what it's done in — those are the questions worth asking in an interview. A step with `uses` and nobody on it is one a system runs; don't ask who does it. `disputed` lists roles or people with conflicting claims; ask about those rather than picking a side. `proposals` counts claims waiting for review. `variants` are named subsets of the steps ("rush job", "enterprise client"); each step lists the variants it belongs to. Returns no steps when the workflow has no diagram yet (compass_process_diagram_ensure makes one).

read-only

Argument	Type	Description
pageId*	string	The WORKFLOW page id.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "pageId": {
      "type": "string",
      "description": "The WORKFLOW page id."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

entity_tags_browse

Without a tag: every tag in use across the workspace with how many entities carry it, most-used first — the vocabulary the team already organizes by. With a tag: everything filed under it across every tool, each with its kind, id, title, and path. Use it to reuse existing labels instead of inventing near-duplicates, and to answer 'show me everything about X' when X is a label.

read-only

Argument	Type	Description
tag	string	A tag to expand into its items. Omit to list tags.
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "tag": {
      "type": "string",
      "maxLength": 40,
      "minLength": 1,
      "description": "A tag to expand into its items. Omit to list tags."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}

entity_tags_get

Returns the tags on a batch of entities of one kind — the labels galleries organize by. Ids come from the kind's list/get tool or from search_workspace. Use it before entity_tags_set so you replace the full set knowingly, and to answer 'what is this filed under'. Entities the user can't see are omitted.

read-only

Argument	Type	Description
ids*	array
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
entityKind*	string	Which kind the ids belong to.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "entityKind",
    "ids"
  ],
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "minItems": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "entityKind": {
      "enum": [
        "workbench_flow",
        "workbench_task",
        "workbench_kb",
        "compass_page",
        "compass_opportunity",
        "caliper_dataset",
        "caliper_rubric",
        "caliper_eval",
        "caliper_review",
        "caliper_spec",
        "caliper_source",
        "ledger_entry",
        "ledger_metric",
        "napkin_board",
        "napkin_deck",
        "napkin_doc",
        "napkin_sheet",
        "napkin_diagram",
        "prism_field",
        "prism_study"
      ],
      "type": "string",
      "description": "Which kind the ids belong to."
    }
  }
}

entity_tags_set

Replaces the FULL tag set on one entity (an empty list clears it). Read the current tags with entity_tags_get first and pass the merged list — this is not additive. Tags are lowercase letters, numbers, spaces, and hyphens; prefer labels already in use (entity_tags_browse) so the workspace's vocabulary stays small. The id comes from the kind's list/get tool or search_workspace.

destructive

Argument	Type	Description
tags*	array
entityId*	string
workspace	string	Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.
approvalId	string	Approval id from a prior needs_confirmation response. Omit on the first call.
entityKind*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "entityKind",
    "entityId",
    "tags"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-z0-9](?:[a-z0-9 -]*[a-z0-9])?$",
        "maxLength": 40
      },
      "maxItems": 50
    },
    "entityId": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response. Omit on the first call."
    },
    "entityKind": {
      "enum": [
        "workbench_flow",
        "workbench_task",
        "workbench_kb",
        "compass_page",
        "compass_opportunity",
        "caliper_dataset",
        "caliper_rubric",
        "caliper_eval",
        "caliper_review",
        "caliper_spec",
        "caliper_source",
        "ledger_entry",
        "ledger_metric",
        "napkin_board",
        "napkin_deck",
        "napkin_doc",
        "napkin_sheet",
        "napkin_diagram",
        "prism_field",
        "prism_study"
      ],
      "type": "string"
    }
  }
}

get_doc

Fetch the full Markdown body of a specific docs page by its slug. Use this after `search_docs` when the user needs the complete content of a page. No authentication required.

read-only

Argument	Type	Description
slug*	string	Page slug. Accepts 'compass/api', '/compass/api', or 'docs/compass/api'.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "slug"
  ],
  "properties": {
    "slug": {
      "type": "string",
      "minLength": 1,
      "description": "Page slug. Accepts 'compass/api', '/compass/api', or 'docs/compass/api'."
    }
  }
}

list_docs

Enumerate all available docs pages, optionally filtered by product (e.g. 'compass', 'legal', 'overview'). Use this to discover what slugs exist before calling `get_doc`. No authentication required.

read-only

Argument	Type	Description
product	string	Optional product slug filter (e.g. 'compass', 'legal', 'overview').

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "product": {
      "type": "string",
      "description": "Optional product slug filter (e.g. 'compass', 'legal', 'overview')."
    }
  }
}

search_docs

Search ZeroWidth product documentation. Returns matching pages with title, slug, public URL, and a query-relevant snippet. Use this when the user asks about a ZeroWidth product (Compass, Workbench, Caliper, Prism, Ledger, Napkin, the assistant), an API behavior, or a policy. No authentication required — the docs corpus is public.

read-only

Argument	Type	Description
limit	integer	Max number of results. Defaults to 10.
query*	string	Search query — keywords or natural-language phrase.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "query"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 10,
      "maximum": 20,
      "description": "Max number of results. Defaults to 10.",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "minLength": 1,
      "description": "Search query — keywords or natural-language phrase."
    }
  }
}

search_workspace

Finds anything in the workspace in one call — uploaded files (searching the text inside them), folders, Workbench flows, shims, knowledge bases and tasks, Compass pages and changes, Caliper datasets, evals, rubrics, reviews, specs and sources, Ledger entries, Napkin sketches, decks, docs, sheets, diagrams and interfaces. The same search the person uses in Home. Use it FIRST whenever the user mentions something without saying where it lives ('the SOW', 'the dispatch interviews', 'that invoice'). The query is words in any order: each word must appear in the thing's name, its tags, the names of the folders it's filed under, or the text inside it — so 'northwind sow' finds the SOW filed in the Northwind folder, and 'dispatch interview' finds 'Dispatcher interview 1.md'. Results are ranked best first. Each hit carries its id, kind, path (for a link), folderPath (where it's filed, top-down), tags, and a snippet when the words were found inside it rather than in its name — say where a thing lives using folderPath. A file's id feeds workspace_files_read; other ids feed the kind's *_get tool. Pass folderId to search only inside one folder and everything under it. If nothing comes back, try fewer or different words before telling the user it doesn't exist. Results only include what the user can see, and only kinds this token may read.

read-only

Argument	Type	Description
q*	string	Words, any order, case-insensitive. Fewer words find more.
kinds	array	Restrict to these kinds (file, folder, flow, page, doc, dataset, …). Omit to search everything.
limit	integer
folderId	string

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "interviewId",
    "email",
    "subject",
    "message"
  ],
  "properties": {
    "email": {
      "type": "string",
      "description": "The interviewee's email address."
    },
    "message": {
      "type": "string",
      "description": "The body, written in the requesting user's voice. Greeting + link + signature are added automatically — write only the middle."
    },
    "subject": {
      "type": "string",
      "description": "Email subject, e.g. '15 minutes on how refunds actually work?'"
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "interviewId": {
      "type": "string",
      "description": "Interview id from compass_interviews_create."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "fromPageId",
    "toPageId",
    "kind"
  ],
  "properties": {
    "kind": {
      "enum": [
        "owns",
        "involved_in",
        "holds",
        "uses",
        "serves",
        "delivers",
        "affects",
        "documents",
        "relates_to",
        "contributes_to",
        "part_of"
      ],
      "type": "string",
      "description": "Edge type, in canonical direction."
    },
    "note": {
      "type": "string",
      "description": "≤500-char qualifier when the kind alone undersells it."
    },
    "source": {
      "enum": [
        "USER",
        "AI_ACCEPTED"
      ],
      "type": "string",
      "description": "Provenance label. Defaults AI_ACCEPTED (agent writing under live human direction); pass USER for human-driven scripts."
    },
    "validTo": {
      "anyOf": [
        {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
        },
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      ],
      "description": "When it stopped being true (YYYY-MM-DD). Only for a relationship that has already ended — recording history."
    },
    "sourceId": {
      "type": "string",
      "description": "Id of the interview, email thread, Prism report or page named by sourceKind."
    },
    "toPageId": {
      "type": "string",
      "description": "Edge target page id."
    },
    "validFrom": {
      "anyOf": [
        {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
        },
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      ],
      "description": "When the relationship started being true (YYYY-MM-DD). Omit when unknown."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "fromPageId": {
      "type": "string",
      "description": "Edge source page id."
    },
    "sourceKind": {
      "enum": [
        "interview",
        "page",
        "user",
        "email_thread",
        "prism_report"
      ],
      "type": "string",
      "description": "Who says this is true: an interview, an email thread, a Prism desk-research report (prism_report), a page (a DOCUMENT, or the PERSON who told you), or the user."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "linkId"
  ],
  "properties": {
    "kind": {
      "enum": [
        "owns",
        "involved_in",
        "holds",
        "uses",
        "serves",
        "delivers",
        "affects",
        "documents",
        "relates_to",
        "contributes_to",
        "part_of"
      ],
      "type": "string",
      "description": "New edge type, in canonical direction."
    },
    "note": {
      "type": "string",
      "maxLength": 500,
      "description": "New qualifier note (≤500 chars); empty string clears it."
    },
    "linkId": {
      "type": "string",
      "description": "Id of the link (from compass_page_links_list)."
    },
    "validTo": {
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "string",
              "format": "date",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
            },
            {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "When it stopped being true (YYYY-MM-DD) — ends the relationship; null reopens it."
    },
    "validFrom": {
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "string",
              "format": "date",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
            },
            {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "description": "When it started being true (YYYY-MM-DD); null clears it."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "opportunityId",
    "expectation"
  ],
  "properties": {
    "target": {
      "type": "number",
      "description": "Target value, in the metric's unit (hours for time)."
    },
    "deadline": {
      "type": "string",
      "description": "ISO date the expectation is due by."
    },
    "metricId": {
      "type": "string",
      "description": "Ledger metric to bind (requires target). From ledger_metrics_list."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "comparator": {
      "enum": [
        ">=",
        "<=",
        ">",
        "<",
        "="
      ],
      "type": "string"
    },
    "fromRollup": {
      "type": "object",
      "required": [
        "field"
      ],
      "properties": {
        "bound": {
          "enum": [
            "low",
            "high",
            "mid"
          ],
          "type": "string",
          "default": "mid"
        },
        "field": {
          "enum": [
            "working",
            "waiting",
            "labor",
            "hardCost"
          ],
          "type": "string"
        },
        "scope": {
          "enum": [
            "perRun",
            "perMonth"
          ],
          "type": "string",
          "default": "perRun"
        },
        "nodeId": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "currency": {
          "type": "string",
          "pattern": "^[A-Z]{3}$"
        },
        "variantId": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1
        }
      },
      "description": "Instead of metricId: measure it off the change's workflow roll-up — a step's (nodeId) or the whole workflow's hands-on time, waiting, labor, or hard cost, per run or per month. Creates a daily-fed metric with the last 30 days rebuilt from the map's history, so the before is on record. Needs a target; comparator defaults to <=."
    },
    "expectation": {
      "type": "string",
      "description": "One sentence — what we expect this to change."
    },
    "opportunityId": {
      "type": "string",
      "description": "The change's key (e.g. ACME-12) or id, from compass_opportunities_list."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "opportunityId"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "New tag set — replaces existing tags."
    },
    "label": {
      "type": "string",
      "description": "New one-line label (2–200 chars)."
    },
    "assignee": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "The workspace member doing the work, by email or user id; null unassigns. They're notified."
    },
    "doneWhen": {
      "type": "string",
      "description": "What's true when it's done, that someone else could check (≤1,000 chars)."
    },
    "priority": {
      "anyOf": [
        {
          "enum": [
            "URGENT",
            "HIGH",
            "MEDIUM",
            "LOW"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "How soon it matters; null clears it, and the map's suggestion shows again."
    },
    "riskScore": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "approvalId": {
      "type": "string",
      "description": "Approval id from a prior needs_confirmation response, after the user has approved. Omit on the first call."
    },
    "experiment": {
      "type": "boolean",
      "description": "Measure it against the Ledger (expectation when it starts, verdict when it's done)."
    },
    "valueScore": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1
    },
    "visibility": {
      "enum": [
        "PRIVATE",
        "WORKSPACE",
        "SHARED"
      ],
      "type": "string",
      "description": "Who can see it: PRIVATE (only the user), WORKSPACE (every member, the default), or SHARED (specific people, granted afterwards). Say 'make it private' → PRIVATE."
    },
    "description": {
      "type": "string",
      "description": "New description (≤5,000 chars)."
    },
    "externalUrl": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Where the doing happens off-platform (URL); null clears."
    },
    "ownerPageId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "PERSON page id who owns the work; null clears."
    },
    "opportunityId": {
      "type": "string",
      "description": "The change's key (e.g. ACME-12) or id, from compass_opportunities_list."
    },
    "workflowPageId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Workflow page to anchor to; null un-anchors."
    },
    "feasibilityScore": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1
    },
    "qualitativeNotes": {
      "type": "string",
      "description": "Free-form notes (≤20,000 chars) — replaces the current notes."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId",
    "claims"
  ],
  "properties": {
    "claims": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "nodeId",
          "subjectPageId",
          "relation"
        ],
        "properties": {
          "note": {
            "type": "string",
            "maxLength": 500,
            "description": "Their words, briefly, when they qualify it."
          },
          "limits": {
            "type": "boolean",
            "description": "For impacts: this step holds the priority back most right now."
          },
          "nodeId": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The step's node id; null = the workflow as a whole."
          },
          "validTo": {
            "anyOf": [
              {
                "type": "string",
                "format": "date",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
              },
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              }
            ],
            "description": "When this stopped, if it has."
          },
          "relation": {
            "anyOf": [
              {
                "enum": [
                  "owns",
                  "does",
                  "approves",
                  "consulted",
                  "does_not_do"
                ],
                "type": "string"
              },
              {
                "enum": [
                  "uses",
                  "impacts",
                  "holds_to"
                ],
                "type": "string"
              }
            ]
          },
          "validFrom": {
            "anyOf": [
              {
                "type": "string",
                "format": "date",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
              },
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              }
            ],
            "description": "When this started, if they said."
          },
          "variantId": {
            "type": "string",
            "description": "Only for this variant (an id from compass_workflow_steps), e.g. who does it on rush jobs."
          },
          "subjectPageId": {
            "type": "string",
            "description": "The ROLE, PERSON or AUDIENCE page id; for uses, the SYSTEM or DOCUMENT page id; for impacts, the PRIORITY page id; for holds_to, the VALUE page id."
          }
        }
      },
      "maxItems": 50,
      "minItems": 1
    },
    "pageId": {
      "type": "string",
      "description": "The WORKFLOW page id."
    },
    "sourceId": {
      "type": "string",
      "description": "The interview, email thread, Prism report or page id, for those kinds."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "sourceKind": {
      "enum": [
        "interview",
        "page",
        "user",
        "email_thread",
        "prism_report"
      ],
      "type": "string",
      "description": "Who says so: 'interview', 'email_thread', 'prism_report', 'page', or 'user' (the person you're talking with)."
    }
  }
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId",
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "nodeId"
        ],
        "properties": {
          "gate": {
            "type": "object",
            "required": [
              "gate"
            ],
            "properties": {
              "gate": {
                "enum": [
                  "approval",
                  "handoff",
                  "rekey",
                  "rework"
                ],
                "type": "string"
              },
              "returnRate": {
                "type": "number",
                "maximum": 1,
                "minimum": 0
              }
            }
          },
          "note": {
            "type": "string",
            "maxLength": 500,
            "description": "Their words, briefly."
          },
          "nature": {
            "enum": [
              "rote",
              "judgment",
              "relationship",
              "wait",
              "gate"
            ],
            "type": "string",
            "description": "What kind of work the step is: rote (a machine could do it), judgment (needs a person; AI can draft or check), relationship (people talking to people), wait (work sitting with someone else), gate (an approval or check)."
          },
          "nodeId": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "The step's node id; null = the workflow as a whole."
          },
          "measure": {
            "oneOf": [
              {
                "type": "object",
                "required": [
                  "metric",
                  "low",
                  "high"
                ],
                "properties": {
                  "low": {
                    "type": "number",
                    "maximum": 1000000,
                    "minimum": 0
                  },
                  "high": {
                    "type": "number",
                    "maximum": 1000000,
                    "minimum": 0
                  },
                  "metric": {
                    "type": "string",
                    "const": "working"
                  }
                }
              },
              {
                "type": "object",
                "required": [
                  "metric",
                  "low",
                  "high"
                ],
                "properties": {
                  "low": {
                    "type": "number",
                    "maximum": 1000000,
                    "minimum": 0
                  },
                  "high": {
                    "type": "number",
                    "maximum": 1000000,
                    "minimum": 0
                  },
                  "metric": {
                    "type": "string",
                    "const": "waiting"
                  }
                }
              },
              {
                "type": "object",
                "required": [
                  "metric",
                  "low",
                  "high",
                  "per"
                ],
                "properties": {
                  "low": {
                    "type": "number",
                    "maximum": 1000000,
                    "exclusiveMinimum": 0
                  },
                  "per": {
                    "enum": [
                      "day",
                      "week",
                      "month",
                      "year"
                    ],
                    "type": "string"
                  },
                  "high": {
                    "type": "number",
                    "maximum": 1000000,
                    "exclusiveMinimum": 0
                  },
                  "metric": {
                    "type": "string",
                    "const": "frequency"
                  }
                }
              },
              {
                "type": "object",
                "required": [
                  "metric",
                  "amount",
                  "currency",
                  "per"
                ],
                "properties": {
                  "per": {
                    "enum": [
                      "run",
                      "month"
                    ],
                    "type": "string"
                  },
                  "amount": {
                    "type": "number",
                    "maximum": 1000000000,
                    "minimum": 0
                  },
                  "metric": {
                    "type": "string",
                    "const": "hardCost"
                  },
                  "currency": {
                    "type": "string",
                    "pattern": "^[A-Z]{3}$"
                  }
                }
              }
            ]
          },
          "validTo": {
            "anyOf": [
              {
                "type": "string",
                "format": "date",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
              },
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              }
            ]
          },
          "validFrom": {
            "anyOf": [
              {
                "type": "string",
                "format": "date",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
              },
              {
                "type": "string",
                "format": "date-time",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              }
            ]
          },
          "variantId": {
            "type": "string"
          },
          "subjectPageId": {
            "type": "string"
          }
        }
      },
      "maxItems": 50,
      "minItems": 1
    },
    "pageId": {
      "type": "string",
      "description": "The WORKFLOW page id."
    },
    "sourceId": {
      "type": "string",
      "description": "The interview, email thread, Prism report or page id, for those kinds."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    },
    "sourceKind": {
      "enum": [
        "interview",
        "page",
        "user",
        "email_thread",
        "prism_report"
      ],
      "type": "string"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "pageId"
  ],
  "properties": {
    "at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
        },
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      ],
      "description": "How things were on this date (YYYY-MM-DD). Default today."
    },
    "pageId": {
      "type": "string",
      "description": "The WORKFLOW page id."
    },
    "knownAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
        },
        {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      ],
      "description": "Count only what had been said by this date — the picture as we knew it then."
    },
    "changeIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 50,
      "description": "Project the workflow as these changes would leave it (ids from compass_scenario_changes). Compare with a call without them: before vs after, what stays human, overlapping changes."
    },
    "variantId": {
      "type": "string",
      "description": "A variant id from compass_workflow_steps."
    },
    "workspace": {
      "type": "string",
      "description": "Workspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys."
    }
  }
}