sync_github_repository

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

With no annotations, the description carries the full burden and does well: it discloses the multi-stage behavior, that persistence is idempotent (safe to re-run), and that contradiction discovery runs automatically on touched claims. Gaps remain on auth requirements, network/rate-limit behavior, and failure handling, so it falls short of a 5.

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?

A single front-loaded sentence with no filler; every clause (ingest, extract, persist idempotently, discover contradictions) adds signal. It is dense and slightly run-on, which keeps it just below a 5.

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 tool with no output schema and no annotations, the description covers what the operation does and its main side effects (persistence, automatic discovery). It stops short of describing the return value or what happens to pre-existing claims, but the core behavior is complete enough to invoke 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?

Schema description coverage is 100%, so the schema already documents owner, repo, branch, and runDiscovery. The description mentions extracted fields (runtimes, dependencies, ports) but adds no syntax, defaults, or constraints beyond what the schema provides, making the baseline 3 appropriate.

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 verb (ingests/syncs) and a specific resource (GitHub repository), then enumerates the pipeline stages it performs: claim extraction, idempotent SQLite persistence, and contradiction discovery. The 'GitHub repository' scope cleanly distinguishes it from sync_website, sync_document, and sync_source siblings.

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?

Usage is implied by the resource scope (use this to ingest a GitHub repo), but there is no explicit when-to-use guidance, no mention of prerequisites such as a configured GitHub connector or token, and no routing between this tool and siblings like test_github_connection or sync_sources.

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