Merge pull request #16 from OctoMind-dev/resources

- install instructions
- readme
- getversion tool

Author: sker65

Diff for: README.md

@@ -7,26 +7,75 @@ The server uses 2 environment variables:
 - APIKEY the apikey for octomind api
 - OCTOMIND_API_URL  base url for the api endpoint to use. defaults to https://app.octomind.dev/api
 
-## tools implemented
+## Tools
 
-- getTestReport
-- executeTests
+The following tools are implemented in this MCP server:
 
+- `search` - Search the Octomind documentation for a given query
+- `getTestCase` - Retrieve a test case for a given test target and test case ID
+- `executeTests` - Trigger test execution for a given test target on a specified URL
+- `getEnvironments` - List environments for a test target
+- `createEnvironment` - Create a new environment for a test target
+- `updateEnvironment` - Update an existing environment
+- `deleteEnvironment` - Delete an environment
+- `getTestReports` - Retrieve test reports for a test target
+- `getTestReport` - Get a specific test report by ID
+- `discovery` - Create a test case with a description or prompt
+- `getPrivateLocations` - List all private locations configured for the organization
+- `getVersion` - Get the current version of the Octomind MCP server
 
-# config
+## Installation
 
-to use the server e.g. in cursor you can configure it like this
+You can get configuration snippets for different clients by running:
 
+```bash
+npx @octomind/octomind-mcp --clients
+```
+
+This will output configuration examples for Claude Desktop, Cursor, and Windsurf. Here are the configuration files for each client:
+
+### Claude Desktop (.claude-config.json)
+```json
+{
+  "name": "Octomind MCP Server",
+  "command": "npx",
+  "args": [
+    "@octomind/octomind-mcp"
+  ],
+  "env": {
+    "APIKEY": "your-api-key-here"
+  }
+}
+```
+
+### Cursor (cursor.json)
 ```json
 {
-  "mcpServers": {
-    "octomind": {
-      "command": "npx",
-      "args": ["@octomind/octomind-mcp"],
-      "env": {
-        "APIKEY": "...."
-      }
-    }
+  "name": "Octomind MCP Server",
+  "command": "npx",
+  "args": [
+    "@octomind/octomind-mcp"
+  ],
+  "env": {
+    "APIKEY": "your-api-key-here"
   }
 }
 ```
+
+### Windsurf (config.json)
+```json
+{
+  "name": "Octomind MCP Server",
+  "command": "npx",
+  "args": [
+    "@octomind/octomind-mcp"
+  ],
+  "environment": {
+    "APIKEY": "your-api-key-here"
+  }
+}
+```
+
+Note: Replace `your-api-key-here` with your actual API key.
+
+To get an APIKEY see here https://octomind.dev/docs/get-started/execution-without-ci#create-an-api-key

Diff for: package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octomind/octomind-mcp",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "an mcp server for the octomind platform",
   "main": "./dist/index.js",
   "packageManager": "[email protected]+sha512.139cab068fdf0b751268179ac5f909b5be72afb4a75c513d1905d151befc8977b593d3cf8671ed83d4d6637c5c94b98ffbce108125de4a5a27a31233601a99de",

Diff for: src/index.ts

@@ -18,9 +18,55 @@ const buildServer = async (): Promise<McpServer> => {
   return server;
 };
 
+const helpInstall = () => {
+  const configs = {
+    claude: {
+      name: "Octomind MCP Server",
+      command: "npx",
+      args: ["@octomind/octomind-mcp"],
+      env: {
+        APIKEY: "your-api-key-here",
+      },
+    },
+    cursor: {
+      name: "Octomind MCP Server",
+      command: "npx",
+      args: ["@octomind/octomind-mcp"],
+      env: {
+        APIKEY: "your-api-key-here",
+      },
+    },
+    windsurf: {
+      name: "Octomind MCP Server",
+      command: "npx",
+      args: ["@octomind/octomind-mcp"],
+      environment: {
+        APIKEY: "your-api-key-here",
+      },
+    },
+  };
+
+  console.error("Configuration snippets for different clients:\n");
+  console.error("Claude Desktop (.claude-config.json):");
+  console.error(`${JSON.stringify(configs.claude, null, 2)}\n`);
+
+  console.error("Cursor (cursor.json):");
+  console.error(`${JSON.stringify(configs.cursor, null, 2)}\n`);
+
+  console.error("Windsurf (config.json):");
+  console.error(`${JSON.stringify(configs.windsurf, null, 2)}\n`);
+
+  console.error("Note: Replace 'your-api-key-here' with your actual API key");
+  process.exit(0);
+};
+
 export const serverStartupTime = Date.now();
 
 const start = async () => {
+  const { argv } = process;
+  if (argv[2] === "--clients") {
+    helpInstall();
+  }
   if (!process.env.APIKEY) {
     console.error("APIKEY environment variable is required");
     process.exit(1);

Diff for: src/tools.ts

@@ -1,6 +1,7 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
 import { uuidValidation } from "./types";
+import { version } from "./version";
 import {
   createEnvironment,
   deleteEnvironment,
@@ -544,4 +545,21 @@ export const registerTools = async (server: McpServer): Promise<void> => {
       };
     },
   );
+
+  // Version information
+  server.tool(
+    "getVersion",
+    "Returns the current version of the Octomind MCP server",
+    {},
+    async () => {
+      return {
+        content: [
+          {
+            type: "text",
+            text: `Octomind MCP Server version: ${version}`,
+          },
+        ],
+      };
+    },
+  );
 };

Diff for: src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = "1.0.6";
+export const version = "1.0.7";