docs-mcp-server 的安装和配置教程

项目的基础介绍和主要的编程语言

docs-mcp-server 是一个开源项目，旨在为 AI 编码助手提供一个总是最新的知识库。该项目通过索引第三方文档，包括您代码库中实际使用的库的文档，来解决 AI 助手面临的问题。它从网站、GitHub 仓库、包管理器（如 npm、PyPI）甚至本地文件中抓取文档，并通过 Model Context Protocol (MCP) 提供强大的搜索工具。该项目的主要编程语言是 JavaScript。

项目使用的关键技术和框架

docs-mcp-server 使用以下关键技术和框架：

• Node.js: 项目的主要运行环境，用于构建后端服务。
• Express: 基于 Node.js 的 Web 应用程序框架，用于创建 HTTP 服务器。
• Docker: 用于容器化应用程序，简化部署和运行过程。
• Model Context Protocol (MCP): 用于与 AI 助手通信的协议。
• Web 界面: 用于搜索和管理文档的前端界面。

项目安装和配置的准备工作和详细的安装步骤

准备工作

在开始安装 docs-mcp-server 之前，请确保您的系统已安装以下软件：

• Docker: 用于运行容器化应用程序。
• Docker Compose: 用于定义和运行多容器 Docker 应用程序。
• Git: 用于克隆项目仓库。

安装步骤

1. 克隆项目仓库

   打开终端（或命令提示符），执行以下命令克隆项目仓库：

   git clone https://github.com/arabold/docs-mcp-server.git
   cd docs-mcp-server
   

2. 设置环境变量

   复制示例环境文件并编辑它以添加您的 OpenAI API 密钥（这是必需的）：

   cp .env.example .env
   

   使用文本编辑器打开 .env 文件并设置您的 OpenAI API 密钥：

   OPENAI_API_KEY=your-api-key-here
   

3. 启动服务

   在项目根目录下运行以下命令来构建镜像（如果需要）并启动服务：

   docker compose up -d
   

   -d 参数会使容器在后台运行。如果您想直接在终端中查看日志，可以省略该参数。

4. 配置 MCP 客户端

   将以下配置块添加到您的 MCP 设置文件中（例如，对于 Claude、Cline、Roo）：

   {
     "mcpServers": {
       "docs-mcp-server": {
         "url": "http://localhost:6280/sse",
         "disabled": false,
         "autoApprove": []
       }
     }
   }
   

   更新配置后，重启您的 AI 助手应用程序。

5. 访问 Web 界面

   如果您使用了推荐的 Docker Compose 设置，请在浏览器中导航到 http://localhost:6281。

   现在，您可以使用 Web 界面添加新的文档以索引或搜索现有文档。

6. 停止服务

   如果需要停止服务，可以在项目目录下运行以下命令：

   docker compose down
   

以上就是 docs-mcp-server 的安装和配置教程，按照以上步骤操作，您应该能够成功安装并运行该项目。