get_mapping_guide
The upload contract for a company: parts of the business -> primitives (key, label, layer, description) -> parameters (key, type, unit, options), connection and flow types, and instructions for describing what you find. Needs a key.
Needs a keyMCP tool
Parameters
- workspacestringrequired
Workspace slug
min 1 charmax 80 chars - companystringoptional
Company slug; defaults to the workspace's own company
min 1 charmax 80 chars
Example call
Agents call tools by name; you rarely write this by hand. It is here so you can test the server from a shell or your own code.
{
"name": "get_mapping_guide",
"arguments": {
"workspace": "acme-builders"
}
}Response
The result is one text content block holding this JSON (abbreviated here). Errors come back with isError: true and a message such as Error 401: … or Invalid input: ….
Response
{
"company": {
"slug": "client",
"name": "Acme Builders",
"industry": {
"key": "construction",
"name": "Construction"
}
},
"layers": [
"people",
"process",
"software",
"data",
"decisions"
],
"parts": [
{
"key": "winning_work",
"label": "Winning work",
"primitives": [
{
"key": "estimating",
"label": "Estimating",
"layer": "process"
}
]
}
],
"flowTypes": [
"money",
"information",
"material",
"work",
"energy",
"control"
],
"limits": {
"itemsPerCall": 200,
"callsPerMinute": 30
},
"instructions": [
"Describe what exists, one component per real thing…"
]
}Over REST
The same call without MCP: GET/api/v1/workspaces/:slug/mapping-guide