postmd_resolve_note

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

With no annotations provided, the description carries the behavioral disclosure burden. It covers reversibility (resolved=false reopens), permission requirements, and shared-note scope. It does not fully specify what happens on non-shared notes or describe the response, but these are minor gaps for a toggle operation.

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?

Three short sentences that front-load the core operation, then add scope and auth context. Every sentence earns its place and there is no filler.

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 toggle with three required parameters and no output schema, the description provides the essential operation, undo path, applicable note type, and authentication requirement. It is nearly complete, but the undocumented docCode/noteId parameters keep it from a perfect score.

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?

Only one of three required parameters (resolved) gets any semantic explanation, and that mostly repeats the schema description. docCode and noteId are left entirely to their names, despite schema coverage being only 33%; the description does not compensate for the missing definitions.

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 names a specific action ('Mark a note as settled'), the resource ('a note'), and the key behavior (resolved=false reopens it). This clearly distinguishes it from note CRUD siblings like postmd_update_note or postmd_delete_note.

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?

It states the relevant context ('Meaningful on SHARED notes') and the permission boundary (author or document owner may set it; requires documents:write). It does not name a specific sibling to use instead, but the scope and authorization are explicit enough to guide selection.

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