Get document
onfido_get_documentRetrieve a single document's metadata by id. Onfido API: GET /documents/{document_id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_id | Yes | The document id. |
onfido_get_documentRetrieve a single document's metadata by id. Onfido API: GET /documents/{document_id}.
| Name | Required | Description | Default |
|---|---|---|---|
| document_id | Yes | The document id. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already establishes that this is a safe read. The description adds that only metadata is retrieved and gives the underlying API endpoint, but says nothing about error behavior, permissions, or response shape.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, front-loaded with the operation and scope. Every phrase contributes directly to identifying and calling the tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple one-parameter getter with full schema coverage and a read-only annotation, the description is nearly complete. It could mention what metadata fields are returned, but with no output schema that is not strictly required.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the single document_id parameter is already fully documented. The description only restates that the lookup is by id and adds no format or semantic detail beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb (retrieve), resource (single document's metadata), and lookup key (by id). The singular 'document' and 'by id' clearly distinguish it from the plural list_documents sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied: call this when you have a document id and need that document's metadata. However, there is no explicit when-to-use guidance, no exclusions, and no named alternative such as list_documents.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.