sanity_publish

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

No annotations provided. Description only adds 'Requires write token' as behavioral info. Does not disclose error handling, idempotency, or state effects beyond the move.

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: one for purpose and effect, one for auth requirement. No fluff, front-loaded key action.

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?

For a simple publish operation with one parameter, the description covers action, effect, and auth need. Missing return value info but no output schema exists to compensate. Adequate for low complexity.

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 100% for the single parameter. Description adds no further semantics to the parameter beyond what the schema already states about the 'drafts.' prefix.

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?

Clearly states the verb 'Publish' and resource 'draft document', with explicit effect 'moves from drafts.* to published'. Distinguishes from siblings like sanity_unpublish by its action.

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?

Implies usage for publishing drafts but provides no explicit when-to-use or when-not-to-use guidance. With 17 sibling tools, lacks differentiation criteria.

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