DocsFetcher MCP 服务器使用说明
项目简介
DocsFetcher MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,专注于为大型语言模型 (LLM) 提供软件包和库的文档信息。该服务器能够从多种编程语言生态系统(如 JavaScript, Python, Java, .NET 等)中检索并抓取文档,并以结构化的形式提供给 LLM 客户端使用。DocsFetcher 旨在帮助 LLM 更好地理解代码上下文,提升代码生成和理解能力。
主要功能点
- 多语言文档检索: 支持 JavaScript, Python, Java, .NET, Ruby, PHP, Rust, Go, Swift 等主流编程语言的软件包文档检索。
- 灵活的查询方式: 支持通过软件包名称或文档 URL 进行查询。
- 全面的文档内容抓取: 能够抓取包括 README, API 文档, 代码示例, 仓库信息等在内的多类型文档内容。
- 结构化数据输出: 为 LLM 提供结构化的文档数据,方便 LLM 进行理解、分析和总结。
- 内置 Prompt 模板: 提供预定义的 Prompt 模板,如 'summarize-library-docs' (库文档总结) 和 'explain-dependency-error' (依赖错误解释),优化 LLM 的交互体验。
- 无需 API 密钥: 服务器运行无需配置任何 API 密钥,开箱即用。
安装步骤
- 环境准备: 确保您的计算机上已安装 Node.js (版本 18 或更高)。
- 克隆仓库: 使用 Git 克隆 DocsFetcher MCP Server 仓库到本地:
git clone https://github.com/cdugo/mcp-get-docs cd mcp-get-docs - 安装依赖和构建: 在仓库根目录下,运行以下命令安装项目依赖并构建项目:
npm install npm run build
服务器配置
DocsFetcher MCP 服务器需要配置到支持 MCP 协议的客户端中才能使用,例如 Claude Desktop 或 Cursor IDE。以下是针对这两个客户端的配置方法:
Claude Desktop 配置: 打开 Claude Desktop 的设置,进入 “Developer” (开发者) 选项,点击 “Edit Config” (编辑配置),在弹出的配置文件中添加如下 'mcpServers' 配置:
{ "mcpServers": { "docsFetcher": { "command": "npx", "args": [ "-y", "@smithery/cli@latest", "run", "@cdugo/mcp-get-docs", "--config", "'{}'" ] } } }
- server name (服务器名称): 'docsFetcher' - 用户自定义的服务器名称,在客户端中引用时使用。
- command (启动命令): 'npx' - Node.js 包执行器,用于运行 npm 包。
- args (命令参数):
- '-y': 'npx' 参数,自动确认执行 npm 包。
- '@smithery/cli@latest': 指定使用的 Smithery CLI 工具及其版本。
- 'run': Smithery CLI 的运行命令。
- '@cdugo/mcp-get-docs': 指定要运行的 MCP 服务器 npm 包。
- '--config': 配置参数标志。
- ''{}'': 空的 JSON 配置字符串作为参数传递给服务器。
Cursor IDE 配置: 打开 Cursor IDE 的设置,找到 “MCP” 选项,点击 “Add New MCP Server” (添加新的 MCP 服务器),然后填入以下配置信息:
{ "Name": "docsFetcher", "Command": "npx -y @smithery/cli@latest run @cdugo/mcp-get-docs --config '{}'" }
- Name (服务器名称): 'docsFetcher' - 用户自定义的服务器名称,在 Cursor IDE 中引用时使用。
- Command (启动命令): 'npx -y @smithery/cli@latest run @cdugo/mcp-get-docs --config '{}'' - 与 Claude Desktop 配置中的 'command' 和 'args' 组合相同,用于启动服务器。
基本使用方法
完成客户端配置后,您可以在 Claude Desktop 或 Cursor IDE 中通过以下方式使用 DocsFetcher 的功能:
-
使用工具 (Tools): 在聊天输入框中使用 '@工具名称 with 参数名='参数值'' 的格式调用工具,例如:
- '@fetch-package-docs with packageName='react' and language='javascript'' - 检索 React (JavaScript) 的文档。
- '@fetch-url-docs with url='https://expressjs.com/en/api.html'' - 检索 Express.js API 文档。
- '@fetch-library-docs with library='vue' and language='javascript'' - 智能检索 Vue.js (JavaScript) 的文档 (可接受包名或 URL)。
- '@fetch-multilingual-docs with packageName='requests' and languages=['python', 'javascript']' - 检索 requests 库在 Python 和 JavaScript 中的文档。
-
使用 Prompt 模板 (Prompts): 在聊天输入框中使用 '@Prompt名称 with 参数名='参数值'' 的格式调用 Prompt 模板,例如:
- '@summarize-library-docs with libraryName='express'' - 总结 Express.js 库的文档。
- '@explain-dependency-error with packageName='axios'' - 解释关于 axios 库的依赖错误。
注意: 使用前请重启 Claude Desktop 或 Cursor IDE 以应用 MCP 服务器配置。
信息
分类
开发者工具