Skip to main content
Glama
commit-check

commit-check-mcp

Official
by commit-check

validate_branch_name

Validate branch naming conventions to ensure branch names follow defined patterns. Returns pass/fail status with per-check results.

Instructions

Validate branch naming conventions with commit-check. Read-only validation. Returns a structured result with overall status ('pass'/'fail') and per-check results (check name, status, value, error, suggest).

Use this when you need to verify a branch name follows configured convention rules (e.g., feature/, bugfix/). For combined message+branch+author validation, use validate_commit_context.

Parameters:

  • branch (optional): The branch name to validate. If omitted, detected from the current repo.

  • config (optional): Inline JSON config overrides.

  • repo_path (optional): Path to the git repository.

  • config_path (optional): Path to a custom commit-check TOML config file.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
branchNo
configNo
repo_pathNo
config_pathNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

Discloses read-only nature and return structure (overall status + per-check results). No annotations exist, so description covers key behavioral aspects. Could mention config handling implications but not required.

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

Conciseness5/5

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

Concise: one summary sentence, usage guidance, and parameter list. Front-loaded with purpose. No unnecessary words.

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 optional parameters, output schema existence, and sibling context, description covers usage, parameters, and return value adequately. No gaps.

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 0% description coverage; description thoroughly explains each parameter's purpose and default behavior (e.g., branch auto-detected if omitted, config as inline JSON).

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?

Clear verb 'validate' and specific resource 'branch name conventions'. Distinguishes from siblings by mentioning combined validation alternative.

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?

Explicitly states when to use (verify branch name follows conventions) and when not (use validate_commit_context for combined checks). Includes parameter behavior details.

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/commit-check/commit-check-mcp'

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