sync_github_repository

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

Annotations already indicate readOnlyHint=false (write operation) and openWorldHint=false (closed world). The description adds valuable context by stating the data is stored in the knowledge graph, revealing the write target and purpose. No contradictions with annotations.

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 sentences, front-loaded with the main action, and every word contributes meaning. No filler or redundancy.

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?

The description tells what data is fetched and where it is stored, which is sufficient for a simple 2-parameter sync tool. It doesn't describe return values, but the storage side-effect implies the tool's effect rather than a rich output. Overall complete for its 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% with both parameters (owner, repo) having descriptions. The tool description adds no additional meaning beyond the schema, so it relies entirely on the schema as expected.

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 uses specific verbs 'Fetch and sync' with a clear resource ('GitHub repository's data') and enumerates data types (metadata, contributors, commits, pull requests, languages). This clearly distinguishes it from sibling analysis tools.

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 a preparatory role with 'for further analysis', making the usage context clear. However, it doesn't explicitly exclude alternatives or state when not to use it, but the context is sufficient without being verbose.

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