sync_peer

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

The description reveals it is an outbound sync via POST to a specific webhook and requires certain env vars. Since no annotations exist, the description carries the full burden. It lacks details on side effects (e.g., whether it mutates state), error handling, or idempotency, but provides more than nothing.

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 a single sentence, which is concise, but it packs many technical terms making it dense and somewhat unclear. A bit more structure (e.g., separating purpose from requirements) would improve clarity.

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 complexity of a sync operation, the absence of an output schema, and many sibling tools, the description is too brief. It omits important context such as what 'bounded' means, the role of the webhook, and how to handle failures. The description leaves significant gaps for an agent to use the tool correctly.

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 description adds minimal value beyond the schema: it mentions 'peer sync_target_user_id' which is ambiguous and does not clarify peer_id's purpose. The limit parameter is already described in the schema with default and bounds; the description only says 'Optional limit' without further detail.

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 'bounded outbound peer sync' via a POST to /sync/webhook for observations, which distinguishes it from siblings like add_peer or sync_entity_submissions. However, the jargon 'Bounded outbound' may not be immediately clear to all 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 mentions required environment variables but does not explain when to use this tool over alternatives like sync_entity_submissions or sync_issues. No explicit when-to-use or when-not-to-use guidance is provided.

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