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

📄 許可證

[在此處添加你的許可證信息]

🤝 貢獻

[在此處添加貢獻指南]