articleDRead-onlyInspect
Single article.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| version | No |
Tool Definition Quality
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations provide basic safety (readOnlyHint=true, destructiveHint=false), but the description adds no behavioral context (e.g., error handling, response format, or side effects). Minimal transparency beyond structured fields.
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?
Extremely concise at two words, but it lacks essential information. This is under-specification, not effective conciseness.
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?
Given no output schema, zero parameter descriptions, and a trivial description, the tool definition fails to provide complete context for correct invocation.
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 parameter descriptions coverage is 0%, and the description does not explain 'id' (required) or 'version' (optional). No semantic meaning is conveyed to the agent.
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?
Description 'Single article.' is a tautology restating the name 'article'. It fails to specify the action (e.g., get, fetch, retrieve) or the resource semantics, making it indistinguishable from a bare noun.
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?
No guidance on when to use this tool versus siblings like 'articles' (plural) or 'article_files'. No context about prerequisites or alternative tools is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.