save_doc_to_github

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

With no annotations, the description carries the full burden of behavioral disclosure. It indicates a write operation to GitHub but does not state whether it overwrites existing files, creates a commit, requires authentication, or what the response looks like. This is a significant gap for a mutation tool with zero annotation coverage.

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, concise sentence that front-loads the core action and target. It contains no fluff or redundant phrasing, making it easy to parse quickly.

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?

The tool has 5 parameters, no output schema, and no annotations. While the purpose is clear and parameters are documented, the description omits operational details such as whether the tool creates a new file or updates an existing one, any side effects, or expected return values. For a write tool without annotations, the description is too minimal to fully guide an agent on what happens when invoked.

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 100%, so the baseline is 3 and the description adds no additional parameter information beyond what is already in the schema. The description does not clarify how 'title', 'content', and 'path' interact (e.g., whether the title becomes the filename or how the path is combined), but the schema already describes each field adequately.

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 uses a specific verb ('Save') and clearly identifies the resource ('markdown content directly to a GitHub repository'). It distinguishes itself from sibling tools like save_release_notes_to_file by emphasizing 'any markdown content' rather than a specific report type, making the tool's general-purpose nature explicit.

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?

No guidance is provided about when to use this tool versus alternatives. It does not mention any conditions, prerequisites, or exclusions, nor does it reference related save_* tools that might be more appropriate for specific report types. The 'any markdown content' phrasing implicitly suggests broad usage, but there is no explicit 'when to use this' direction.

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