Skip to main content
Glama

Prepare Commit

prepare_commit

Analyzes modified workspace files to generate a conventional git commit message and summary for review and approval.

Instructions

Analyze modified workspace files and generate a suggested conventional git commit message and summary for approval.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "session_summary": "<session_summary>"
    },
    "name": "prepare_commit"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNo.
session_summaryYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden; 'for approval' is the only behavioral signal and it usefully implies no commit is created and nothing is staged. It does not disclose whether it requires a git repository, whether it only reads working-tree changes or also staged changes, or whether the result is persisted anywhere.

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, and the key qualifier 'for approval' lands at the end where it is readable. It is terse to the point of omitting usage routing that would have cost only a few words.

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

Completeness3/5

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

An output schema exists, so the return shape need not be described, and the core behavior is conveyed. However, the required session_summary is undocumented and the relationship to the commit-oriented siblings is left implicit, which for a two-parameter tool with a mandatory input is a real gap.

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

Parameters2/5

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

Schema coverage is 0%, so the description must compensate for both parameters and it explains neither. 'Modified workspace files' hints that path scopes the analysis, but the required session_summary parameter is completely undefined — an agent cannot tell what content it should supply or how it influences the generated message.

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 specific verbs (analyze, generate) and a specific artifact (a conventional git commit message plus summary), and the phrase 'for approval' signals it produces a proposal rather than performing the commit. It never names git_commit or commit_changes, so an agent must infer the distinction between this and the actual commit tools.

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 approval' implies this belongs in a review-before-committing workflow, but no explicit when-to-use or when-not-to-use guidance is given. There is no routing to git_commit, commit_changes, or git_diff, all of which an agent could plausibly pick instead for similar goals.

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