Skip to main content
Glama

workspace.document_status

Poll document ingest/index status.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace_id": "<workspace_id>",
      "document_id": "<document_id>"
    },
    "name": "workspace.document_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
document_idYes
workspace_idYesWorkspace (notebook) UUID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.4/5.0
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the entire behavioral burden, yet it says nothing about expected status values, whether the call blocks, rate limits, or what to do on failure. For a polling tool with zero annotation coverage, this leaves the agent guessing about the core loop behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single front-loaded phrase contains no filler, but at six words it tips from concise into under-specified. A sentence or two on status values and polling behavior would earn their place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no annotations and no output schema, the description is the only place to explain that this returns ingest/index state, what states exist, and when polling can stop — none of which is present. Incomplete for a tool whose whole value is the returned status.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With only 50% schema description coverage, the description should compensate but adds nothing: workspace_id is explained in the schema as a notebook UUID, while document_id is a bare string with no explanation in either place. The description never clarifies how a document_id is obtained (presumably from an upload/add-source call).

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb ('Poll') and resource ('document ingest/index status'), so an agent can tell this is a status-check operation on an ingested document. No sibling among the listed names appears to offer status polling, so the purpose is unambiguous even without explicit differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The word 'Poll' weakly implies repeated invocation until the document finishes ingesting, but there is no explicit guidance on when to call it, how often, or what to do while waiting. No alternatives (e.g. list_sources) are referenced for checking ingest state.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources