关于 TypeScript Package Introspector (MCP Server)
TypeScript Package Introspector 是用于提取 npm 包及 TypeScript 源码导出符号和类型信息的 MCP 服务,面向需要检查 API 结构的 LLM 应用。它还会提取 JSDoc 注释作为说明。
主要功能
- 01提取 npm 包导出符号
- 02分析 TypeScript 源码
- 03返回详细类型签名
- 04提取 JSDoc 注释
适用场景
- 01检查 npm 包公开 API
- 02分析源码中的函数与类型
- 03向 LLM 应用提供类型信息
MCP 相关
服务提供 introspect-package 和 introspect-source 工具,使 MCP 客户端可查询 npm 包或 TypeScript 源码的导出符号。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
3收录的工具列表 · 更新于 3 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| packageName | string | 是 | 要检查的 npm 包名称(例如 'zod')。 |
| searchPaths | array | 否 | 搜索包时使用的可选路径 |
| searchTerm | string | 否 | 按搜索词筛选导出项(支持正则表达式) |
| cache | boolean | 否 | 启用/禁用缓存以加快重复查找 |
| cacheDir | string | 否 | 存储缓存文件的目录(默认值:.ts-morph-cache) |
| limit | number | 否 | 限制返回的导出项数量 |
详细介绍
TypeScript 包检查器(MCP Server)
此工具可检查 TypeScript 包和源代码,提取导出的符号(函数、类、类型、常量)及其类型信息。它以 Model Context Protocol (MCP) 服务的形式运行。
功能
- 使用类型定义从 npm 包中提取导出的符号
- 直接分析 TypeScript 源代码
- 获取所有导出符号的详细类型签名
- 提取 JSDoc 注释作为描述
- 通过 MCP 向大模型提供类型信息
使用方法
此工具可作为 MCP 服务运行,为 Claude for Desktop 等大模型应用提供 TypeScript 包检查功能。可使用 npx 启动:
npx ts-introspect-mcp-server
要将其集成到项目中,请创建 .roo/mcp.json 配置文件:
{
"mcpServers": {
"ts-introspect": {
"command": "npx",
"args": ["-y", "ts-introspect-mcp-server"]
}
}
}
MCP 工具
MCP 服务提供以下工具:
introspect-package
检查 npm 包并返回其导出的符号。
参数:
packageName:要检查的 npm 包名称(例如,'zod')
introspect-source
检查 TypeScript 源代码并返回导出的符号。
参数:
source:要分析的 TypeScript 源代码
开发
# Run tests
npm test
# Start the MCP server in development mode
npm run start:mcp
许可证
MIT
评论
支持 Markdown
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。