metersphere-mcp-server

# MeterSphere MCP Server (Model Context Protocol) This project implements an API testing-oriented MCP Server based on the Model Context Protocol (MCP) specification, enabling LLM clients (such as VS Code, Claude, Cursor, etc.) to invoke testing services, retrieve interface definitions, execute test cases, and return results through a standardized protocol. ## Introduction MeterSphere MCP Server (Model Context Protocol Server) establishes connections with MCP Clients via HTTP + SSE, STDIO, or Docker channels, exposing testing-related tools and resources to LLMs. As an intelligent bridge between testing platforms and development environments, it completely breaks down barriers between testing and development, allowing developers to obtain, execute, and analyze testing resources directly in IDEs, code editors, or AI assistants without switching tools. Developers can use natural language instructions to have large language models invoke underlying testing capabilities, achieving end-to-end operations including API testing, documentation retrieval, Mock service creation, and compatibility verification, shifting testing left to the development phase, significantly shortening feedback cycles, and improving development efficiency. Meanwhile, testing assets configured by testing teams (such as case libraries, environment configurations, assertion rules, etc.) can be seamlessly invoked by developers, ensuring unified testing standards and promoting DevTestOps integration practices. Clients can discover and invoke tools to perform functional testing, API testing, API documentation retrieval, and various other scenarios, achieving intelligent, automated, and collaborative testing processes. ## Installation and Running ```bash git clone https://github.com/metersphere/metersphere-mcp-server.git cd metersphere-mcp-server mvn clean install ``` ## Core Features ## Client Configuration Examples ### VS Code // .vscode/settings.json ``` { "servers": { // SSE connection configuration "ms-mcp-server-sse": { "type": "sse", "url": "http://localhost:8000/sse", "headers": { "accessKey": "your-access-key", "signature": "your-signature", "meterSphereUrl": "http://your-metersphere-url" } }, // Docker connection configuration "ms-mcp-server-docker": { "type": "stdio", "command": "docker", "args": [ "run", "-i", "--rm", "-p", "8000:8000", "-e", "accessKey=${env:accessKey}", "-e", "signature=${env:signature}", "-e", "meterSphereUrl=${env:meterSphereUrl}", "metersphere-mcp-server" ], "env": { "accessKey": "your-access-key", "signature": "your-signature", "meterSphereUrl": "http://your-metersphere-url" } } } } ``` ### Claude Client ``` { "mcp_providers": { // SSE connection method "metersphere-sse": { "protocol": { "type": "sse", "baseUrl": "http://localhost:8000", "path": "/sse" }, "auth": { "type": "header", "headers": { "accessKey": "your-access-key", "signature": "your-signature", "meterSphereUrl": "http://your-metersphere-url" } }, "defaults": { "env": "dev" } }, // Docker connection method "metersphere-docker": { "protocol": { "type": "stdio", "command": "docker run -i --rm -p 8000:8000 metersphere-mcp-server" }, "env": { "accessKey": "your-access-key", "signature": "your-signature", "meterSphereUrl": "http://your-metersphere-url" }, "defaults": { "env": "staging" } } }, // Default provider "default_provider": "metersphere-sse" } ``` ## Configuration and Deployment - `PORT` (HTTP port, default 8000) - `MCP_TPYE` (http-sse | stdio | docker) - `AK/SK` (Authentication keys) - `MeterSphereURL` (Deployed MeterSphere platform address) ## Security and Permissions - AK/SK authentication supported. - Admin role permissions, only allowing authorized roles to invoke sensitive tools (such as `Project Data Acquisition and Processing`).