get_knowledge_document
Get one knowledge document belonging to this workspace.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Resource identifier returned by a previous request. |
Get one knowledge document belonging to this workspace.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Resource identifier returned by a previous request. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered. The only added behavioral context is the workspace scoping constraint ("belonging to this workspace"), which is useful but thin; nothing is said about what a miss returns.
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?
One sentence, front-loaded with the verb and resource, with zero filler. Nothing in it could be trimmed without losing information.
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?
The tool is simple and the schema and annotations are complete, but there is no output schema and the description says nothing about what a fetch returns (document body vs. metadata) or what happens when the id is unknown. For a retrieval tool that gap is the main remaining shortfall.
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 coverage is 100% for the single `id` parameter, including pattern, length bounds and a description of its provenance, so the schema carries the burden. The description contributes only the workspace-scoping qualifier, which is a marginal addition 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?
States a specific verb and resource ("Get one knowledge document") and the singular "one" implicitly separates it from list_knowledge_documents and the create/update/delete siblings. It does not name those siblings explicitly, so differentiation relies on inference from the wording.
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 only implied: an agent infers this is the tool for fetching a single document when it already has an id. There is no statement of when to prefer this over list_knowledge_documents, nor any note on error behavior for missing or out-of-workspace ids.
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.