项目简介

MeterSphere MCP Server 是一个基于 Model Context Protocol (MCP) 标准实现的后端服务。它作为连接大型语言模型(LLM)客户端(如 VS Code、Claude 等)和 MeterSphere 测试平台之间的智能桥梁。通过标准化协议,它允许 LLM 客户端调用 MeterSphere 的测试服务、获取接口定义、执行测试用例、分析测试结果等。这使得开发人员可以直接在熟悉的开发环境中使用自然语言指令驱动测试,将测试活动前移到开发阶段,提升协作效率和研发效能。

主要功能点

本项目主要通过 MCP 协议向 LLM 客户端暴露 MeterSphere 的以下能力:

  • 核心接口测试工具:
    • 接口文档同步: 将接口定义同步到其他系统。
    • 执行API接口测试用例: 直接在开发环境或AI助手中执行 MeterSphere 中的 API 测试用例。
    • 基于代码生成测试案例: 可能支持根据代码生成初步测试结构。
    • 代码用例与测试平台同步: 将本地代码级别的测试用例与 MeterSphere 平台同步。
    • 测试结果智能分析: 对执行结果进行分析并提供反馈。
  • 测试资源管理工具:
    • 获取测试平台测试用例: 从 MeterSphere 获取已有的测试用例列表或详情。
    • 缺陷与测试用例关联: 可能支持将缺陷与相关测试用例进行链接。

这些功能以“工具”的形式通过 MCP 协议暴露给 LLM,LLM 可以根据用户指令调用这些工具。

安装步骤

  1. 确保您已安装 Java 开发环境和 Maven。
  2. 克隆项目仓库:
    git clone https://github.com/metersphere/metersphere-mcp-server.git
  3. 进入项目目录:
    cd metersphere-mcp-server
  4. 使用 Maven 构建项目:
    mvn clean install
    这将编译代码并打包可执行文件。

服务器配置(供MCP客户端连接使用)

要让支持 MCP 的 LLM 客户端连接到此 MeterSphere MCP Server,您需要在客户端的配置文件中添加服务器信息。配置信息描述了客户端如何启动或连接到 MCP 服务器进程。

通常,您需要指定以下信息:

  1. 连接类型 (type/protocol): 支持 'sse' (Server-Sent Events) 或 'stdio' (标准输入输出,常用于启动独立进程或 Docker 容器)。
  2. 连接详情:
    • 如果使用 'sse' 类型,需要提供服务器的 URL (例如 'http://localhost:8000/sse')。
    • 如果使用 'stdio' 类型,需要提供启动服务器进程的 命令 (command) 及其 参数 (args)。例如,启动一个 Docker 容器可能需要 'command: docker' 和一系列 'args' 来运行镜像,设置端口映射和传递环境变量。
  3. 身份验证/配置信息 (headers/env): 您需要提供连接 MeterSphere 平台的关键信息,这些信息会通过 HTTP Header (sse) 或环境变量 (stdio/docker) 传递给 MCP 服务器。
    • 'accessKey': 访问密钥,用于身份验证。
    • 'signature': 签名,用于请求签名验证(安全考虑)。
    • 'meterSphereUrl': 您部署的 MeterSphere 平台的完整访问地址。

MCP 客户端会根据您的这些配置来建立与 MeterSphere MCP Server 的通信。请参考您的具体 LLM 客户端关于 MCP 服务器配置的详细文档。

基本使用方法

配置完成后,在您的 LLM 客户端(例如 VS Code 编辑器、Claude 对话界面)中,当您与 LLM 进行交互时,LLM 会感知到已连接的 MeterSphere MCP Server 提供的能力(工具)。您可以通过自然语言向 LLM 发出指令,例如:

  • “执行 MeterSphere 中 ID 为 xxx 的 API 测试用例。”
  • “获取关于 URL 为 yyy 的 API 的文档信息。”
  • “分析最近一次运行的测试结果,找出失败的原因。”

LLM 会根据您的指令,调用 MeterSphere MCP Server 提供的相应工具来完成操作,并将结果或信息返回给您。

信息

分类

开发者工具