MCP-Typescribe - an MCP Server providing LLMs API information

注意

目前已暂停公开开发，因为尚未形成活跃的社区。我们正在开发一个后续项目，专门针对 yFiles API。更多信息请参阅：yFiles MCP Server。yFiles 开发者可以改用这些工具，通过 MCP 查询 API、开发指南、源代码片段和示例。它们的效果远胜于本仓库中的实现。

MCP-Typescribe - 为大模型提供 API 信息的 MCP 服务

问题

大模型（LLM）在代码生成和提高开发者效率方面取得了令人瞩目的进展。然而，它们面临一个关键限制：只有在训练过程中接触过的 API 和库，才能可靠地使用。这为采用新工具、SDK 或内部 API 带来了瓶颈——大模型根本不知道如何有效地使用它们。

虽然可以为工具提供源代码访问权限（在与源代码可用的 API 交互时），或提供文档文件访问权限（例如 TypeScript 类型定义文件），但对于大型 API 来说，这种方式难以扩展。大模型需要更高效地了解 API。每次请求都把所有文档放入上下文中既低效又不可行，还会导致结果不佳。

因此：

更大型的新 API 或内部 API 对大模型而言仍然是“不可见”的。

开发者必须手动引导大模型，或提供使用示例。

API 发布与 AI 工具广泛理解它之间的滞后，拖慢了创新。

构想

本项目是 Model Context Protocol（MCP）的一个开源实现。MCP 是一种旨在为大模型提供上下文相关实时信息访问能力的协议。在本项目中，这些信息是 API 文档，尤其是目前的 TypeScript 定义。

我们的目标是：

将 TypeScript（以及其他语言）的定义解析为机器可读格式。

通过 Claude、Cline、Cursor、Windsurf 等工具以及其他自定义界面，动态地向大模型提供这些上下文。

让大模型能够查询、规划并适应陌生的 API，从而实现 Agent 式行为，而无需重新训练。

这带来的能力

为基于大模型的编码助手提供即插即用的 API 支持。

加快新 SDK 或专有 SDK 的上手速度。

向更自主、具备上下文感知能力的编码 Agent 迈进一步。

项目概览

本项目为 AI Agent 提供了一种高效探索和理解未知 TypeScript API 的方式。它加载 TypeDoc 生成的 JSON 文档，并通过一组查询端点提供这些文档，使 Agent 能够搜索符号、获取 API 特定部分的详细信息，并了解不同组件之间的关系。

当前功能

• TypeDoc 集成：加载并索引 TypeDoc JSON 文档，以便高效查询
• 全面的查询能力：提供丰富的工具，用于探索 TypeScript API
• MCP 协议：遵循 Model Context Protocol，以便与 AI Agent 无缝集成

查询能力

该服务提供以下工具来查询 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：查找类型/函数的使用位置

开始使用

前置条件

• Node.js
• npm

安装

1. 克隆仓库
2. 安装依赖：

   npm install
   

使用方法

1. 为 TypeScript API 生成 TypeDoc JSON：

   npx typedoc --json docs/api.json --entryPointStrategy expand path/to/your/typescript/files
   

   如果你只有现有的 .d.ts 文件，可以按如下方式创建 API JSON 文件：

   创建单独的 tsconfig.docs.json：

   {
     "extends": "./tsconfig.json",
     "files": ["existing.d.ts"],
     "typedocOptions": {
       "entryPoints": ["existing.d.ts"],
       "json": "docs/api.json",
       "pretty": false
     }
   }
   

   然后执行

   npx typedoc --tsconfig tsconfig.docs.json
   

2. 构建项目：

   npm run build
   

3. 探索 MCP 服务：

   npx @modelcontextprotocol/inspector node ./dist/mcp-server/cli.js run-server docs/api.json
   

4. 将 AI Agent 连接到服务以查询 API

   例如，使用 VSCode 中的 cline 时，在 cline_mcp_settings.json 中指定以下 MCP 服务：

   {
     "mcpServers": {
       "typescribe": {
         "command": "npx",
         "args": [
           "-y",
           "mcp-typescribe@latest",
           "run-server",
           "<PATH_TO_API_DOT_JSON>"
         ],
         "env": {}
       }
     }
   }
   

5. 启用服务，并可能需要自动批准各种工具。告诉 Agent 使用“typescribe”工具来了解你的 API。

项目结构

• src/sample-api/：用于测试的 TypeScript API 示例——它使用一种奇特的类德语方言来命名 API，以测试大模型是否会对 API 产生幻觉
• src/mcp-server/：MCP 服务实现
  • utils/：实用函数
  • schemas/：MCP 工具的 JSON schema
  • core/：核心功能
  • server.ts：MCP 服务实现
  • index.ts：库导出的入口点
  • cli.ts：CLI/二进制文件的入口点
• tests/：API 功能测试

开发

运行测试

npm test

构建

npm run build

许可证

MIT

Copyright 2025 yWorks GmbH - https://www.yworks.com