Read a publication
get_documentRead an approved article or project as clean Markdown.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| slug | Yes |
get_documentRead an approved article or project as clean Markdown.
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| slug | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description contributes beyond that by disclosing the 'approved'-only scope (unapproved content presumably won't resolve) and that output is clean Markdown, which matters since no output schema exists.
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?
A single front-loaded sentence with no filler; the resource and output format come first and every word earns its place.
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?
It correctly conveys that no output schema means the Markdown return format must be stated, and it does so. However, for a 0%-coverage two-parameter tool it leaves the slug/kind semantics and any failure behavior (unknown slug, unapproved document) unexplained.
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 0%, so the description must compensate and does not — it never explains what a slug is, where an agent obtains one, or how the kind enum maps to 'article' vs 'project'. The schema's enum and regex give structure, but the description adds no semantic meaning for either required parameter.
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?
Names a specific verb (Read), a specific resource (approved article or project), and the return format (clean Markdown). The phrase 'article or project' clearly separates it from siblings like get_citation, get_claim, and trace_evidence, so an agent can pick it without inspecting schemas.
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?
The word 'approved' implies the tool only works on approved content, which is an implicit usage constraint, but there is no explicit when-to-use guidance or naming of alternatives such as search_site for discovery or trace_evidence for sourcing. Usage is inferable but not stated.
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.