gramax_get_article

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

There are no annotations, so the description carries the behavioral disclosure burden. It does disclose that the output is Markdown and the verb 'get' implies a non-mutating read operation. It does not discuss errors, permissions, or edge cases, but for a simple retrieval tool this is acceptable.

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?

The description is compact and free of filler. The Args list is clear and the article_id provenance hint is valuable. It could be slightly more structured, but every sentence 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?

Given an output schema exists and the input schema is simple, the description covers the necessary calling context: both required parameters and where to get article_id. It does not explicitly state when to use this over siblings, but the tool's purpose is clear enough for straightforward 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?

The schema has no parameter descriptions, so the Args section in the description is the only documentation. It adds basic meaning: catalog_id is a catalog ID and article_id is an article ID obtainable from navigation/search. This is helpful but shallow, with no format, length, or constraint details.

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?

The description clearly states a specific operation: retrieve article content in Markdown. This distinguishes it from sibling tools like gramax_get_navigation or gramax_search, which find or navigate rather than fetch full content. It could name an alternative explicitly, but the purpose is unambiguous.

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 description gives a useful usage cue: article_id should be obtained via gramax_get_navigation or gramax_search. This implies a sequence but does not explicitly explain when to choose this tool over alternatives or when not to use it. The guidance is present but mostly implicit.

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