Sync Project

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

Annotations declare it is a non-read-only, idempotent, non-destructive, open-world write, so safety is covered. The description adds genuinely new behavioral context: 5-30s extraction latency, automatic git remote detection, and cache/force re-extraction semantics. It stops short of stating failure modes or auth/network requirements, which openWorldHint implies but does not spell out.

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?

Five tightly packed sentences, each carrying distinct information: purpose, trigger, default behavior, latency, follow-up, and force semantics. The core action is front-loaded with zero filler.

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?

With no output schema and only two optional parameters, the description supplies everything an agent needs: trigger conditions, default remote detection, expected duration, verification step, and override behavior. Nothing material is missing for correct invocation.

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%, so the baseline is 3, but the description adds meaning beyond the schema by explaining the rationale for force ('useful after code changes or when Seshat extraction has been updated') rather than merely restating the default.

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?

States a specific verb and resource ('Import a public GitHub repo into Seshat for structural analysis'), naming both the action and the target system. The scope is narrow and immediately distinguishable from read-only siblings like list_projects and query_entities.

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?

Gives explicit triggering conditions ('when list_projects returns empty or when the user wants to analyze a new repo'), a post-condition step ('call list_projects to confirm'), and the condition for re-running with force. Alternatives and follow-ups are fully covered.

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