TypeScript Package Introspector (MCP Server)

TypeScript Package Introspector (MCP Server)

site icon
2025.04.07 0
TypeScriptTypeScript 内省工具代码分析工具开发效率
TypeScript Package Introspector (MCP Server) 是一个用于检查 TypeScript 包和源代码的工具,能够提取导出的符号(函数、类、类型、常量)及其类型信息。它作为一个 Model Context Protocol (MCP) 服务器运行,为 LLM 应用程序提供 TypeScript 包的内省能力。
View on GitHub

Overview

基本能力

产品定位

TypeScript Package Introspector (MCP Server) 是一个专门用于 TypeScript 包和源代码内省的工具,旨在为开发者和 LLM 应用程序提供详细的类型信息和符号导出功能。

核心功能

  • 从 npm 包中提取导出的符号,使用其类型定义
  • 直接分析 TypeScript 源代码
  • 获取所有导出符号的详细类型签名
  • 提取 JSDoc 注释作为描述
  • 通过 MCP 向 LLM 提供类型信息

适用场景

  • 开发者在开发过程中需要快速了解 TypeScript 包的导出符号和类型信息
  • LLM 应用程序需要访问 TypeScript 包的内省信息以提供更好的代码辅助功能
  • 项目需要自动化分析 TypeScript 源代码的导出符号

工具列表

introspect-package

  • 能力:内省 npm 包并返回其导出的符号
  • 参数:packageName(要内省的 npm 包名称,例如 'zod')

introspect-source

  • 能力:内省 TypeScript 源代码并返回导出的符号
  • 参数:source(要分析的 TypeScript 源代码)

常见问题解答

  • 如何启动 MCP 服务器? 使用命令 npx ts-introspect-mcp-server 启动服务器。
  • 如何集成到项目中? 创建 .roo/mcp.json 配置文件,并配置相应的命令和参数。

使用教程

使用依赖

  • 确保已安装 Node.js 和 npm

安装教程

  1. 使用 npx 直接运行服务器:
npx ts-introspect-mcp-server
  1. 或者,将服务器集成到项目中,创建 .roo/mcp.json 文件并添加以下配置:
{
  "mcpServers": {
    "ts-introspect": {
      "command": "npx",
      "args": ["-y", "ts-introspect-mcp-server"]
    }
  }
}

调试方式

  1. 运行测试:
npm test
  1. 在开发模式下启动 MCP 服务器:
npm run start:mcp

许可证

该项目遵循 MIT 开源许可条款。