linka-teach-get-artifact

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

Discloses 'read-only' but no annotations exist. Lacks details on error behavior, rate limits, or what happens if id is invalid. Minimal safety indication.

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?

Single sentence, front-loaded with purpose, no wasted words. Efficient structure for a simple 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?

Given no output schema and no annotations, the description is too sparse. Agent lacks info on return format, error handling, or how 'artifact detail' is structured.

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?

Description adds 'by id' but schema coverage is 0% and no additional meaning (e.g., id format, source, constraints) beyond the schema's type 'string'.

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?

Clear verb 'Return', specific resource 'Teach artifact detail', and method 'by id'. Distinguishes from sibling tools like 'linka-teach-list-artifacts'.

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 vs alternatives, no exclusions or context provided. Only implies usage for retrieving a single artifact by its ID.

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