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, uses, affects, documents, relates_to).

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.

2 min read