Skip to main content
Glama

analyze_api_surface_mutation

Compare a file against its HEAD version to classify changes as breaking API changes or internal refactors, answering whether a PR is a breaking change or safe refactor.

Instructions

Compares a file against its HEAD version and classifies the change as breaking_api_change (exported function signature changed, parameter removed/added, interface field removed) or internal_refactor (only implementation body changed). Use to answer: is this PR a breaking change or a safe refactor?

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
file_pathYesPath to the changed file (absolute or relative to project_root)
project_rootYesAbsolute path to the TypeScript project root (must contain tsconfig.json)
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It explains the classification logic and what triggers each category, which is helpful. However, it does not explicitly state that the tool is read-only or specify prerequisites like a git repository or tsconfig.json, despite the schema mentioning these.

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?

The description is two sentences, front-loaded with the primary function and immediately followed by the intended use case. No filler words; every clause contributes value.

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

Completeness4/5

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

With no output schema, the description adequately communicates the possible return values by naming the two classification categories and their meanings. It also covers the main use case. It could be improved by mentioning error cases (e.g., file not under git), but for a simple analysis tool this is fairly complete.

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% (both file_path and project_root have descriptions), so the baseline is 3. The tool description adds no additional meaning beyond the schema; it merely references 'file' and 'HEAD version' without clarifying parameter usage.

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 clearly states the tool's function: comparing a file against its HEAD version and classifying the change into two specific categories. It lists concrete examples of what constitutes each category, making the tool's purpose unmistakable and distinguishing it from siblings like 'differentiate_type_impact'.

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

Usage Guidelines4/5

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

The description provides a clear usage context: 'Use to answer: is this PR a breaking change or a safe refactor?' This tells the agent when to invoke the tool. However, it does not explicitly mention alternatives or exclusions, which would push it to a 5.

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/vola-trebla/ast-impact-mapper-mcp'

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