octomind mcp server: let agents create and manage e2e tests

1# octomind mcp server: let agents create and manage e2e tests
2 
3<img src="images/light.png" alt="Octomind Logo" width="250">
4 
5[![smithery badge](https://smithery.ai/badge/@OctoMind-dev/octomind-mcp)](https://smithery.ai/server/@OctoMind-dev/octomind-mcp)
6 
7Octomind provides a whole e2e platform for test creation, execution and management including auto-fix.
8With this MCP server you can use Octomind tools and resources in your local development environment and 
9enable it to create new e2e tests, execute them and more. see https://octomind.dev/ and 
10https://octomind.dev/docs/mcp/install-octomind-mcp for more details.
11 
12## See it in action together with testrail mcp
13 
14[![Video Title](https://img.youtube.com/vi/I7lc9I0S62Y/0.jpg)](https://www.youtube.com/watch?v=I7lc9I0S62Y)
15 
16## Configuration
17 
18### Environment Variables
19 
20The server uses the following environment variables:
21 
22- `APIKEY` - The API key for Octomind API (required)
23- `OCTOMIND_API_URL` - Base URL for the API endpoint to use (defaults to https://app.octomind.dev/api)
24- `REDIS_URL` - Redis connection URL for session storage (optional, format: redis://host:port)
25- `SESSION_EXPIRATION_SECONDS` - Time in seconds after which sessions expire (optional, Redis only)
26 
27### Command Line Options
28 
29The server supports the following command line options:
30 
31- `-s, --sse` - Enable SSE transport mode
32- `-t, --stream` - Enable Streamable HTTP transport mode
33- `-c, --clients` - Show client configuration examples
34- `-p, --port <port>` - Port to listen on (default: 3000)
35- `-r, --redis-url <url>` - Redis URL for session storage
36- `-e, --session-expiration <seconds>` - Session expiration time in seconds
37 
38### Session Storage
39 
40The server supports two types of session storage:
41 
421. **In-memory storage** (default) - Sessions are stored in memory and will be lost when the server restarts
432. **Redis storage** - Sessions are stored in Redis and can persist across server restarts
44 
45For production deployments, it's recommended to use Redis storage with an appropriate session expiration time. The Redis storage option also enables horizontal scaling with multiple server instances.
46 
47### Logging Configuration
48 
49- `LOG_FILENAME` - The file to write logs to (only for debugging). If not set, logging is disabled
50- `LOG_LEVEL` - The log level to use (defaults to info)
51 
52## Tools
53 
54The following tools are implemented in this MCP server:
55 
56- `search` - Search the Octomind documentation for a given query
57- `getTestCase` - Retrieve a test case for a given test target and test case ID
58- `executeTests` - Trigger test execution for a given test target on a specified URL
59- `getEnvironments` - List environments for a test target
60- `createEnvironment` - Create a new environment for a test target
61- `updateEnvironment` - Update an existing environment
62- `deleteEnvironment` - Delete an environment
63- `getTestReports` - Retrieve test reports for a test target
64- `getTestReport` - Get a specific test report by ID
65- `discovery` - Create a test case with a description or prompt
66- `getPrivateLocations` - List all private locations configured for the organization
67- `getVersion` - Get the current version of the Octomind MCP server
68 
69## Installation
70 
71You can get configuration snippets for different clients by running:
72 
73```bash
74npx @octomind/octomind-mcp --clients
75```
76 
77This will output configuration examples for Claude Desktop, Cursor, and Windsurf. Here are the configuration files for most clients:
78 
79### Installing via Smithery
80 
81To install octomind-mcp for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@OctoMind-dev/octomind-mcp):
82 
83```bash
84npx -y @smithery/cli install @OctoMind-dev/octomind-mcp --client claude
85```
86 
87### Claude Desktop (.claude-config.json)
88```json
89{
90  "mcpServers": {
91    "octomind-mcp": {
92      "name": "Octomind MCP Server",
93      "command": "npx",
94      "args": [
95        "-y",
96        "@octomind/octomind-mcp@latest"
97      ],
98      "env": {
99        "APIKEY": "your-api-key-here"
100      }
101    }
102  }
103}
104```
105 
106### Cursor (cursor.json)
107```json
108{
109  "mcpServers": {
110    "octomind-mcp": {
111      "name": "Octomind MCP Server",
112      "command": "npx",
113      "args": [
114        "-y",
115        "@octomind/octomind-mcp@latest"
116      ],
117      "env": {
118        "APIKEY": "your-api-key-here"
119      }
120    }
121  }
122}
123```
124 
125### Windsurf (mcp_config.json)
126```json
127{
128  "mcpServers": {
129    "octomind-mcp": {
130      "name": "Octomind MCP Server",
131      "command": "npx",
132      "args": [
133        "-y",
134        "@octomind/octomind-mcp@latest"
135      ],
136      "environment": {
137        "APIKEY": "your-api-key-here"
138      }
139    }
140  }
141}
142```
143 
144Note: Replace `your-api-key-here` with your actual API key.
145 
146To get an APIKEY see here https://octomind.dev/docs/get-started/execution-without-ci#create-an-api-key
147 
148# Listings / Integrations
149 
150Certified by [MCPHub](https://mcphub.com/mcp-servers/octomind-dev/octomind-mcp)
151 
152<a href="https://glama.ai/mcp/servers/@OctoMind-dev/octomind-mcp">
153  <img width="380" height="200" src="https://glama.ai/mcp/servers/@OctoMind-dev/octomind-mcp/badge" alt="octomind-mcp MCP server" />
154</a>
155 
156[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/octomind-dev-octomind-mcp-badge.png)](https://mseep.ai/app/octomind-dev-octomind-mcp)
157 
158