Outcome
Get the authenticated Docs user and organization context.
These examples were captured from the local Worker. Deployment, publication and retrieval are verified separately for each environment; local examples do not establish external provider delivery.
Before you start
-
Inspect the credential identity with topolo whoami and the exact action with topolo actions get before preparing input.
-
The published required permission is workspace:read; the active credential and resource binding must authorize the call.
Discover the target
topolo actions get app_topolo_docs.workspace.bootstrap --detail --json
topolo resources topolo-docs --json
topolo workspaces list topolo-docs --json
Input fields
Use {} as the input.
Interpret the response
user identifies the authenticated principal and organization identifies its active context, or is null for personal context. It does not select or create an application workspace.
Worked examples
The following inputs and responses were captured from the local Docs worker fixture. Auth and Nexus dependencies are simulated. Identifiers, URLs and timestamps are illustrative fixture values. Discover your own identifiers and choose an appropriate test resource; copying a fixture identifier does not make it valid in your environment. For workspace-bound calls, set DOCS_WORKSPACE_ID to the identifier returned by resource discovery. Run validation and planning first; the final call requires the intended effect to be authorized.
Minimal example
Save the input as payload.json:
{}
CLI:
topolo actions validate app_topolo_docs.workspace.bootstrap --data @payload.json --json
topolo actions plan app_topolo_docs.workspace.bootstrap --data @payload.json --json
topolo actions call app_topolo_docs.workspace.bootstrap --data @payload.json --json
MCP tool and arguments:
{
"tool": "topolo_read_action",
"arguments": {
"actionId": "app_topolo_docs.workspace.bootstrap",
"input": {}
}
}
Captured local response · HTTP 200:
{
"user": {
"id": "usr_fixture",
"email": "author@example.com",
"orgId": "org_fixture",
"orgSlug": "admin",
"role": "platform_admin",
"permissions": [
"docs:read",
"docs:write",
"docs:publish",
"docs:export",
"workspace:read",
"workspace:delete"
]
},
"organization": {
"id": "org_fixture",
"slug": "admin",
"name": "Documentation fixture"
}
}
user identifies the authenticated principal and organization identifies its active context, or is null for personal context. It does not select or create an application workspace.
Workflow example
Save the input as payload.json:
{}
CLI:
topolo actions validate app_topolo_docs.workspace.bootstrap --data @payload.json --json
topolo actions plan app_topolo_docs.workspace.bootstrap --data @payload.json --json
topolo actions call app_topolo_docs.workspace.bootstrap --data @payload.json --json
MCP tool and arguments:
{
"tool": "topolo_read_action",
"arguments": {
"actionId": "app_topolo_docs.workspace.bootstrap",
"input": {}
}
}
Captured local response · HTTP 200:
{
"user": {
"id": "usr_fixture",
"email": "author@example.com",
"orgId": "org_fixture",
"orgSlug": "admin",
"role": "platform_admin",
"permissions": [
"docs:read",
"docs:write",
"docs:publish",
"docs:export",
"workspace:read",
"workspace:delete"
]
},
"organization": {
"id": "org_fixture",
"slug": "admin",
"name": "Documentation fixture"
}
}
user identifies the authenticated principal and organization identifies its active context, or is null for personal context. It does not select or create an application workspace.
Verify the result
- Compare user.id and organization.id with the authenticated identity. A null organization is personal context, not a workspace selection.
Errors and recovery
-
HTTP 401 ·
authentication_required: Authenticate again or provide a valid Topolo API key. -
HTTP 403 ·
permission_denied: Grant the credential permission workspace:read and the required resource binding. -
HTTP 429 ·
rate_limited: Wait for Retry-After when present, then retry without parallel duplicate calls. -
HTTP 422 ·
invalid_input: Correct the payload using inputSchema, then validate before retrying. -
HTTP 503 ·
dependency_unavailable: Retry the action. If it continues, inspect the structured error details using the request ID.
This action does not change service state.
Evidence boundary
These examples establish local handler behavior and schema validity. They do not establish runtime permission parity, a deployed development/staging result or production completion. Preserve the actual request identifier and perform the verification reads after an authorized live call.