docs: adjusting documentation

Author: MP-Tool

examples/claude/README.md

@@ -30,14 +30,15 @@ Copy the following configuration into the file. You can also download our [templ
     "-i",
     "-e", "MCP_TRANSPORT=stdio",
     "-e", "KOMODO_URL=https://your-komodo-server.com:9120",
-    "-e", "KOMODO_USERNAME=your-username",
-    "-e", "KOMODO_PASSWORD=your-password",
+    "-e", "KOMODO_API_KEY=your-api-key",
+    "-e", "KOMODO_API_SECRET=your-api-secret",
     "ghcr.io/mp-tool/komodo-mcp-server:latest"
   ]
 }
 ```
 
-**Important:** Replace `KOMODO_URL`, `KOMODO_USERNAME`, and `KOMODO_PASSWORD` with your actual Komodo credentials.
+**Important:** Replace `KOMODO_URL`, `KOMODO_API_KEY`, and `KOMODO_API_SECRET` with your actual Komodo credentials.
+*Note: You can alternatively use `KOMODO_USERNAME` and `KOMODO_PASSWORD` if you prefer.*
 
 ### 3. Restart Claude
 Completely quit and restart Claude Desktop. You should now see in the tool's list, below the websearch toggle, the `Komodo MCP Server` and its available tools.

examples/claude/claude_desktop_config.json

@@ -8,8 +8,8 @@
         "-i",
         "-e", "MCP_TRANSPORT=stdio",
         "-e", "KOMODO_URL=https://komodo.example.com:9120",
-        "-e", "KOMODO_USERNAME=username",
-        "-e", "KOMODO_PASSWORD=password",
+        "-e", "KOMODO_API_KEY=your-api-key",
+        "-e", "KOMODO_API_SECRET=your-api-secret",
         "ghcr.io/mp-tool/komodo-mcp-server:latest"
       ]
     }

examples/compose/.env.example

@@ -10,7 +10,12 @@
 #   - Docker network: http://komodo-core:9120
 KOMODO_URL=https://localhost:9120
 
-# Komodo Authentication
+# Komodo API Key (Recommended)
+# Obtain this from your Komodo server configuration
+KOMODO_API_KEY=your-komodo-api-key
+KOMODO_API_SECRET=your-komodo-api-secret
+
+# Komodo Authentication (Alternative)
 # Create a dedicated user in Komodo for the MCP server
 # Recommended: Create a dedecaded user with read-only or limited permissions
 KOMODO_USERNAME=mcp-user

examples/compose/README.md

@@ -21,8 +21,14 @@ nano .env
 **Required settings:**
 ```dotenv
 KOMODO_URL=https://your-komodo-server.com:9120
-KOMODO_USERNAME=your-username
-KOMODO_PASSWORD=your-password
+
+# Option A: API Key (Recommended)
+KOMODO_API_KEY=your-api-key
+KOMODO_API_SECRET=your-api-secret
+
+# Option B: Username/Password
+# KOMODO_USERNAME=your-username
+# KOMODO_PASSWORD=your-password
 ```
 
 ### 3. Start Server

examples/compose/compose.yaml

@@ -7,8 +7,11 @@ services:
     environment:
       # Komodo Connection
       KOMODO_URL: ${KOMODO_URL:-https://komodo.example.com:9120}
-      KOMODO_USERNAME: ${KOMODO_USERNAME:-username}
-      KOMODO_PASSWORD: ${KOMODO_PASSWORD:-password}
+      KOMODO_API_KEY: ${KOMODO_API_KEY:-your-komodo-api-key}
+      KOMODO_API_SECRET: ${KOMODO_API_SECRET:-your-komodo-api-secret}
+      # Optional: Komodo Authentication
+      # KOMODO_USERNAME: ${KOMODO_USERNAME:-username}
+      # KOMODO_PASSWORD: ${KOMODO_PASSWORD:-password}
 
     ports:
       - 3000:${MCP_PORT:-3000}
@@ -25,7 +28,7 @@ services:
 
     # Health check
     healthcheck:
-      test: ["CMD", "node", "-e", "process.exit(0)"]
+      test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
       interval: 30s
       timeout: 10s
       retries: 3