Skip to main content
Glama

Priority — TypeScript Compiler Intelligence

Find References

find_references
Read-onlyIdempotent

Return semantic static references to one exact compiler symbol.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filesNo
limitNo
offsetNo
symbolYes
compactNo
snapshotNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsYes
queryYes
totalYes
limitsYes
schemaYes
symbolNo
analyzerYes
coverageYes
returnedYes
snapshotYes
truncatedYes
next_offsetYes
total_foundYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed23 schema fields changed
    • addedInput schema / oneOf
      Added value: +[
      +  {
      +    "required": [
      +      "files"
      +    ]
      +  },
      +  {
      +    "required": [
      +      "snapshot"
      +    ]
      +  }
      +]
    • removedInput schema / properties / compact / description
      Removed value: -"Prefer a token-efficient packet when this tool has a proven compact representation. Defaults to true for specialized agent tools; set false only when full verbose evidence fields are required."
    • removedInput schema / properties / files / description
      Removed value: -"Authorized JavaScript/TypeScript source files for this single request. Required every call — there is no server-side index."
    • removedInput schema / properties / files / items / properties / content / description
      Removed value: -"Full source text for that path. Only files included here are analyzed; the server does not read a repository from disk."
    • removedInput schema / properties / files / items / properties / path / description
      Removed value: -"Workspace-relative JS/TS path for this request (e.g. \"src/app.ts\"). No absolute paths, no \"..\" segments, no backslashes."
    • removedInput schema / properties / limit / description
      Removed value: -"Maximum number of items to return in this page (1–100). Prefer smaller pages when scanning large result sets."
    • removedInput schema / properties / offset / description
      Removed value: -"0-based pagination offset into the result items array. Use with limit and next_offset from the previous response."
    • addedInput schema / properties / snapshot
      Added value: +{
      +  "maxLength": 100,
      +  "minLength": 20,
      +  "type": "string"
      +}
    • removedInput schema / properties / symbol / description
      Removed value: -"Exact symbol name (e.g. \"addItem\") or a prior exact compiler symbol id from a symbols listing. Use the id when names collide across files."
    • changedInput schema / required
      Previous value: -[
      -  "files",
      -  "symbol"
      -]New value: +[
      +  "symbol"
      +]
    • removedOutput schema / properties / analyzer / description
      Removed value: -"Analyzer identity including TypeScript version"
    • removedOutput schema / properties / coverage / description
      Removed value: -"Coverage and completeness markers for this analysis"
    • removedOutput schema / properties / items / description
      Removed value: -"Paged compiler facts for this query"
    • removedOutput schema / properties / limits / description
      Removed value: -"Human-readable analysis boundary statements"
    • removedOutput schema / properties / next_offset / description
      Removed value: -"Offset for the next page, or null when complete"
    • removedOutput schema / properties / query / description
      Removed value: -"Query mode that produced this packet"
    • removedOutput schema / properties / returned / description
      Removed value: -"Number of items in this page"
    • removedOutput schema / properties / schema / description
      Removed value: -"Packet schema id, e.g. semantic-reader/0.1"
    • removedOutput schema / properties / snapshot / description
      Removed value: -"Hash of the supplied file set for this request"
    • removedOutput schema / properties / symbol / description
      Removed value: -"Resolved target symbol summary when applicable"
    • removedOutput schema / properties / total / description
      Removed value: -"Total matching items before pagination caps in this response path"
    • removedOutput schema / properties / total_found / description
      Removed value: -"Total found before page slice"
    • removedOutput schema / properties / truncated / description
      Removed value: -"True when result caps truncated the set (fail-closed incomplete, not absence proof)"
  2. Changed1 schema field changed
    • addedInput schema / properties / compact
      Added value: +{
      +  "default": true,
      +  "description": "Prefer a token-efficient packet when this tool has a proven compact representation. Defaults to true for specialized agent tools; set false only when full verbose evidence fields are required.",
      +  "type": "boolean"
      +}
  3. Changed8 schema fields changed
    • addedInput schema / properties / files / description
      Added value: +"Authorized JavaScript/TypeScript source files for this single request. Required every call — there is no server-side index."
    • addedInput schema / properties / files / items / properties / content / description
      Added value: +"Full source text for that path. Only files included here are analyzed; the server does not read a repository from disk."
    • addedInput schema / properties / files / items / properties / path / description
      Added value: +"Workspace-relative JS/TS path for this request (e.g. \"src/app.ts\"). No absolute paths, no \"..\" segments, no backslashes."
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of items to return in this page (1–100). Prefer smaller pages when scanning large result sets."
    • addedInput schema / properties / offset / description
      Added value: +"0-based pagination offset into the result items array. Use with limit and next_offset from the previous response."
    • addedInput schema / properties / symbol / description
      Added value: +"Exact symbol name (e.g. \"addItem\") or a prior exact compiler symbol id from a symbols listing. Use the id when names collide across files."
    • changedInput schema / required
      Previous value: -[
      -  "files"
      -]New value: +[
      +  "files",
      +  "symbol"
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": true,
      +  "properties": {
      +    "analyzer": {
      +      "description": "Analyzer identity including TypeScript version",
      +      "type": "string"
      +    },
      +    "coverage": {
      +      "additionalProperties": {},
      +      "description": "Coverage and completeness markers for this analysis",
      +      "type": "object"
      +    },
      +    "items": {
      +      "description": "Paged compiler facts for this query",
      +      "items": {
      +        "additionalProperties": {},
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "limits": {
      +      "description": "Human-readable analysis boundary statements",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "next_offset": {
      +      "description": "Offset for the next page, or null when complete",
      +      "type": [
      +        "number",
      +        "null"
      +      ]
      +    },
      +    "query": {
      +      "description": "Query mode that produced this packet",
      +      "type": "string"
      +    },
      +    "returned": {
      +      "description": "Number of items in this page",
      +      "type": "number"
      +    },
      +    "schema": {
      +      "description": "Packet schema id, e.g. semantic-reader/0.1",
      +      "type": "string"
      +    },
      +    "snapshot": {
      +      "description": "Hash of the supplied file set for this request",
      +      "type": "string"
      +    },
      +    "symbol": {
      +      "description": "Resolved target symbol summary when applicable"
      +    },
      +    "total": {
      +      "description": "Total matching items before pagination caps in this response path",
      +      "type": "number"
      +    },
      +    "total_found": {
      +      "description": "Total found before page slice",
      +      "type": "number"
      +    },
      +    "truncated": {
      +      "description": "True when result caps truncated the set (fail-closed incomplete, not absence proof)",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "schema",
      +    "analyzer",
      +    "snapshot",
      +    "query",
      +    "items",
      +    "total",
      +    "total_found",
      +    "returned",
      +    "truncated",
      +    "next_offset",
      +    "coverage",
      +    "limits"
      +  ],
      +  "type": "object"
      +}
  4. First observed

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior, lowering the burden on the description. The description adds useful behavioral context with 'semantic static' and 'one exact symbol,' but it does not explain matching behavior, result shape, or pagination implications beyond the schema.

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 sentence that opens with the action and object, contains no filler, and communicates the core distinction in a short sentence. It is optimally front-loaded for an agent scanning tool descriptions.

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?

Despite having an output schema and favorable annotations, the description omits the required input-mode choice between files and snapshot and does not explain pagination or compact output. For a six-parameter tool with zero schema descriptions, this is a significant completeness gap.

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

Parameters2/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 parameter meaning, but it only clarifies the 'symbol' parameter. The key files/snapshot one-of contract, limit, offset, and compact are left undocumented; an agent cannot learn their semantics from the description or schema descriptions.

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 names a specific verb ('return') and resource ('semantic static references to one exact compiler symbol'), so an agent immediately knows this is a reference-lookup tool. It does not explicitly contrast with sibling tools like get_definition or get_importers, but the phrasing is distinct enough to establish core purpose.

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 gives no guidance on when to choose this tool over siblings such as get_imports, get_definition, or get_symbol_context, and it does not state any exclusions. An agent must infer usage from the name and one-line description alone.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources