faf_git

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

The description discloses that it 'fetches the repo and extracts its stack and context,' which is a key behavioral trait beyond the annotations. Annotations (readOnlyHint=false, destructiveHint=false, openWorldHint=true) are consistent. No contradictions. It adds value by explaining the fetching and extraction actions.

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: first states the main action and result, second gives usage guidance. No wasted words, front-loaded with the core purpose. Excellent structure.

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?

Given the tool's simplicity (2 parameters, no output schema), the description covers the essential: what it does, how it works (fetches, extracts), and the two modes (write vs return). No missing information for an agent to use it 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?

The schema has 100% coverage, describing both parameters (url, path). The description adds meaning: 'Returns the generated .faf' and explains path behavior ('if omitted, returns content without writing'). This enhances 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's action: 'Generate a project.faf from any public GitHub repository URL' with a specific verb ('Generate') and resource ('project.faf from GitHub URL'). It distinguishes from siblings like faf_init (for local projects) by specifying external fetching.

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 explicit guidance: 'Use this to bootstrap context for a project you have the URL for but not cloned locally.' This tells when to use the tool. It could be improved by explicitly stating when not to use (e.g., private repos), but the guidance is clear and helpful.

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