get_publication_readme

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It only states that the tool retrieves a readme, but does not describe side effects, authorization requirements, rate limits, or behavior if the publication or readme does not exist.

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 short and front-loaded, but it wastes space by repeating the parameter name and type which are already in the schema. It could be more concise by integrating the parameter info or omitting it entirely.

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 the tool has one parameter and an output schema (not shown), the description lacks context about the return value (e.g., format, contents of readme), error handling, or typical usage patterns. It is insufficient for an agent to fully understand the tool's role without additional information.

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 coverage is 0%, meaning the schema has no parameter descriptions. The description merely restates the parameter name ('publication_id') and type ('Publication UUID'), adding no additional semantic information such as format examples, constraints, or how to obtain the correct ID.

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 'Get the readme for a publication' using a specific verb and resource. It distinguishes from sibling tools like update_publication_readme and delete_publication through the verb 'get'. However, it does not explain what 'cwbe' refers to, which may confuse some agents.

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 provides no guidance on when to use this tool versus alternatives (e.g., update_publication_readme). No mention of prerequisites, context (e.g., publication must exist), or when to prefer this over other read operations.

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