Ts Def MCP

🚀 TypeScript 定义查找 MCP 服务器

一个 Model Context Protocol (MCP) 服务器，能助力 AI 代码编辑器在代码库中精准查找 TypeScript 符号的定义。当你需要定位从外部包导入的符号、类、接口或函数的原始定义时，这个工具就派上大用场啦。

🚀 快速开始

本服务器可帮助 AI 代码编辑器在代码库中查找 TypeScript 符号的定义。下面为你介绍使用前的准备、安装及使用方法。

✨ 主要特性

• 精准查找 TypeScript 符号的原始定义。
• 支持查找从外部包导入的符号。
• 不仅返回定义位置，还提供代码片段。
• 支持 stdio 接口，可与 AI 代码编辑器实现无缝集成。

📦 安装指南

先决条件

• 需安装 Bun v1.2.2 或更高版本。
• 需安装 Node.js，用于运行编译后的服务器。

安装方式

使用 Smithery 安装

若要通过 Smithery 为 Claude Desktop 自动安装 TypeScript 定义查找器，可执行以下命令：

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

手动安装

1. 安装依赖项：

bun install

2. 构建项目：

bun run build

💻 使用示例

启动服务器

启动 stdio 服务器的命令如下：

node dist/run.js

工具描述

该服务器提供了一个名为 find_typescript_definition 的工具，具体信息如下：

• 工具名称：find_typescript_definition
• 触发命令：/ts-def（若在 Cursor 中使用，可强制 AI 编辑器查找引用符号的定义）
• 目的：定位 TypeScript 代码库中符号的原始定义

输入参数

此工具需要三个参数：

1. file_path (字符串)：当前 TypeScript 文件的绝对路径，例如 /path/to/your/project/src/index.ts。
2. line_content (字符串)：包含要查找定义的符号所在的整行内容，用于定位文件中的正确行，且必须与文件中的行完全匹配。
3. column_number (数字)：符号起始的 1 基数列号，必须是符号第一个字符的确切列位置。

基础用法

查找导入符号的定义

给定如下导入语句：

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

若要查找 StdioServerTransport 的定义（该符号从第 10 列开始），可使用以下 JSON 数据：

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

工具的输出如下：

[
  {
    "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 + }"
  }
]

查找私有运输工具的定义

给定如下代码行：

private _transport: Transport;

若要查找 Transport 的定义（该符号从第 9 列开始），可使用以下 JSON 数据：

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

响应格式

该工具返回的 JSON 响应包含以下信息：

• 定义所在的文件路径。
• 定义的行号。
• 定义的实际代码片段。

📚 详细文档

开发相关

本项目使用 bun init 在 bun v1.2.2 中创建。Bun 是一个快速的全功能 JavaScript 运行时。

开发模式下运行

在开发过程中，可直接使用 Bun 运行服务器，命令如下：

bun run index.ts

📄 许可证

[在此处添加你的许可证信息]

🤝 贡献

[在此处添加贡献指南]