Skip to main content
Glama

ide_references

Read-only

Finds live cross-references for X++ elements by target path in the open Visual Studio, so you can locate method calls, type references, overrides, and related usages without relying on stale archives.

Instructions

Find references to an element using the live cross-reference store of the open Visual Studio (not a stale archive). Targets use cross-reference paths such as /Classes/Name, /Classes/Name/Methods/method or /Tables/Name.

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": {
      "target": "<target>"
    },
    "name": "ide_references"
  }
}

Input Schema

NameRequiredDescriptionDefault
kindNoAny
limitNo
sourceNo
targetYes

Output Schema

NameRequiredDescriptionDefault
okYes
errorNo
truncatedNo
referencesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.16.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds one genuinely useful behavioral fact: results come from the live in-memory cross-reference store rather than a cached index. It says nothing about whether results are complete, paginated, or scoped to the open solution.

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?

Two sentences, front-loaded with the action and data source, followed by the targeting syntax an agent needs before calling. No filler; the only slight redundancy is the defensive '(not a stale archive)' phrasing.

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 return values need not be described, which relieves much of the burden. However, for a four-parameter tool with zero schema descriptions, the unexplored kind enum, limit, and source leave an agent guessing, and there is no routing guidance versus sibling reference tools.

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 description coverage is 0%, so the description must carry the burden; it does compensate for the required 'target' parameter by giving concrete path formats (/Classes/Name, /Classes/Name/Methods/method, /Tables/Name). The other three parameters (kind with 11 enum values, limit, source) receive no explanation at all, leaving a substantial documented gap.

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 a specific verb and resource ('Find references to an element') and pins the data source ('live cross-reference store of the open Visual Studio'), which is concrete enough for an agent to know it queries live IDE state. It does not differentiate against plausibly overlapping siblings such as reference_references or ide_search, so it stops short of a 5.

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

Usage Guidelines2/5

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

No when-to-use or when-not guidance is given; the only disambiguation is the parenthetical '(not a stale archive)', which contrasts with a data source rather than with an alternative tool. An agent has no signal for choosing between this and the reference_* or ide_search tools.

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