distillery_gh_sync

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

With no annotations, the description carries the full burden of behavioral disclosure. It mentions batched processing and async operation, and notes that background mode returns a job_id. However, it omits crucial details such as whether the sync updates existing entries, creates duplicates, or requires authentication. It also lacks information on error handling or rate limits, so the behavioral picture is incomplete.

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 and well-structured: a single opening sentence states the purpose, followed by a bulleted list of parameter explanations. Each line adds value and the format is easy for an agent to parse. There is no waste 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?

While parameter semantics are well covered, the description lacks details on the return value (except in background mode), error conditions, prerequisites such as authentication tokens, and the exact semantics of the sync operation. Given the absence of an output schema and annotations, the description should provide more context about side effects and expected outcomes. It is sufficient for a basic call but not fully complete for autonomous decision-making.

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 input schema has zero descriptions (0% coverage), so the description must compensate. It does this thoroughly by explaining each parameter: url is a repository slug or full URL, author has a default, project is optional, and background enables async mode with an immediate job_id return. This fully clarifies the meaning and defaults beyond the schema.

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 syncs GitHub issues and PRs into the knowledge base using a batched pipeline. It identifies the specific verb and resource, making the purpose clear. While it doesn't explicitly differentiate from sibling tools, the 'sync' action and GitHub focus distinguish it from store, get, search, and other operations.

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 that this tool is for syncing GitHub data into the knowledge base, which gives a general sense of when to use it. However, it does not explicitly state when to prefer this over alternatives like distillery_store or distillery_ingest_doc, nor does it provide exclusions or cautionary notes. The usage context is adequate but not fully explicit.

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