syncpen_read

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

No annotations are present, so the description must cover behavioral traits. It states the tool reads content as markdown, implying a read-only, non-destructive action. However, it does not mention error handling, authentication requirements, or rate limits. For a tool with no annotations, more detail on expected behavior 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?

The description is concise, with two sentences that front-load the purpose and provide necessary context. Every sentence serves a purpose without unnecessary detail.

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 lack of an output schema and annotations, the description explains the output format (markdown) and input provenance. It is mostly complete for a simple read tool, though it could mention potential limitations (e.g., document accessibility or size) to reach 5.

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 describes documentId with 100% coverage. The description adds value by explaining the source of the ID (search or list results), which helps the agent understand how to obtain a valid input beyond the schema's basic description.

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 action (Read) and the resource (a SyncPen document's content as markdown). It also specifies how to obtain the document ID (from search or list results), distinguishing it from siblings like syncpen_create which create documents.

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 practical usage guidance by telling where to get the document ID. While it doesn't explicitly say when not to use this tool, the context is clear for a simple read operation. A brief note on alternatives (e.g., if only metadata is needed) would elevate it to 5.

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