ts-mcp-server

Overview Schema Source Related Servers Discussions Admin

Document Highlights

documentHighlights

Read-only

Locate all occurrences of a symbol in specified files, distinguishing read from write references for local scope analysis.

Instructions

Find all occurrences of a symbol within a file (or set of files). Distinguishes between read and write references. More efficient than find_all_references when you only need local occurrences within specific files.

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": {
      "file": "<file>",
      "line": "<line>",
      "offset": "<offset>"
    },
    "name": "documentHighlights"
  }
}

Input Schema

Name	Required	Description
`file`	Yes	File path (absolute or relative to cwd)
`line`	Yes	1-based line number
`offset`	Yes	1-based column offset
`filesToSearch`	No	Optional: limit search to these files

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.1.1Jul 12, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true, confirming no mutation. The description adds behavioral nuance by stating it distinguishes between read and write references, which is valuable beyond annotations. No side effects or destructive behavior are present, so a score of 4 is appropriate.

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 two sentences long with no fluff. Critical information (purpose, differentiation, efficiency) is front-loaded. Every sentence serves a clear purpose.

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?

Given no output schema, the description does not explain the return format (e.g., positions with read/write kind). While the purpose is clear, the absence of output details leaves the agent partially uninformed about what to expect.

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?

Input schema coverage is 100%, so the schema already documents all parameters with descriptions. The description mentions 'file (or set of files)' which aligns with the file and filesToSearch parameters, but adds no extra semantic value beyond what the schema provides.

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 the tool finds occurrences of a symbol within files, distinguishes between read and write references, and explicitly differentiates from a similar tool (find_all_references) by noting efficiency for local occurrences.

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?

The description provides explicit when-to-use guidance: 'More efficient than find_all_references when you only need local occurrences within specific files.' It also implies when not to use (avoid for broad searches) and distinguishes read/write references.

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