项目简介

doc-bot是一个基于Model Context Protocol (MCP) 构建的智能服务器，旨在解决传统AI助手在处理特定项目时缺乏上下文理解和有限上下文窗口的问题。它能够将您的项目文档和API参考转化为AI助手可访问的知识库，从而让AI助手更好地理解您的代码库、遵循项目规范，并提供更准确、更相关的帮助。

主要功能点

智能搜索项目文档：AI助手可以通过自然语言查询，在您的项目文档中进行智能搜索，快速找到所需信息，而不是被冗余信息淹没。
上下文感知规则：根据AI助手当前正在处理的文件或任务，自动应用相关的项目规则和指南，确保代码质量和一致性。
实时更新：当项目文档发生变化时，doc-bot能实时更新其知识库，确保AI助手始终获取最新信息。
整合API参考（Docsets）：支持集成如Dash等工具使用的Docsets（预构建的官方API文档数据库），让AI助手能够访问各种编程语言、框架和库的官方API参考。
MCP工具集成：提供一系列专门的MCP工具，AI助手可以调用这些工具来查询文档、检查规则、探索API等，实现更高级的交互。

安装步骤

doc-bot作为Node.js包发布，推荐通过'npx'直接运行，无需全局安装。

安装 Node.js: 确保您的系统已安装Node.js（推荐LTS版本）。
将doc-bot添加到AI助手配置中: 在您的AI助手（如Claude Desktop、Cursor）的配置文件中添加doc-bot服务器配置。具体配置方法和文件位置请参考下面的“服务器配置”部分。

创建项目文档文件夹: 在您的项目根目录中创建一个名为'doc-bot'的文件夹。

your-project/
├── doc-bot/
│   ├── coding-standards.md
│   └── api-patterns.md
├── src/
└── package.json

在'doc-bot'文件夹中创建Markdown文件，并使用Frontmatter（YAML格式的元数据）来定义文档的标题、描述、关键词以及何时应用（例如：'alwaysApply: true'表示全局规则，'filePatterns: ["*.test.js"]'表示仅适用于测试文件）。

添加Agent集成规则: 将doc-bot提供的核心Agent集成规则（'AGENT_INTEGRATION_RULE.txt'，通常在仓库的根目录）替换掉您AI助手的默认规则和指令。

服务器配置

MCP客户端（如Claude、Cursor）需要知道如何启动并连接到doc-bot服务器。这通常通过在AI助手的配置中添加一个JSON对象来完成。以下是通用配置示例及参数说明：

{
  "mcpServers": {
    "doc-bot": {
      "command": "npx",
      "args": [
        "@afterxleep/doc-bot@latest",
        // 可选参数：
        "--docs", "./documentation", // 指定项目文档的根目录，默认为当前项目下的 'doc-bot' 文件夹。
        "--docsets", "/path/to/docsets", // 指定Docsets的存储路径，默认为用户主目录下的 'Developer/DocSets'。
        "--verbose",                   // 启用详细日志输出，便于调试。
        "--watch"                      // 启用文件监听模式，文档文件修改后自动重新加载。
      ]
    }
  }
}

'"command": "npx"': 告诉AI助手使用'npx'命令来启动doc-bot。
'"args": [...]': 传递给doc-bot服务器的启动参数：
- '"@afterxleep/doc-bot@latest"': 这是doc-bot的npm包名，'@latest'确保使用最新版本。
- '"--docs", "./documentation"': （可选）如果您希望将项目文档放在'doc-bot'以外的其他文件夹中，例如'./documentation'，请使用此参数指定路径。默认路径是'./doc-bot'。
- '"--docsets", "/path/to/docsets"': （可选）如果您希望自定义Docsets（API参考文档）的存储位置，请使用此参数指定路径。默认位置是用户主目录下的'~/Developer/DocSets'。
- '"--verbose"': （可选）如果希望在控制台看到doc-bot的详细运行日志，可以添加此参数。
- '"--watch"': （可选）添加此参数后，doc-bot会监听您的项目文档文件夹，一旦有文件修改，会自动重新加载文档，无需重启服务器。

配置文件的位置:

macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%\Claude\claude_desktop_config.json'
Linux: '~/.config/Claude/claude_desktop_config.json'
Cursor: 在 '.cursor' 文件夹中添加一个 'mcp.json' 文件，内容如上所示。

基本使用方法

提问项目特定问题: 在AI助手中向doc-bot提问关于您的项目的问题，例如：“这个项目的编码标准是什么？”
调用工具: 您也可以直接要求AI助手调用特定的doc-bot工具，例如：
- '使用 search_documentation 工具来搜索“认证流程”'
- '使用 explore_api 工具来探索“URLSession”的API'
- '使用 add_docset 工具安装Swift文档，源地址为 https://kapeli.com/feeds/Swift.tgz'
遵循规则指导: 当AI助手为您生成代码时，它会参考doc-bot提供的项目规则和上下文文档，确保生成的内容符合您的项目规范。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息