Programmatic access

Compass doesn't have a REST API. The supported way to reach it from code is the MCP server — the same endpoint that lets an LLM client search these docs. With a token that carries Compass scopes, an agent can read the map and build it: list and search pages, read a page and its connections, create pages, connect them with typed links, and kick off a stakeholder interview.

The natural fit is an agent interviewing a person and recording what it learns: list what the map already has, create pages for new subjects, and wire them together as the conversation goes.

Scopes

compass:pages:readscope

Read the map — list, search, and fetch pages and their connections.

compass:pages:writescope

Build the map — create pages, create connections, start interviews. Granted explicitly at mint time; that grant is your authorization for agent-driven map-building.

A token's role in the workspace still applies — the scope sets the ceiling, your membership sets the floor.

Tools

Read (compass:pages:read):

compass_pages_listread

List pages in the active workspace, optionally filtered to one type (WORKFLOW, PERSON, SYSTEM, PAIN_POINT, DOCUMENT).

compass_pages_searchread

Search pages by text and return the best matches.

compass_pages_getread

Fetch one page's full body.

compass_page_links_listread

List the connections into and out of a page.

Write (compass:pages:write):

compass_pages_createwrite

Create a page of a given type.

compass_links_createwrite

Connect two pages with a typed link (owns, involved_in, holds, uses, serves, delivers, affects, documents, relates_to). Pass validFrom / validTo when you know when the relationship was true.

compass_process_diagram_ensurewrite

Get the Napkin diagram that holds a workflow's steps, creating it if the workflow has none. Edit the steps with napkin_diagrams_update.

compass_workflow_stepsread

List a workflow's steps with who owns, does, approves, is consulted on, or doesn't do each one, and which steps nobody has said anything about yet.

compass_step_claims_listread

List everything said about a workflow's steps, with who said it and when it was true.

compass_workflow_rollupread

Add up what a workflow takes per run and per month — hands-on time, waiting time, labor cost through each role's hourly rate, and hard costs — as ranges, with how much of the process the estimates cover.

compass_step_measures_proposewrite

Propose time, waiting, cost, and how-often estimates for a workflow's steps, and the approvals, handoffs, re-keying, and rework where work waits. Proposals count once someone accepts them in Compass.

compass_step_suggestions_listread

List the steps of a workflow that something could do — a flow, a shim, or a task — with why, and what it would take, item by item. Accepted ones show the change they made and anything built for them.

compass_step_suggestions_buildwrite

Build what a step suggestion names: its change, then a flow drafted from the step and what it would take, a shim, or a task. Returns what was built and what the draft still needs.

compass_change_effects_setwrite

Say what a change does to a workflow's steps — eliminate, automate, assist, relax a gate, run in parallel, or reassign — then project the workflow after it with compass_workflow_rollup.

compass_workflow_learningread

What's been learned about a workflow, newest first — steps added and dropped, and who-does-what and estimates said, corrected, withdrawn, or accepted — each with its source.

compass_step_claims_proposewrite

Propose who does a workflow's steps, from an interview or a document. Proposals count once someone accepts them in Compass.

compass_interviews_createwrite

Start a stakeholder interview and get a share link to send to the person.

Reference

The page types and connection kinds these tools accept are the same ones described in the Compass model. For the request/response shape of each tool, your MCP client surfaces the tool's schema directly once the server is connected.

4 min read