Skip to main content
Glama

write_bugfix_summary

Capture bug fixes by documenting root cause, solution, and lesson learned. Creates a time-stamped Markdown file, indexes it in the vector store, and pushes to git for future retrieval.

Instructions

Create a bugfix summary .md file, index it immediately, and auto-push to git.

    MANDATORY after every bug fix — these summaries are retrieved during
    future debugging sessions to avoid repeating the same mistakes.

    Side effects: creates bugfix-log/YYYY-MM-DD-{slug}.md in the knowledge
    repo docs path, indexes it into the vector store, and pushes to the
    remote git repo if MCP_GIT_REPO_URL is configured. Overwrites an
    existing file if the same title is used on the same day.

    Use write_architecture_doc() for design decisions,
    write_best_practice() for recurring patterns.

    Args:
        title: Short, descriptive title of the bug (used in filename)
        root_cause: What was the actual cause? (be technical)
        solution: How was it fixed? (describe code changes made)
        lesson_learned: What should be done differently next time?
        affected_files: Comma-separated list of changed files (optional)
        tags: Comma-separated categories, e.g. "auth,race-condition,critical" (optional)
        project: Target project name (optional)

    Returns:
        Saved filename, chunk count, and whether auto-push succeeded.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYes
root_causeYes
solutionYes
lesson_learnedYes
affected_filesNo
tagsNo
projectNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

With no annotations, the description fully discloses side effects: file creation, vector index, git push (conditional on MCP_GIT_REPO_URL), and overwrite behavior. This covers behavioral traits comprehensively.

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?

The description is well-structured with a summary sentence, side effects, usage guidance, parameter list, and return value. It is slightly verbose but every sentence adds value. Loses a point for minor redundancy in the parameter list being a bit lengthy.

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

Completeness5/5

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

Given the tool's complexity (multiple side effects, 7 parameters, output schema), the description covers all necessary context: behavior, prerequisites, parameters, return format, and usage rules. No gaps remain.

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

Parameters5/5

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

Schema has zero descriptions, but the 'Args' block in the description provides clear, actionable explanations for all 7 parameters, including required fields and optional ones like affected_files, tags, and project. This adds critical meaning beyond the schema.

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

Purpose5/5

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

The description opens with a clear verb+resource: 'Create a bugfix summary .md file, index it immediately, and auto-push to git.' It explicitly distinguishes from sibling tools by naming write_architecture_doc and write_best_practice as alternatives for different purposes.

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

Usage Guidelines5/5

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

The description states 'MANDATORY after every bug fix' and explains the retrieval benefit for future debugging. It provides explicit when-to-use guidance and references alternative tools for other scenarios. The overwrite behavior is also noted.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/dl4rce/flaiwheel'

If you have feedback or need assistance with the MCP directory API, please join our Discord server