关键词

文档搜索AI助手知识管理上下文服务文档导航

项目简介

Agentic Knowledge MCP 服务器允许AI助手像人类一样自然地搜索和理解任何文档，无论是内部项目文档、框架参考还是企业知识库。它通过为AI提供智能的搜索策略和文件系统工具（如grep、文件读取）来工作，而非预先创建复杂的向量数据库或嵌入。这意味着您的AI助手能够更精确、更智能地发现所需信息，利用其强大的工具调用和解释能力。

主要功能点

  • 智能文档搜索: AI助手可以像阅读文档一样自然地提问，服务器会提供精确的搜索指令，利用AI自身的内置工具（如grep、rg、ripgrep、find）在文档中查找答案。
  • 多源文档支持: 支持从本地文件夹（通过符号链接）或Git仓库加载文档，无需复杂的向量数据库设置。
  • 高效响应: 文档设置（下载/初始化）只需数秒，搜索响应时间通常在10毫秒以内。
  • 零基础设施: 无需额外的数据库或复杂服务，仅通过配置文件管理文档源。
  • 可定制的搜索指令: 支持自定义Prompt模板，允许用户精细控制AI助手的搜索行为和返回的上下文格式。
  • 协议合规: 完全遵循Model Context Protocol (MCP) 规范，通过JSON-RPC协议与LLM客户端通信，提供标准化的上下文和工具服务。

安装步骤

  1. 确保Node.js环境: 您的系统需要安装Node.js (推荐LTS版本)。
  2. 全局安装CLI工具: 打开终端，运行以下命令： 
    npm install -g @codemcp/knowledge
# 或者如果你使用pnpm
pnpm add -g @codemcp/knowledge
    这将安装 'agentic-knowledge' CLI工具，其中包含了MCP服务器。
  3. 可选：本地开发安装: 如果您希望从源码运行或进行开发，请克隆GitHub仓库，然后在项目根目录运行 'pnpm install' 安装依赖，并运行 'pnpm build' 进行构建。

服务器配置

MCP客户端（例如Claude Desktop或其他支持MCP的LLM应用）需要配置此服务器才能与之通信。您需要在MCP客户端的配置中添加对Agentic Knowledge MCP服务器的引用。以下是一个典型的MCP客户端配置示例：

{
  "mcpServers": {
    "agentic-knowledge": {
      "command": "npx",
      "args": [
        "-y",
        "@codemcp/knowledge@latest"
      ],
      "name": "agentic-knowledge",
      "description": "通过提供智能导航指令，帮助AI助手在文档中进行搜索和查找信息的MCP服务器",
      "protocol": "stdio",
      "initializationTimeout": 30000
    }
  }
}

配置说明：

  • 'mcpServers': 这是MCP客户端配置中用于定义MCP服务器的部分。
  • 'agentic-knowledge': 这是您为该MCP服务器定义的唯一标识符和名称。
  • 'command': 指定MCP客户端应执行什么命令来启动此服务器，这里使用 'npx'。
  • 'args': 提供给 'command' 的参数列表。这里的 '@codemcp/knowledge@latest' 是启动Agentic Knowledge MCP服务器的npm包。
  • 'name': (可选) MCP服务器的友好名称。
  • 'description': (可选) MCP服务器的功能描述。
  • 'protocol': (可选) 客户端与服务器之间的通信协议，默认为 'stdio'。
  • 'initializationTimeout': (可选) 服务器启动的超时时间，单位毫秒。

基本使用方法

  1. 设置文档集:

    • 推荐方式 (CLI): 在您的项目根目录或任何方便的位置，使用CLI工具创建并初始化一个文档集。例如，为一个Git仓库创建文档集： 
      npx @codemcp/knowledge create \
  --preset git-repo \
  --id react-docs \
  --name "React Documentation" \
  --url https://github.com/facebook/react.git

npx @codemcp/knowledge init react-docs
      这将创建一个 '.knowledge/config.yaml' 文件（如果不存在），并在其中添加 'react-docs' 文档集配置，并将其文档下载到 '.knowledge/docsets/react-docs'。
    • 手动配置: 在您的项目根目录下创建 '.knowledge/config.yaml' 文件，并添加文档集配置。例如，为一个本地文件夹创建文档集： 
      version: "1.0"
docsets:
  - id: my-docs
    name: My Project Documentation
    sources:
      - type: local_folder
        paths: ["./docs"]
      然后运行 'npx @codemcp/knowledge init my-docs' 初始化。这将会在 '.knowledge/docsets/my-docs' 创建指向您 './docs' 文件夹的符号链接。

  2. 启动MCP客户端: 按照您的MCP客户端（例如Claude Desktop）的指示启动它。MCP客户端会根据您在“服务器配置”步骤中添加的配置信息，自动启动Agentic Knowledge MCP服务器。

  3. 与AI助手交互: 您的AI助手现在可以使用 'search_docs' 和 'list_docsets' 工具。您可以直接向AI提问，例如：

    • "如何在React 'useEffect' 中实现清理函数？"
    • "显示我们文档中的认证设置。"
    • "在API文档中查找限速的例子。" AI助手将获得智能的导航指令（包括搜索路径和关键词），并利用其内置的文件系统工具（如grep）来查找信息。

信息

分类

开发者工具

访问项目