Release version 2.0.0: Multi-server configuration and improved setup experience

misterboe · misterboe · commit 852cc66c5fa9 · 2025-02-10T07:26:28.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,92 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0]
+
+### Breaking Changes
+
+- **Server Configuration**: Changed from environment variables to config file
+  - Now requires a configuration file at `~/.mcp/strapi-mcp-server.config.json`
+  - Supports multiple server configurations
+  - Old method using `API_URL` and `JWT` environment variables no longer works
+  - All API calls now require a `server` parameter to specify which server to use
+
+### Added
+
+- Multiple server support through config file
+- New `strapi_list_servers` command to show available servers
+- Better error messages with configuration help
+- Server-specific configuration validation
+
+### Changed
+
+- All API commands now require a `server` parameter
+- Configuration structure moved to JSON file
+- Improved error messages with setup instructions
+- Updated documentation for multi-server setup
+
+### Migration Guide
+
+1. Create the configuration directory:
+
+   ```bash
+   mkdir -p ~/.mcp
+   ```
+
+2. Create the configuration file:
+
+   ```bash
+   touch ~/.mcp/strapi-mcp-server.config.json
+   ```
+
+3. Add your server configuration:
+
+   ```json
+   {
+     "myserver": {
+       "api_url": "http://localhost:1337",
+       "api_key": "your-jwt-token-from-strapi-admin"
+     }
+   }
+   ```
+
+4. Update your Claude Desktop configuration:
+
+   ```json
+   {
+     "mcpServers": {
+       "strapi": {
+         "command": "npx",
+         "args": ["-y", "@bschauer/strapi-mcp-server"]
+       }
+     }
+   }
+   ```
+
+5. Secure your configuration file:
+   ```bash
+   chmod 600 ~/.mcp/strapi-mcp-server.config.json
+   ```
+
+## [1.0.1]
+
+### Fixed
+
+- Fixed binary path in package.json for npx execution
+
+## [1.0.0]
+
+### Added
+
+- Initial release
+- Basic Strapi CMS integration
+- REST API support
+- GraphQL support
+- Media upload handling
+- JWT authentication
+- Content type management
+- Image processing with format conversion
diff --git a/README.md b/README.md
@@ -22,7 +22,11 @@ You can use this server directly with npx in your Claude Desktop configuration:
   "mcpServers": {
     "strapi": {
       "command": "npx",
-      "args": ["-y", "@bschauer/strapi-mcp-server"]
+      "args": ["-y", "@bschauer/strapi-mcp-server"],
+      "env": {
+        "API_URL": "http://localhost:1337",
+        "JWT": "your-jwt-token"
+      }
     }
   }
 }
@@ -34,13 +38,9 @@ Create a configuration file at `~/.mcp/strapi-mcp-server.config.json`:
 
 ```json
 {
-  "grow": {
+  "myserver": {
     "api_url": "http://localhost:1337",
-    "api_key": "your-jwt-token"
-  },
-  "production": {
-    "api_url": "https://api.example.com",
-    "api_key": "your-production-jwt-token"
+    "api_key": "your-jwt-token-from-strapi-admin"
   }
 }
 ```
@@ -66,12 +66,12 @@ strapi_list_servers();
 ```javascript
 // Get all content types from a specific server
 strapi_get_content_types({
-  server: "grow",
+  server: "myserver",
 });
 
 // Get components
 strapi_get_components({
-  server: "grow",
+  server: "myserver",
 });
 ```
 
