aap_sync_project

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

Annotations indicate readOnlyHint=false and destructiveHint=false, and the description does not contradict these. The description adds some behavioral context by clarifying it is a 'git pull' and that it returns a 'project_update_id for status tracking.' However, it does not disclose potential side effects, whether the sync is asynchronous, or any error conditions.

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 well-structured with a purpose line, an Args section, and a Returns section. It is concise and avoids extraneous information. Each sentence serves a purpose, making it easy to scan.

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 simple one-parameter tool with an output schema, the description is reasonably complete: it explains what the tool does, the input, and the return value. However, it omits potential prerequisites (e.g., the project must exist and have SCM configured) and does not point to the related status-checking tool. Overall, it is adequate but not richly contextual.

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 schema description coverage is 0%, so the description bears the burden of explaining parameters. It only restates 'project_id (int): Project ID to sync,' which adds no meaning beyond the schema's own description. It does not explain where to find the project ID, any required setup, or how the integer relates to project selection.

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's purpose: 'Trigger an SCM sync (git pull) for an AAP project.' This is a specific verb+resource combination. It does not explicitly differentiate from sibling tools, but there is no other tool that directly performs a project sync, so the purpose is unambiguous.

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 provides no guidance on when to use this tool versus alternatives. It does not mention the related sibling tool 'aap_get_project_sync_status' for checking sync status, nor does it state any prerequisites or exclusions. The usage context is implied solely by the tool's function.

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