Posts (entity notes)

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

No annotations exist, so the description must disclose behavioral traits. It mentions the delete action requires confirm: true, implying destructiveness, but does not elaborate on other side effects (e.g., irreversible changes, permissions). The global entity_id detail is helpful, but more context on mutation behaviors would improve transparency.

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?

Two concise sentences: the first states purpose, the second provides usage guidance. Every word earns its place with no redundancy.

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's complexity (7 params, nested objects, no output schema), the description covers actions, required fields, and the global entity_id nuance. It omits return value details and pagination behavior for list, but the action-field mappings are adequate 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 description coverage is low (14%), so the description compensates by explaining the action parameter and mapping each action to required fields (e.g., create needs data). It also reinforces the global entity_id usage. This adds significant meaning beyond the bare schema.

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 the tool performs CRUD operations on posts (sub-notes) attached to an entity, specifying the verb and resource. It distinguishes from sibling entity tools by focusing on posts and the global entity_id concept.

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 explicitly lists the actions and required fields for each operation (e.g., list requires page, delete requires id and confirm), providing clear usage guidance. It does not explicitly state when not to use or compare to siblings, but the specificity is sufficient.

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