Skip to content

describe

DocumentsRead-only

How the document tools work: the conventions every tool follows (colour, points, rects, percent, time), the document types and their element kinds, each kind's properties (type, unit, range, values) and the actions doc_edit's do takes. With no arguments, an overview; with doc_type, that type in full; with kind, one kind.

Available at every access level, including a client that sent X-Access-Level: readonly.

Parameters

NameTypeRequiredDescription
doc_typestring one of "image", "video", "audio", "scancode", "font"noA document type to describe in full.
kindstringnoOne element kind or section to describe (box, zoom, grade…).

Example

A JSON-RPC call to POST http://localhost:21516/mcp with the bearer token, filling in the required parameters:

{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {}
}
}

See the MCP server overview for how to connect a client and where the token lives.