@@ -80,7 +80,7 @@ strapi_get_components({
 ```javascript
 // Query content
 strapi_rest({
-  server: "grow",
+  server: "myserver",
   endpoint: "api/articles",
   method: "GET",
   params: { populate: "*" },
@@ -92,7 +92,7 @@ strapi_rest({
 ```javascript
 // Upload image
 strapi_upload_media({
-  server: "grow",
+  server: "myserver",
   url: "https://example.com/image.jpg",
   format: "webp",
   quality: 80,
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@bschauer/strapi-mcp-server",
-    "version": "1.0.1",
+    "version": "2.0.0",
     "description": "Model Context Protocol server implementation for Strapi CMS",
     "type": "module",
     "bin": {
diff --git a/src/index.ts b/src/index.ts
@@ -24,6 +24,10 @@ let config: Record<string, { api_url: string, api_key: string }>;
 try {
     const configContent = readFileSync(CONFIG_PATH, 'utf-8');
     config = JSON.parse(configContent);
+
+    if (Object.keys(config).length === 0) {
+        throw new Error('Config file exists but is empty');
+    }
 } catch (error) {
     console.error('Error reading config file:', error);
     config = {};
@@ -45,9 +49,44 @@ const server = new Server(
 
 // Helper function to get server config
 function getServerConfig(serverName: string): { API_URL: string, JWT: string } {
+    if (Object.keys(config).length === 0) {
+        const exampleConfig = {
+            "myserver": {
+                "api_url": "http://localhost:1337",
+                "api_key": "your-jwt-token-from-strapi-admin"
+            }
+        };
+
+        throw new Error(
+            `No server configuration found!\n\n` +
+            `Please create a configuration file at:\n` +
+            `${CONFIG_PATH}\n\n` +
+            `Example configuration:\n` +
+            `${JSON.stringify(exampleConfig, null, 2)}\n\n` +
+            `Steps to set up:\n` +
+            `1. Create the .mcp directory: mkdir -p ~/.mcp\n` +
+            `2. Create the config file: touch ~/.mcp/strapi-mcp-server.config.json\n` +
+            `3. Add your server configuration using the example above\n` +
+            `4. Get your JWT token from Strapi Admin Panel > Settings > API Tokens\n` +
+            `5. Make sure the file permissions are secure: chmod 600 ~/.mcp/strapi-mcp-server.config.json`
+        );
+    }
+
     const serverConfig = config[serverName];
     if (!serverConfig) {
-        throw new Error(`Server "${serverName}" not found in config. Available servers: ${Object.keys(config).join(', ')}`);
+        throw new Error(
+            `Server "${serverName}" not found in config.\n\n` +
+            `Available servers: ${Object.keys(config).join(', ')}\n\n` +
+            `To add a new server, edit:\n` +
+            `${CONFIG_PATH}\n\n` +
+            `Example configuration:\n` +
+            `{\n` +
+            `  "${serverName}": {\n` +
+            `    "api_url": "http://localhost:1337",\n` +
+            `    "api_key": "your-jwt-token-from-strapi-admin"\n` +
+            `  }\n` +
+            `}`
+        );
     }
     return {
         API_URL: serverConfig.api_url,
@@ -615,6 +654,38 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
 
     try {
         if (name === "strapi_list_servers") {
+            if (Object.keys(config).length === 0) {
+                const exampleConfig = {
+                    "myserver": {
+                        "api_url": "http://localhost:1337",
+                        "api_key": "your-jwt-token-from-strapi-admin"
+                    }
+                };
+
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: JSON.stringify({
+                                error: "No servers configured",
+                                help: {
+                                    message: "No server configuration found. Please create a configuration file.",
+                                    config_path: CONFIG_PATH,
+                                    example_config: exampleConfig,
+                                    setup_steps: [
+                                        "Create the .mcp directory: mkdir -p ~/.mcp",
+                                        "Create the config file: touch ~/.mcp/strapi-mcp-server.config.json",
+                                        "Add your server configuration using the example above",
+                                        "Get your JWT token from Strapi Admin Panel > Settings > API Tokens",
+                                        "Make sure the file permissions are secure: chmod 600 ~/.mcp/strapi-mcp-server.config.json"
+                                    ]
+                                }
+                            }, null, 2),
+                        },
+                    ],
+                };
+            }
+
             const servers = Object.keys(config).map(serverName => ({
                 name: serverName,
                 api_url: config[serverName].api_url
@@ -624,7 +695,11 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                 content: [
                     {
                         type: "text",
-                        text: JSON.stringify({ servers }, null, 2),
+                        text: JSON.stringify({
+                            servers,
+                            config_path: CONFIG_PATH,
+                            help: "To add more servers, edit the configuration file at the path shown above."
+                        }, null, 2),
                     },
                 ],
             };

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@bschauer/strapi-mcp-server",`
`3`		`- "version": "1.0.1",`
	`3`	`+ "version": "2.0.0",`
`4`	`4`	`"description": "Model Context Protocol server implementation for Strapi CMS",`
`5`	`5`	`"type": "module",`
`6`	`6`	`"bin": {`