项目简介

Octomind MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器端应用，旨在桥接 Octomind 平台的各项测试能力与 LLM (大型语言模型) 客户端。它允许开发者和用户通过集成的 LLM 工具，便捷地访问和使用 Octomind 提供的测试资源和功能，例如执行自动化测试、管理测试环境、检索测试报告以及搜索 Octomind 文档等。

主要功能点

工具 (Tools):
- 文档搜索 (search): 在 Octomind 文档中搜索指定查询，快速获取文档链接和内容摘要。
- 测试用例管理 (getTestCase, discovery): 检索、创建和发现测试用例，支持通过描述或 Prompt 生成测试用例。
- 测试执行 (executeTests): 触发针对指定 URL 的自动化测试执行，可配置环境、变量和标签。
- 环境管理 (getEnvironments, createEnvironment, updateEnvironment, deleteEnvironment): 管理测试目标的环境配置，包括创建、更新、删除和列出环境。
- 测试报告管理 (getTestReports, getTestReport): 检索和查看测试报告，包括报告列表和详细报告内容。
- 私有位置管理 (getPrivateLocations): 列出组织配置的私有位置，用于访问防火墙或 VPN 后面的测试目标。
- 版本查询 (getVersion): 获取 Octomind MCP Server 的当前版本信息。
资源 (Resources):
- 测试报告 (test reports): 以资源形式提供测试报告列表和详细内容，允许 LLM 客户端访问和分析测试结果。
- 测试结果追踪 (test result traces): 提供测试结果的追踪信息资源，方便问题诊断和调试。
Prompt 模板 (Prompts):
- 创建登录测试用例 (Create Login Test Case): 预置 Prompt 模板，指导 LLM 客户端创建用于验证用户登录功能的测试用例。

安装步骤

环境准备: 确保已安装 Node.js 和 npm (或 yarn)。

安装 Octomind MCP Server: 在命令行中运行以下命令全局安装 '@octomind/octomind-mcp' 包：

npm install -g @octomind/octomind-mcp

或者使用 yarn:

yarn global add @octomind/octomind-mcp

配置 API Key: Octomind MCP Server 需要 API Key 才能访问 Octomind API。您需要设置 'APIKEY' 环境变量。您可以从 Octomind 平台获取 API Key。
```
export APIKEY="your-api-key-here"  # Linux/macOS
set APIKEY=your-api-key-here      # Windows
```
请将 'your-api-key-here' 替换为您的实际 API Key。您还可以选择性设置 'OCTOMIND_API_URL' 环境变量来指定 Octomind API 的基础 URL，默认为 'https://app.octomind.dev/api'。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令和参数才能连接。以下是针对不同 MCP 客户端的配置示例，您只需将这些 JSON 配置添加到您的客户端配置文件中，并替换 'your-api-key-here' 为您的实际 API Key。

Claude Desktop (.claude-config.json):

{
  "mcpServers": {
    "octomind-mcp": {
      "name": "Octomind MCP Server",
      "command": "npx",
      "args": [
        "@octomind/octomind-mcp"
      ],
      "env": {
        "APIKEY": "your-api-key-here"  // 请替换为您的 API Key
      }
    }
  }
}

Cursor (cursor.json):

{
  "mcpServers": {
    "octomind-mcp": {
      "name": "Octomind MCP Server",
      "command": "npx",
      "args": [
        "@octomind/octomind-mcp"
      ],
      "env": {
        "APIKEY": "your-api-key-here"  // 请替换为您的 API Key
      }
    }
  }
}

Windsurf (config.json):

{
  "mcpServers": {
    "octomind-mcp": {
      "name": "Octomind MCP Server",
      "command": "npx",
      "args": [
        "@octomind/octomind-mcp"
      ],
      "environment": {
        "APIKEY": "your-api-key-here"  // 请替换为您的 API Key
      }
    }
  }
}

您可以通过运行以下命令获取这些配置片段：

npx @octomind/octomind-mcp --clients

基本使用方法

启动 MCP 服务器: 在命令行中运行以下命令启动 Octomind MCP Server：
```
npx @octomind/octomind-mcp
```
服务器成功启动后，将在控制台输出版本信息，例如 "Server version 1.0.8 started"。
配置 MCP 客户端: 根据您使用的 LLM 客户端 (如 Claude Desktop, Cursor, Windsurf)，按照上述 "服务器配置" 部分的说明配置 MCP 服务器连接。
在 LLM 客户端中使用工具和资源: 配置完成后，您可以在 LLM 客户端中发现并调用 Octomind MCP Server 提供的工具和资源。具体使用方式取决于您的 LLM 客户端，通常您可以在客户端的工具或插件面板中找到 "Octomind MCP Server" 及其提供的功能。例如，您可以使用 'search' 工具搜索 Octomind 文档，使用 'executeTests' 工具触发自动化测试，或访问 'test reports' 资源查看测试报告。

注意: Octomind MCP Server 依赖于 Octomind API，请确保您的 API Key 有效，并且您的网络可以访问 Octomind API 服务。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息