MCP-Typescribe - an MCP Server providing LLMs API information
2025.04.16
10
TypeScriptAPI 信息TypeScript 解析LLM 支持开发效率
MCP-Typescribe 是一个基于 Model Context Protocol (MCP) 的服务，旨在为大型语言模型（LLMs）提供实时的 API 信息访问。它通过解析 TypeScript 定义文件，并将其转换为机器可读的格式，使 LLMs 能够高效地查询和理解未知的 API。该服务特别适用于代码生成和开发者生产力工具，帮助 LLMs 快速掌握新或内部 API 的使用方法。
View on GitHub
Overview
基本能力
产品定位
MCP-Typescribe 是一个为大型语言模型（LLMs）提供 API 信息的服务，特别关注 TypeScript 定义的解析和查询。
核心功能
- TypeDoc 集成：加载并索引 TypeDoc 生成的 JSON 文档，以便高效查询。
- 全面的查询能力：提供多种工具来探索 TypeScript API。
- MCP 协议：遵循 Model Context Protocol，与 AI 代理无缝集成。
适用场景
- 为 LLM 提供新或内部 API 的实时信息。
- 加速开发者对新 SDK 或专有 API 的上手过程。
- 支持更自主、上下文感知的编码代理。
工具列表
search_symbols：按名称查找符号，可按类型过滤。get_symbol_details：获取特定符号的详细信息。list_members：列出类或接口的方法和属性。get_parameter_info：获取函数参数的信息。find_implementations：查找接口或子类的实现。search_by_return_type：查找返回特定类型的函数。search_by_description：在 JSDoc 注释中搜索。get_type_hierarchy：显示继承关系。find_usages：查找类型/函数的使用位置。
常见问题解答
- 如何生成 TypeDoc JSON 文件？
使用命令
npx typedoc --json docs/api.json --entryPointStrategy expand path/to/your/typescript/files。 - 如何启动 MCP 服务器？
使用命令
npx @modelcontextprotocol/inspector node ./dist/mcp-server/index.js run-server docs/api.json。
使用教程
使用依赖
- Node.js
- npm
安装教程
- 克隆仓库。
- 安装依赖：
bash npm install - 生成 TypeDoc JSON 文件：
bash npx typedoc --json docs/api.json --entryPointStrategy expand path/to/your/typescript/files - 构建项目：
bash npm run build - 启动 MCP 服务器：
bash npx @modelcontextprotocol/inspector node ./dist/mcp-server/index.js run-server docs/api.json
调试方式
- 运行测试：
bash npm test - 构建项目：
bash npm run build