get_git_workflow

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

This description carries full burden since no annotations are provided. It says 'Returns', which hints at a read-only operation, but does not explicitly state that it has no side effects, does not modify anything, or what the output format looks like. There is no mention of errors, prerequisites (e.g., needing a git repo), or whether the data is static or dynamic. The lack of behavioral detail is a significant gap.

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 a single sentence plus a concise topic hint. It is front-loaded with the core purpose and contains no filler. Every word contributes to understanding the tool's function and parameter scope.

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?

This is a simple informational tool with one parameter and no output schema. The description is adequate to understand the high-level purpose, but it lacks details about return format or specific content for each topic. Given the simplicity, the bare minimum is met, but it is 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?

Schema description coverage is 0%, and the description only repeats the enum values ('topic: branches|commits|commands|hooks|all') without explaining what each topic returns or how they differ. It adds minimal meaning beyond the schema, which already lists the same enum. The parameter's purpose is vaguely implied but not adequately detailed.

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 returns branch strategy, Conventional Commits, Git hooks, and alias setup. It uses a specific verb ('Returns') and identifies the resource (Git workflow configuration). It is distinct from siblings like run_git and get_cicd_commands by focusing on workflow documentation rather than execution or CI/CD.

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 usage: when you need branch strategy, commit conventions, hooks, or aliases, use this tool. However, it does not explicitly state when not to use it or mention alternatives like run_git or get_tooling_setup. There is no exclusionary guidance, so it earns a middle score.

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