使用说明

项目简介

Contextual MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,它利用 Contextual AI 平台的能力,为 Cursor IDE 和 Claude Desktop 等 MCP 客户端提供增强的 RAG (Retrieval-Augmented Generation) 功能。该服务器充当 AI 界面和 Contextual AI 智能体之间的桥梁,支持用户通过客户端向指定的 Contextual AI 智能体提问,并从知识库中检索相关信息,生成包含引用的、基于上下文的回答。

主要功能点

  • 知识库问答: 连接 Contextual AI 智能体,针对特定知识库进行提问和解答。
  • 智能检索: 在全面的知识库中搜索相关信息,为回答提供依据。
  • 上下文感知: 生成的回答基于检索到的文档,包含来源引用,并能维护对话上下文。
  • 易于集成: 可与 Cursor IDE 和 Claude Desktop 等 MCP 客户端无缝集成。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/ContextualAI/contextual-mcp-server.git
    cd contextual-mcp-server
  2. 创建并激活虚拟环境:

    python -m venv .venv
    source .venv/bin/activate   # Linux/macOS
    .venv\Scripts\activate  # Windows
  3. 安装依赖:

    pip install -e .

服务器配置

Contextual MCP Server 需要通过环境变量进行配置,您需要设置 Contextual AI 的 API 密钥和 Agent ID。

环境变量配置

  • 'API_KEY': 您的 Contextual AI API 密钥
  • 'AGENT_ID': 您的 Contextual AI Agent ID (仅 single_agent/server.py 需要)

您可以将这些变量配置在 '.env' 文件中。

MCP 客户端配置 MCP 客户端(如 Cursor 或 Claude Desktop)需要配置 'mcp.json' 文件以连接到 Contextual MCP Server。以下是配置示例,您需要根据实际情况修改 'command' 和 'args' 字段。

'mcp.json' 配置示例

{
 "mcpServers": {
   "ContextualAI-TechDocs": {
     "command": "/your/path/to/uv",  //  请替换为您的 uv 可执行文件的完整路径,例如 /Users/username/miniconda3/bin/uv
     "args": [
       "--directory",
       "${workspaceFolder}",  //  此为占位符,客户端会自动替换为当前工作区目录
       "run",
       "single_agent/server.py"  //  或 "multi_agent/server.py",根据您的需求选择
     ]
   }
 }
}

配置说明:

  • '"ContextualAI-TechDocs"': 服务器名称,您可以自定义。
  • '"command"': 启动服务器的命令。这里假设您使用 'uv' 运行 Python 脚本,请替换为 'uv' 的实际路径。
  • '"args"': 传递给 'uv' 命令的参数列表。
    • '"--directory", "${workspaceFolder}"': 指定工作目录为客户端的工作区根目录。
    • '"run", "single_agent/server.py"': 运行 'single_agent/server.py' 脚本,启动 MCP 服务器。您可以根据需要选择 'multi_agent/server.py'。

配置文件位置:

  • Cursor:
    • 项目级别: '.cursor/mcp.json' (在您的项目根目录下)
    • 全局级别: '~/.cursor/mcp.json' (用户主目录下)
  • Claude Desktop:
    • 请参考 Claude Desktop 的 MCP 客户端配置文档,将 'mcp.json' 放置在相应的配置目录下。

基本使用方法

  1. 确保已配置好环境变量和 MCP 客户端的 'mcp.json' 文件。
  2. 启动 MCP 服务器:在仓库根目录下,根据 'mcp.json' 中的配置,客户端会自动启动服务器。您也可以手动在虚拟环境中运行 'uv run single_agent/server.py' 或 'uv run multi_agent/server.py' 启动服务器。
  3. 在 Cursor IDE 或 Claude Desktop 等 MCP 客户端中,您可以向配置的 "ContextualAI-TechDocs" 服务器发送 MCP 请求,例如在 IDE 中提问 "Show me the code for initiating the RF345 microchip?"。
  4. 服务器会将查询路由到 Contextual AI Agent,检索相关文档,并生成带有引用的回答返回给客户端。

注意: 请确保您已拥有 Contextual AI API 密钥和 Agent ID,并在环境变量中正确配置。

信息

分类

AI与计算