POST /parameter/context
Get Parameter Context
Get page context for the parameter artifact.
Returns docs + profile identity + evaluated permissions in a single call. Superset of /docs — clients can migrate from /docs to /context incrementally.
Request Body (DocsApiRequest)
| Field | Type | Required | Description |
|---|---|---|---|
entity_id | string | No | — |
snapshot_key | string | No | — |
schema | boolean | No | If true, include MCP/tooling schema metadata (artifact, entries, resources, permission_docs, api_operations). Defaults to false for lean page-bootstrap responses. |
Response (ComposedContextResponse)
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Artifact name |
type | string | Yes | Artifact type identifier |
description | string | Yes | Human-readable description |
artifact | DocsResponse | No | Artifact tool documentation (None unless schema=true) |
entries | DocsResponse[] | No | Entry documentation list (None unless schema=true) |
resources | DocsResponse[] | No | Resource documentation list (None unless schema=true) |
permission_docs | OperationInfo[] | No | Permission function signatures for MCP/dev tooling (None unless schema=true) |
api_operations | OperationInfo[] | No | API operation documentation (None unless schema=true) |
page_metadata | DocsApiResponse | No | Page-level metadata |
prompts | OperationPrompts | No | Starter prompts keyed by operation |
profile | ProfileSummary | Yes | Caller identity from JWT |
caller_permissions | CallerPermissions | Yes | Evaluated permissions for this caller |
Last updated on