Ts Def MCP

🚀 TypeScript Definition Finder MCP Server

This is a Model Context Protocol (MCP) server that helps AI code editors find the definitions of TypeScript symbols in your codebase. It's particularly useful when you need to locate the original definitions of symbols, classes, interfaces, or functions imported from external packages.

🚀 Quick Start

The TypeScript Definition Finder MCP Server is a powerful tool for quickly locating the original definitions of TypeScript symbols. Below are the steps to get started:

Prerequisites

• Bun v1.2.2 or higher
• Node.js for running the compiled server

Installation

Install via Smithery

To automatically install the TypeScript definition finder for Claude Desktop via Smithery:

npx -y @smithery/cli install @runninghare/ts-def-mcp --client claude

Manual Installation

1. Install dependencies:

bun install

2. Build the project:

bun run build

Usage

Start the stdio server:

node dist/run.js

✨ Features

• Find the original definitions of TypeScript symbols.
• Support symbols imported from external packages.
• Return the location of the definition and code snippets.
• Support the stdio interface for seamless integration with AI code editors.

📦 Installation

Install via Smithery

npx -y @smithery/cli install @runninghare/ts-def-mcp --client claude

Manual Installation

1. Install dependencies:

bun install

2. Build the project:

bun run build

💻 Usage Examples

Basic Usage

The server provides a find_typescript_definition tool with the following features:

• Tool Name: find_typescript_definition
• Trigger Command: /ts-def (In Cursor, you can force the AI editor to find the definition of the referenced symbol)
• Purpose: Locate the original definition of a symbol in a TypeScript codebase

Input Parameters

The tool requires three parameters:

1. file_path (string):

   • The absolute path of the current TypeScript file.
   • Example: /path/to/your/project/src/index.ts

2. line_content (string):

   • The entire line containing the symbol whose definition you want to find.
   • Used to locate the correct line in the file.
   • Must match the line in the file exactly.

3. column_number (number):

   • The 1-based column number where the symbol starts.
   • Must be the exact column position of the first character of the symbol.

Example

Find the Definition of an Imported Symbol

Given the following import statement:

import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";

To find the definition of StdioServerTransport, which starts at column 10, you can use:

{
  "file_path": "~/my-mcp-project/src/index.ts",
  "line_content": "import { StdioServerTransport } from \"@modelcontextprotocol/sdk/server/stdio.js\";",
  "column_number": 10
}

The output of the tool will be:

[
  {
    "file": "~/my-mcp-project/node_modules/@modelcontextprotocol/sdk/dist/esm/server/stdio.d.ts",
    "type": "Definition",
    "location": "Line 9, Column 22",
    "codeSnippet": "   8    */\n   9 > export declare class StdioServerTransport implements Transport {\n  10 +     private _transport: Transport;\n  11 +     private _buffer: Buffer;\n  12 +     private _closed: boolean;\n  13 +     constructor(transport: Transport, options?: OpenOptions);\n  14 +     connect(): Promise<void>;\n  15 +     disconnect(): void;\n  16 +     send(data: Buffer | Array<Buffer>): Promise<void>;\n  17 +     close(): void;\n  18 + }"
  }
]

Find the Definition of a Private Transport

Given the following line:

private _transport: Transport;

To find the definition of Transport, which starts at column 9, you can use:

{
  "file_path": "~/my-mcp-project/src/transports/index.ts",
  "line_content": "  private _transport: Transport;",
  "column_number": 9
}

Response Format

The tool returns a JSON response containing:

• The file path where the definition is located.
• The line number of the definition.
• The actual code snippet of the definition.

🔧 Technical Details

This project was created using bun init in bun v1.2.2. Bun is a fast, all-in-one JavaScript runtime.

Run in Development Mode

During development, you can run the server directly using Bun:

bun run index.ts

📄 License

[Add your license information here]

🤝 Contribution

[Add contribution guidelines here]