Skip to main content
Glama

Generate fix patches

generate_fix_patch

Create concrete before/after documentation patches to fix issues found in a docs audit for a local checkout or public GitHub repo.

Instructions

Propose concrete before/after doc patches for findings from a docs audit.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "generate_fix_patch"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoAbsolute or relative local path to a git checkout
githubNoGitHub repo as owner/repo or https://github.com/owner/repo (public repos via GitHub API)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.1/5.0
Behavior2/5

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

With no annotations, the description carries the full burden and does not say whether anything is written to disk, whether the patches are persisted or only returned, whether auth is needed for the GitHub path, or how the patches relate to apply_doc_patches. 'Propose' hints the operation is non-mutating, but that is the only behavioral signal and it is not reinforced.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with no filler; the purpose and the input context arrive immediately. It is efficient but borders on under-specified rather than merely concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, yet the description says nothing about what 'propose' returns (diff text? file list? applied changes?) or how the tool knows which audit findings to target, since no findings parameter exists. For a two-source-parameter tool that feeds a sibling apply step, these omissions leave the call flow unclear.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents the path and github parameters, and the description adds no syntax or selection guidance beyond them. Notably it does not clarify that the two source parameters are effectively alternatives (a local checkout vs a public repo via the API), which is the one thing worth saying in prose.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Propose') plus the resource ('concrete before/after doc patches') and the scope ('findings from a docs audit'). The word 'propose' implicitly separates it from the sibling apply_doc_patches, but the sibling is never named, so differentiation is inferential rather than explicit.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'for findings from a docs audit' implies this runs after an audit, which is useful context, but no explicit when-to-use, when-not-to-use, or named alternative is given. An agent must infer that apply_doc_patches is the follow-up step rather than reading it here.

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