使用说明

项目简介

mcp-qase 是一个 MCP (Model Context Protocol) 服务器,它将 Qase API 的功能暴露给支持 MCP 协议的 LLM 客户端,例如 Claude。通过 mcp-qase,LLM 可以访问和操作 Qase 平台上的测试项目和测试结果数据。

主要功能点

  • 资源 (Resources): 以 'project://{project_code}' URI 形式提供 Qase 平台上的测试项目列表和项目详情。
  • 工具 (Tools): 提供一系列工具,允许 LLM 客户端调用 Qase API 的功能,包括:
    • 'list_projects': 获取项目列表
    • 'get_project': 获取项目详情
    • 'create_project': 创建新项目
    • 'delete_project': 删除项目
    • 'get_results': 获取测试结果列表
    • 'get_result': 获取测试结果详情
    • 'create_result': 创建测试结果
  • Prompt 模板 (Prompts): 提供 'summarize_notes' Prompt 模板 (示例,实际应用可能需要根据 Qase API 数据设计更有意义的 Prompt)。

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 克隆仓库到本地: 'git clone https://github.com/rikuson/mcp-qase.git'
  3. 进入项目目录: 'cd mcp-qase'
  4. 安装依赖: 'npm install'
  5. 构建项目: 'npm run build'

服务器配置

将以下配置添加到 MCP 客户端 (例如 Claude) 的配置文件中。你需要将 '/path/to/mcp-qase/build/index.js' 替换为 'mcp-qase' 项目 'build/index.js' 文件的实际路径。

{
  "mcpServers": {
    "mcp-qase": {
      "command": "/path/to/mcp-qase/build/index.js",
      "args": []
    }
  }
}

注意: 启动 'mcp-qase' 服务器前,请确保已设置环境变量 'QASE_API_TOKEN' 为你的 Qase API Token。

基本使用方法

  1. 启动 'mcp-qase' 服务器。
  2. 在支持 MCP 协议的 LLM 客户端中配置并连接 'mcp-qase' 服务器。
  3. LLM 客户端可以通过以下方式与 Qase API 进行交互:
    • 使用 'project://{project_code}' URI 访问 Qase 项目资源。
    • 调用 'list_projects', 'get_project', 'create_project' 等工具执行 Qase API 操作。
    • 使用 'summarize_notes' Prompt 模板(或其他自定义 Prompt,如果添加了的话)。

信息

分类

开发者工具