使用说明

项目简介

DevRev MCP服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在为LLM客户端提供访问DevRev平台数据的能力。它通过标准化的MCP协议，允许LLM客户端调用预定义的工具来搜索和检索DevRev平台上的信息，从而增强LLM在DevRev应用场景中的上下文理解和交互能力。

主要功能点

搜索工具 (search): 允许LLM客户端通过关键词和命名空间（文章、问题、工单）在DevRev平台中执行混合搜索，快速查找相关信息。
获取对象工具 (get_object): 允许LLM客户端根据DevRev对象的ID，获取该对象的详细信息，例如问题、工单的具体内容和属性。
MCP协议支持: 遵循MCP协议规范，通过JSON-RPC与客户端通信，提供标准的工具列表和工具调用接口。
易于集成: 提供简单的配置方式，可以方便地与支持MCP协议的LLM客户端（如Claude Desktop）集成使用。

安装步骤

环境准备: 确保已安装 Python 3.7 或更高版本。

下载仓库: 从 GitHub 克隆或下载此仓库的代码到本地。

git clone https://github.com/kpsunil97/devrev-mcp-server.git
cd devrev-mcp-server

安装依赖: 虽然仓库中没有明确的 'requirements.txt' 文件，但根据代码依赖，可能需要安装 'mcp-server' 和 'requests' 库。建议在项目根目录下执行以下命令安装：
```
pip install mcp-server requests
```
如果希望以开发模式安装，可以在 'src/devrev_mcp' 目录下执行：
```
pip install -e .
```

服务器配置

MCP服务器需要配置 DevRev API 密钥才能正常工作。您需要在DevRev平台创建账号并生成 API 密钥，然后将其配置到服务器的环境变量中。

MCP客户端配置 (以 Claude Desktop 为例):

MCP客户端需要配置服务器的启动命令和参数，以便连接到 DevRev MCP 服务器。以下是配置示例，请根据您的实际情况进行调整。

开发模式配置 (Development/Unpublished Servers Configuration):

{
  "mcpServers": {
    "devrev": {
      "command": "uv",
      "args": [
        "--directory",
        "Path to src/devrev_mcp directory",  //  请替换为实际的 'src/devrev_mcp' 目录的路径
        "run",
        "devrev-mcp"
      ],
      "env": {
        "DEVREV_API_KEY": "YOUR_DEVREV_API_KEY"  // 请替换为您的 DevRev API 密钥
      }
    }
  }
}

发布模式配置 (Published Servers Configuration):

如果您已将 'devrev-mcp' 命令添加到系统路径，可以使用以下更简洁的配置：

{
  "mcpServers": {
    "devrev": {
      "command": "uvx",
      "args": [
        "devrev-mcp"
      ],
      "env": {
        "DEVREV_API_KEY": "YOUR_DEVREV_API_KEY"  // 请替换为您的 DevRev API 密钥
      }
    }
  }
}

配置参数说明:

'"server name"': '"devrev"' - MCP 服务器的名称，客户端使用此名称来引用服务器。
'"command"': 服务器启动命令。
- '"uv"': 用于在开发模式下运行，需要指定项目目录。
- '"uvx"': 用于在发布模式下运行，假设 'devrev-mcp' 命令已在系统路径中。
'"args"': 命令参数列表。
- 开发模式下，需要使用 '--directory' 参数指定 'src/devrev_mcp' 目录的路径，以及 'run devrev-mcp' 来执行服务器。
- 发布模式下，只需 'devrev-mcp' 命令即可。
'"env"': 环境变量配置。
- '"DEVREV_API_KEY"': 必须配置，用于存储您的 DevRev API 密钥，服务器会使用此密钥进行 API 请求身份验证。

请注意: 将 '"Path to src/devrev_mcp directory"' 替换为实际的 'src/devrev_mcp' 目录的绝对路径。将 '"YOUR_DEVREV_API_KEY"' 替换为您在 DevRev 平台生成的 API 密钥。

基本使用方法

启动服务器: 根据您选择的配置模式，使用相应的命令启动 DevRev MCP 服务器。例如，在开发模式下，您可能需要在 'src/devrev_mcp' 目录的父目录中执行类似 'uv --directory src/devrev_mcp run devrev-mcp' 的命令。
配置客户端: 在支持 MCP 协议的 LLM 客户端（如 Claude Desktop）中，根据上述 "服务器配置" 部分的说明，配置 DevRev MCP 服务器连接信息。
使用工具: 在 LLM 客户端中，您应该能够调用 'search' 和 'get_object' 工具来访问 DevRev 数据。具体的工具调用方式取决于 LLM 客户端的界面和指令格式。例如，您可以指示 LLM 使用 'search' 工具在 DevRev 中搜索特定关键词的信息。

关键词