sync_issues

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

With no annotations, the description provides substantial behavioral details: push leg sanitizes PII, creates new issues on GitHub, updates locally; pull leg retrieves issues and messages. It does not cover error handling, concurrency, or atomicity but offers a clear picture of the two legs.

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 four sentences, each earning its place: first sentence defines core function, then push leg, pull leg, and filtering support. No fluff, front-loaded with 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?

Despite 100% schema coverage, the description lacks details on return values, conflict resolution, and error handling. For a sync tool with no output schema, more completeness would be beneficial.

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%, providing a baseline of 3. The description adds meaning by clarifying that push only acts on local public issues without github_number, and that push is enabled by default. This contextualizes parameters beyond their schema 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 clearly states it is a bidirectional sync between local Neotoma and GitHub repo, specifying push and pull legs with distinct behaviors. This verb+resource definition distinguishes it from sibling issue tools like submit_issue or get_issue_status.

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 implies usage for synchronizing local and GitHub issues, detailing the default push leg and filtering options. However, it does not explicitly mention when to use alternatives (e.g., submit_issue for single issue creation) or when to avoid this tool.

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