Skip to content

describe_workspace_api

MCP server · The governed passthrough

What the workspace API can do: the route families an agent may call, and for one family the exact paths, parameters and payload shapes. Generated from the API’s own schema and the parity manifest, so it describes what the routes actually accept rather than a hand-written summary that goes stale. A route the door refuses is either absent or marked not callable, with the reason. Read-only, and it reads no data of yours.

Run this first for the exact path and shape before calling a workspace route.

What it needs

ArgumentTypeRequiredDescription
familyanyNo

What it returns

The route families an agent may call, or for one named family its exact path templates, parameters and payload shapes, with any route the door would refuse marked as not callable and the reason given.

Credential

An app session token, from an authenticated app.ax1om.ai session. Call it with only an API key and you get a plain refusal saying so, rather than a confusing 401.

Network call: yes. The full credential split is on authentication.

Example call

Most readers never write the protocol themselves: the agent does, once the server is connected. Both forms are the same call.

prompt
Use the ax1om MCP server.
Call describe_workspace_api: what the workspace API can do: the route families an agent may call, and for one family the exact paths, parameters and payload shapes.

The arguments object is whatever this tool's own input schema declares. An MCP client reads that schema from the server, so it is the server that answers for the exact shape rather than this page.

Need help?Contact supportLatest changes?See the changelog
Something wrong?Check system statusComing soon