linka-teach-run-artifact-dry-run

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

No annotations provided. Description adds only that it is a dry-run (non-executing), but does not disclose side effects, permissions required, or what the plan contains. Minimal beyond implicit safe-read nature.

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, 12 words – very concise. However, excessive brevity sacrifices critical details like parameter meaning and usage context. Concise but insufficiently informative.

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 only one parameter and no output schema, description should explain what a 'Teach artifact' is and what the plan format looks like. Lacks completeness for effective agent 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 has 1 parameter 'id' with 0% description coverage. Description does not explain what 'id' refers to (e.g., artifact ID or session ID). Fails to compensate for lack of parameter documentation.

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 clearly states verb ('return') and resource ('dry-run execution plan for a Teach artifact'). Distinguishes from siblings like linka-teach-explain-artifact by specifying 'dry-run' and 'without executing it'.

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 explicit guidance on when to use this tool versus alternatives like linka-teach-explain-artifact or linka-teach-get-artifact. No when-not-to-use or prerequisite conditions mentioned.

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