使用说明

项目简介

Rootly MCP Server 是一个 Model Context Protocol (MCP) 服务器，旨在将 Rootly API 的强大功能以标准化的 MCP 协议形式提供给大型语言模型 (LLM) 客户端。它通过动态解析 Rootly OpenAPI (Swagger) 规范，自动生成可供 LLM 调用的工具，使得 LLM 能够安全、便捷地访问和操作 Rootly 的各项服务。

主要功能点

动态工具生成: 根据 Rootly OpenAPI 规范，自动创建 MCP 工具，无需手动编写工具定义。
Swagger 规范支持: 内置 Rootly API 的 Swagger 规范，并支持自动更新到最新版本。
API 鉴权处理: 通过 Rootly API Token 进行身份验证，确保安全访问 Rootly 服务。
分页处理: 对事件 (incidents) 等端点默认启用分页，防止返回数据过多导致 LLM 上下文窗口溢出。
易于集成: 可以与 Claude 等兼容 MCP 协议的 LLM 客户端轻松集成。

安装步骤

安装 Python 3.12 或更高版本: 确保你的环境中安装了 Python 3.12 或更高版本。

安装 'uv' 包管理器: 按照官方指南安装 'uv' 包管理器，推荐使用以下命令：

curl -LsSf https://astral.sh/uv/install.sh | sh

创建并激活虚拟环境:

# 创建虚拟环境
uv venv

# 激活虚拟环境 (macOS/Linux)
source .venv/bin/activate

# 激活虚拟环境 (Windows)
.venv\Scripts\activate

安装 Rootly MCP Server: 在虚拟环境中，使用 'uv pip install -e .' 命令安装项目及其依赖。如果需要开发环境依赖，可以使用 'uv pip install -e ".[dev]"'。
```
# 安装所有依赖
uv pip install -e .
```

设置 Rootly API Token: 将你的 Rootly API Token 设置为环境变量 'ROOTLY_API_TOKEN'。

export ROOTLY_API_TOKEN="your-api-token-here"

服务器配置

为了让 MCP 客户端（例如 Claude）连接到 Rootly MCP Server，你需要在客户端的 MCP 配置文件（通常是 'mcp.json'）中添加服务器配置信息。以下是一个示例配置，你需要根据你的实际项目路径进行调整：

{
    "mcpServers": {
      "rootly": {
        "command": "uv",
        "args": [
          "run",
          "--directory",
          "/path/to/Rootly-MCP-server",
          "rootly-mcp-server"
        ],
        "env": {
          "ROOTLY_API_TOKEN": "YOUR_ROOTLY_API_TOKEN"
        }
      }
    }
  }

配置参数说明:

'server name': 'rootly' (服务器名称，可以自定义)
'command': 'uv' (启动命令，这里使用 'uv' 运行 Python)
'args': 启动参数列表
- '"run"': 'uv run' 命令的一部分
- '"--directory"': 指定工作目录
- '"/path/to/Rootly-MCP-server"': 请替换为 Rootly-MCP-server 项目的绝对路径
- '"rootly-mcp-server"': 执行 'rootly-mcp-server' 命令启动服务器
'env': 环境变量
- '"ROOTLY_API_TOKEN"': 请替换为你的 Rootly API Token，确保与你在服务器端设置的环境变量一致。

基本使用方法

启动服务器: 在项目根目录下，运行 'rootly-mcp-server' 命令启动服务器。服务器会自动加载 Swagger 规范并注册工具。
```
rootly-mcp-server
```
在 MCP 客户端中使用: 配置好 'mcp.json' 后，在你的 MCP 客户端（如 Claude）中选择配置的 "rootly" 服务器，即可开始使用 Rootly API 提供的工具。客户端会通过 MCP 协议与服务器通信，调用 Rootly API 的各项功能。

注意: 请确保将 '/path/to/Rootly-MCP-server' 替换为你的 Rootly-MCP-server 项目的实际绝对路径，并将 'YOUR_ROOTLY_API_TOKEN' 替换为你的 Rootly API Token。

关键词