memorydetective

Overview Schema Source Related Servers Discussions Admin

Find every reference to a Swift symbol

swiftFindSymbolReferences

Locates a Swift symbol's declaration in a file and uses SourceKit-LSP to find all references across the project, returning code snippets for each call site and capture.

Instructions

[mg.code] Locates the symbol's declaration in filePath, then asks SourceKit-LSP for textDocument/references. Returns every callsite + capture across the project, with a snippet of each line. Requires an IndexStoreDB at <projectRoot>/.build/index/store for cross-file references — build it with swift build -Xswiftc -index-store-path -Xswiftc <projectRoot>/.build/index/store. The result includes a needsIndex: true hint when the index is missing.

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": {
      "symbolName": "<symbolName>",
      "filePath": "<filePath>"
    },
    "name": "swiftFindSymbolReferences"
  }
}

Input Schema

Name	Required	Description
`symbolName`	Yes	Name of the Swift symbol to find references for.
`filePath`	Yes	Path to a Swift file where the symbol is declared. The LSP query needs a position; we locate it in this file via a regex pre-scan.
`projectRoot`	No	Override the project root. Default discovers the nearest Package.swift / .xcodeproj / .xcworkspace.
`includeDeclaration`	No	Include the declaration site itself in the result set.

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.7.0May 3, 2026

TDQS

A4.5/5.0

Behavior5/5

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

With no annotations, the description fully discloses the mechanism (SourceKit-LSP, regex pre-scan), the requirement for an index store, and the output behavior including the 'needsIndex' hint. It is complete and transparent.

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?

The description is front-loaded with the purpose and uses a clear structure, but it is slightly verbose with code blocks and extra detail. Still efficient for the information conveyed.

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?

Given the complexity (4 params, no output schema), the description covers the output format (snippet per line, hint) and requirements. Could be more explicit about the exact output structure, but sufficient for an agent.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3. The description adds value by explaining how filePath is used for locating the declaration and the default discovery for projectRoot, going beyond the schema descriptions.

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 it finds every reference to a Swift symbol, using the verb 'find' and resource 'Swift symbol references'. It distinguishes from sibling tools like swiftGetSymbolDefinition by focusing on all references across the project.

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?

It explains the prerequisite of an IndexStoreDB and how to build it, but does not explicitly exclude alternatives or specify when not to use it compared to sibling tools. The context is clear for typical usage.

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