1.0.7 (#29)

* chor: init 1.0.7

* refactor: modularize api client and add api key auth

- Replaced monolithic KomodoClient with modular Resource Pattern
- Integrated official 'komodo_client' package
- Added API Key authentication support
- Added JSDoc documentation for all API classes
- Updated all tools to use new API structure
- Removed custom Axios implementation

* chore: setup linting, formatting and implement graceful shutdown

- Add ESLint and Prettier configuration (.eslintrc.json, .prettierrc)
- Add lint and format scripts to package.json
- Fix all linting errors and strict type warnings across the codebase
- Refactorchore: setup linting, formatting and implement graceful shutdown

* feat: add helmet middleware for enhanced security

* fix: tests and graceful shutdown

* docs: add detailed descriptions for tools and environment schema

* docs: changelog

* docs: adjusting documentation

* fix: correct server name in MCP server instance creation

* docs: clarify valid Komodo credentials in README

Author: MP-Tool

.eslintrc.json

@@ -0,0 +1,17 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "plugin:prettier/recommended"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }],
+    "prettier/prettier": "warn"
+  }
+}

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 120,
+  "tabWidth": 2
+}

CHANGELOG.md

@@ -80,4 +80,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - Updated all transport layers to utilize the new centralized logger for consistent output.
     - **Standardization**: Standardized log component tags and session management for consistent filtering.
 
+--------------------------------------------------------------
+
+## [1.0.7] (#29)
+
+### Added
+- **Security**: Integrated `helmet` middleware to enhance HTTP security headers for the SSE transport.
+- **Authentication**: Added support for API Key authentication (`KOMODO_API_KEY`, `KOMODO_API_SECRET`) as an alternative to username/password login.
+
+### Changed
+- **Documentation**: Added comprehensive JSDoc documentation for the core `KomodoMCPServer` class, environment configuration schemas, and all tool definitions.
+- **Refactoring**: Modularized the API client structure for better maintainability.
+- **Stability**: Improved graceful shutdown handling for both Stdio and SSE transports to ensure clean resource release.
 
+### Fixed
+- **Tests**: Resolved issues in the test suite and improved logger mocking for tests.

README.md

@@ -125,7 +125,7 @@ Comming soon: Pre-built n8n workflows for automated container health checks and
 - **Komodo** v1.19.5 or later
 - **Docker** (for containerized deployment)
 - **Node.js 20+** (for local development)
-- Valid Komodo credentials (username/password)
+- **Valid Komodo credentials** (API Key/Secret or username/password)
 
 ### Integration Guides
 - **[Claude Desktop](examples/claude/)** - Direct MCP integration

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