Skip to main content
Glama

Find References

find_references

Locate all instances of a Svelte symbol across your project workspace to track usage and support refactoring tasks.

Instructions

Find all references to a symbol across the workspace.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filePathYesAbsolute path to the file
symbolNameYesName of the symbol to find
symbolKindNoKind of symbol
includeDeclarationNoInclude the declaration itself

Implementation Reference

  • The "find_references" tool registration and handler implementation.
    server.registerTool(
      "find_references",
      {
        title: "Find References",
        description: "Find all references to a symbol across the workspace.",
        inputSchema: z.object({
          filePath: z.string().describe("Absolute path to the file"),
          symbolName: z.string().describe("Name of the symbol to find"),
          symbolKind: z.string().optional().describe("Kind of symbol"),
          includeDeclaration: z
            .boolean()
            .default(true)
            .describe("Include the declaration itself"),
        }),
      },
      async ({
        filePath,
        symbolName,
        symbolKind,
        includeDeclaration,
      }): Promise<ToolResult> => {
        try {
          const prep = await prepareSymbolRequest(lsp, filePath, symbolName, symbolKind);
          if ("error" in prep) return textResult(prep.error);
    
          const params = {
            ...makePositionParams(prep.ctx),
            context: { includeDeclaration },
          };
          const result = await lsp.request("textDocument/references", params);
          return textResult(formatLocations(result, "reference"));
        } catch (ex) {
          return textResult(formatError(ex));
        }
      }
    );
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool finds references but doesn't describe what constitutes a 'reference' (e.g., usage sites, imports), whether it's read-only (implied but not explicit), performance characteristics like speed or workspace scope, or output format. This leaves significant gaps for an agent to understand its behavior.

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 a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's front-loaded with the core action, making it easy to parse quickly.

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

Completeness2/5

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

Given the complexity of a reference-finding tool with no annotations and no output schema, the description is insufficient. It doesn't explain the return values (e.g., list of locations), behavioral traits like workspace traversal, or how it interacts with sibling tools. This leaves the agent with incomplete context for effective use.

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?

The input schema has 100% description coverage, so the schema already documents all parameters thoroughly. The description adds no additional meaning beyond implying a search operation, which aligns with the schema. This meets the baseline for high schema coverage, where the description doesn't need to compensate.

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?

The description clearly states the action ('Find all references') and resource ('to a symbol across the workspace'), making the purpose unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'get_file_references' or 'get_component_references', which might have overlapping functionality.

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?

The description provides no guidance on when to use this tool versus alternatives like 'find_definition', 'get_file_references', or 'get_component_references'. It lacks context about prerequisites, such as needing a loaded project via 'load_project', or exclusions like not working on unsaved files.

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/adainrivers/SvelteLS.MCP'

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