TypeDoc MCP服务器
一个模型上下文协议（MCP）服务器，为AI代理提供TypeDoc生成的文档。该服务器使AI助手能够通过其文档理解和导航TypeScript代码库。
特性
- 快速符号搜索 -按名称查找类、接口、函数等
- 完整的文档访问权限 -获取完整的文档，包括描述、参数、返回类型和示例
- 会员检查 -列出具有继承支持的类和接口的所有成员
- JSDoc标签搜索 -根据符号的JSDoc标签查找符号（例如，@弃用、@beta、@example）
- 项目概述 -获取有关文档化代码库的高级统计数据和信息
安装
npx快速入门
使用TypeDoc MCP服务器的最简单方法是使用npx：
{
"mcpServers": {
"typedoc": {
"command": "npx",
"args": [
"-y",
"tsdoc-mcp-server",
"--doc-path",
"/path/to/your/typedoc.json"
]
}
}
}本地安装
您还可以在本地安装服务器：
npm install -g tsdoc-mcp-server然后将其添加到MCP配置中：
{
"mcpServers": {
"typedoc": {
"command": "tsdoc-mcp-server",
"args": [
"--doc-path",
"/path/to/your/typedoc.json"
]
}
}
}来源
- 克隆此存储库：
git clone https://github.com/dpmacdonagh/tsdoc-mcp-server.git
cd tsdoc-mcp-server- 安装依赖项并构建：
npm install
npm run build- 添加到MCP配置中：
{
"mcpServers": {
"typedoc": {
"command": "node",
"args": [
"/path/to/tsdoc-mcp-server/dist/index.js",
"--doc-path",
"/path/to/your/typedoc.json"
]
}
}
}生成TypeDoc文档
自动设置（推荐）
TypeDoc MCP服务器可以通过AI助手帮助自动设置TypeDoc。只需使用您的项目路径启动服务器：
{
"mcpServers": {
"typedoc": {
"command": "npx",
"args": [
"-y",
"tsdoc-mcp-server",
"--project-path",
"/path/to/your/typescript/project"
]
}
}
}然后让你的AI助手：
- 检查TypeDoc安装状态
- 如果需要，生成TypeDoc配置
- 运行TypeDoc以生成文档
AI将使用设置工具自动配置一切！
手动设置
如果您更喜欢手动设置TypeDoc：
- 在项目中安装TypeDoc：
npm install --save-dev typedoc- 创建一个
typedoc.json配置文件：
{
"entryPoints": ["./src"],
"entryPointStrategy": "expand",
"out": "./docs",
"json": "./docs/typedoc.json"
}重要：使用 "entryPointStrategy": "expand" 确保所有模块和内部符号都有记录。
- 生成文档：
npx typedoc这将创建HTML文档和 typedoc.json MCP服务器使用的文件。
使用AI助手
配置后，TypeDoc MCP服务器可以通过AI助手进行强大的文档探索。以下是您可以使用的示例提示：
探索文档的示例提示
入门指南：
- “向我展示这个TypeScript项目的概述”
- “这个代码库中的主要类是什么？”
- “查找项目中的所有接口”
搜索符号：
- “查找UserService类”
- “显示包含'Controller'的所有类”
- “查找所有以'handle'开头的函数”
理解代码：
- “解释AuthenticationManager类及其方法”
- “显示登录方法的文档”
- “createUser函数接受哪些参数？”
探索班级成员：
- “列出DatabaseConnection类中的所有方法”
- “仅显示用户界面的公共属性”
- “Repository类继承了哪些方法？”
查找特殊代码：
- “在代码库中查找所有已弃用的方法”
- “显示所有测试版功能（标记为@beta）”
- “在文档中查找所有代码示例”
设置文档提示示例
如果您的项目尚未配置TypeDoc：
初始设置：
- “检查是否在我的项目/path/to/project中设置了TypeDoc”
- “帮助我为我的TypeScript项目设置TypeDoc”
- “为我的项目生成TypeDoc配置”
生成文档：
- “为我的TypeScript项目生成文档”
- “安装TypeDoc并创建文档”
- “我的项目有JSDoc注释，但没有生成的文档-请帮助我创建它们”
文档工具
找到符号
使用可选的种类过滤按名称搜索符号。
// Find all symbols named "MyClass"
findSymbol({ name: "MyClass" })
// Find all classes containing "Service"
findSymbol({ name: "Service", kind: "class", exact: false })get文档
按ID或路径获取符号的完整文档。
// Get docs by symbol ID
getDocumentation({ symbolId: 123 })
// Get docs by path
getDocumentation({ symbolPath: "MyNamespace.MyClass.myMethod" })获取成员
列出类或接口的所有成员。
// Get all members
getMembers({ symbolId: 123 })
// Get only methods, including inherited
getMembers({
symbolId: 123,
memberType: "method",
includeInherited: true
})searchByTag
通过符号的JSDoc标签查找符号。
// Find all deprecated symbols
searchByTag({ tag: "deprecated" })
// Find symbols with specific tag values
searchByTag({ tag: "since", value: "2.0.0" })设置工具
该服务器包括强大的设置工具，AI助手可以使用这些工具为您的项目配置TypeDoc：
checkTypeDocSetup
检查TypeDoc是否在TypeScript项目中正确安装和配置。
checkTypeDocSetup({ projectPath: "/path/to/project" })
// Returns status including:
// - TypeDoc installation status
// - Configuration file presence
// - Generated documentation existence
// - Detected source directories
// - Actionable recommendationsgenerateTypeDocConfig
为TypeScript项目生成TypeDoc配置文件。
generateTypeDocConfig({
projectPath: "/path/to/project",
entryPoints: ["./src"], // Optional, auto-detected if not provided
outputPath: "./docs" // Optional, defaults to "./docs"
})
// Creates typedoc.json with optimal settingsrunTypeDocGeneration
运行TypeDoc为TypeScript项目生成文档。
runTypeDocGeneration({
projectPath: "/path/to/project",
install: true, // Install TypeDoc if not present
configPath: "./typedoc.json" // Optional
})
// Installs TypeDoc if needed and generates documentation资源
服务器还提供 typedoc://overview 提供文档化项目的高级视图的资源，包括有关模块、类、接口、函数和其他符号数量的统计信息。
发展
先决条件
- Node.js 18或更高版本
- TypeScript 5.0或更高版本
建筑
npm install
npm run build在发展中奔跑
npm run dev -- --doc-path ./docs/typedoc.json测试
npm test生成自我文档
这个项目记录了自己！要重新生成文档，请执行以下操作：
npm run docs配置
服务器接受以下命令行参数：
--doc-path：TypeDoc JSON文件的路径（用于现有文档）--project-path：TypeScript项目目录的路径（用于安装工具）--name：自定义服务器名称（可选）
示例：
# Use existing documentation
tsdoc-mcp-server --doc-path /path/to/typedoc.json
# Point to a project (enables setup tools)
tsdoc-mcp-server --project-path /path/to/project
# Start with no arguments (use setup tools via AI)
tsdoc-mcp-server贡献
欢迎投稿！请随时提交拉取请求。
许可证
麻省理工学院
致谢
与 模型上下文协议SDK 通过Anthropic。