Save File Content

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

The description adds 'create or update' behavior beyond the readOnlyHint=false annotation, which is useful. However, it doesn't disclose that saving will overwrite existing content or create a git commit (though the 'message' param implies a commit). The annotations already cover mutation safety, so this is adequate but not rich.

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?

A single sentence that is verb-first and directly states the purpose. No filler or redundant content; every word carries meaning.

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 straightforward write tool with full parameter documentation, the description is sufficient. It lacks explicit mention of prerequisites (e.g., repo must already exist) and whether a commit is automatically created, but these are inferable from the schema and the presence of git-related sibling tools.

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 100% description coverage, so the schema already documents all parameters. The tool description adds a small semantic cue ('create or update') but does not explain parameter relationships or defaults, which is acceptable given the high schema coverage.

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 action (save), the resource (file content), and the scope (agent's git repo). It explicitly includes create/update semantics, distinguishing it from read-oriented siblings like get_file_content and from governance/config tools.

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 gives clear context for when to use the tool: when you need to persist file content in an agent's git repo. It doesn't explicitly mention alternatives or exclusions, but the create/update phrasing makes the intended use obvious.

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