Skip to main content
Glama
Jamie-BitFlight

git-project-xray-mcp

what_breaks

Find code references that may break when changing a function or class symbol. Use with the symbol object from find_symbol to assess impact.

Instructions

💥 STEP 3: See what code might break if you change this symbol.

USE THIS AFTER find_symbol() to understand the impact of changing a function/class. Shows you every place in the codebase where this symbol name appears.

INPUT:

  • exact_symbol: Pass THE ENTIRE SYMBOL OBJECT from find_symbol(), not just the name! Must be a dictionary with AT LEAST 'name' and 'path' keys.

EXAMPLE INPUT:

First, get a symbol from find_symbol():

symbols = find_symbol("/Users/john/project", "authenticate") symbol = symbols[0] # Pick the first result

Then pass THE WHOLE SYMBOL OBJECT:

what_breaks(symbol)

or directly:

what_breaks({ "name": "authenticate_user", "type": "function", "path": "/Users/john/project/src/auth.py", "start_line": 45, "end_line": 67 })

EXAMPLE OUTPUT: { "references": [ { "file": "/Users/john/project/src/api.py", "line": 23, "text": " user = authenticate_user(username, password)" }, { "file": "/Users/john/project/tests/test_auth.py", "line": 45, "text": "def test_authenticate_user():" } ], "total_count": 2, "note": "Found 2 potential references based on a text search for the name 'authenticate_user'. This may include comments, strings, or other unrelated symbols." }

⚠️ IMPORTANT: This does a text search for the name, so it might find:

  • Actual function calls (what you want!)

  • Comments mentioning the function

  • Other functions/variables with the same name

  • Strings containing the name

Review each reference to determine if it's actually affected.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
exact_symbolYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

No annotations provided, so description fully discloses behavioral traits: it performs a text search for the name, lists potential false positives (comments, same names, strings), and notes it is not a dependency analysis. The 'IMPORTANT' section clearly warns about limitations.

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?

Description is structured with clear sections (INPUT, EXAMPLE INPUT, EXAMPLE OUTPUT, IMPORTANT) and front-loaded with purpose. While thorough, it is somewhat verbose (approx. 300 words) and could be slightly trimmed without losing clarity.

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?

Covers purpose, usage flow, input format, output structure with real example, and limitations. Despite lack of annotations and formal output schema, the example output and notes make the tool's behavior fully understandable for an agent.

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 coverage is 0% (only provides type: object with additionalProperties). Description compensates fully by specifying that the object must have at least 'name' and 'path' keys, and provides a concrete example with all relevant fields. This adds significant 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?

Description starts with 'See what code might break if you change this symbol' and explicitly states it shows every place the symbol name appears. Clearly distinguishes from siblings find_symbol (which finds symbols) and explore_repo.

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?

Directly instructs 'USE THIS AFTER find_symbol()' and provides step context 'STEP 3'. Includes detailed example of chaining with find_symbol and explicit input requirements.

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/Jamie-BitFlight/git-project-xray-mcp'

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