@dfinity/caffeine-mcp-server - npm Package Compare versions

Comparing version 0.0.9 to 0.0.10

package.json

 {
   "name": "@dfinity/caffeine-mcp-server",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "MCP server for Caffeine AI tools",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -14,10 +14,54 @@ # @dfinity/caffeine-mcp-server
 
+## Configuration [BETA]
+
+### 1. Get invitation code to [Caffeine AI](https://beta.caffeine.ai/)
+
+### 2. Generating your API Key [here](https://beta.caffeine.ai/api_keys)
+
+### 3.1. MCP Server setup - Automatic (Cline)
+
+Modify your API Provider in Cline's settings.
+
+- `API Provider: OpenAI Compatible`
+- `Base URL: https://beta.caffeine.ai`
+- `API Key: {your_api_key}`
+- `Model ID: NA`
+
+### 3.2. MCP Server setup - Manual (Cline or Claude Desktop)
+Add this to your `cline_mcp_settings.json` or `claude_desktop_config.json`:
+```json
+{
+  "mcpServers": {
+    "@dfinity/caffeine-mcp-server": {
+      "command": "npx",
+      "args": [
+        "@dfinity/caffeine-mcp-server"
+      ],
+      "env": {
+        "CAFFEINE_API_KEY": "{your_api_key}",
+        "CAFFEINE_BASE_URL": "https://beta.caffeine.ai"
+      },
+      "autoApprove": [
+        "deploy",
+        "get_projects",
+        "get_project_metadata"
+      ]
+    }
+  }
+}
+```
+
 ## Available Tools
 
 ### create_project
-Create a new project with an initial prompt. The workspace folder must be empty.
+Create a new project with an initial prompt. The workspace folder handling depends on its current state:
 
+1. Empty folder: Uses the current workspace directly
+2. Caffeine project: Creates a sibling folder (requires folderName)
+3. Non-empty folder: Creates a subfolder (requires folderName)
+
 Inputs:
-- workspaceFolder (string, required): The root folder of the local copy of the caffeine project. The folder must contain a caffeine.json file with a projectId.
+- workspaceFolder (string, required): The root folder where the project will be created
 - initialPrompt (string, required): The initial prompt to create the project with
+- folderName (string, optional): Name for the new project folder (required if workspace is not empty)
 
@@ -31,2 +75,7 @@ Response:
 
+Important Notes:
+- If the workspace is not empty or contains a Caffeine project, you must provide a folderName
+- For Caffeine projects, the new folder is created next to the current workspace
+- For non-empty folders, the new folder is created inside the current workspace
+
 ### deploy
@@ -68,9 +117,19 @@ Deploy the project to a public domain (lasts 45 minutes)
 ### download
-Download a project into a new folder.
+Download a project. The workspace folder handling follows the same rules as create_project:
 
+1. Empty folder: Uses the current workspace directly
+2. Caffeine project: Creates a sibling folder (requires folderName)
+3. Non-empty folder: Creates a subfolder (requires folderName)
+
 Inputs:
 - projectId (string, required): The ID of the project to download
 - workspaceFolder (string, required): The target folder where the project will be downloaded
+- folderName (string, optional): Name for the new project folder (required if workspace is not empty)
 - clone (boolean, required): If true, creates a copy of the project before downloading. Must be true if the project is not owned by the user.
 
+Important Notes:
+- If the workspace is not empty or contains a Caffeine project, you must provide a folderName
+- For Caffeine projects, the new folder is created next to the current workspace
+- For non-empty folders, the new folder is created inside the current workspace
+
 ### get_project
@@ -183,30 +242,2 @@ Get full project details including files and the whole event log ("Initialize", "Prompt", "Deploy").
 
-## Configuration
-
-### 1. Generating your API Key [here](https://caffeine.ai/api_keys)
-
-### 2. Usage with Cline or Claude Desktop
-Add this to your `cline_mcp_settings.json` or `claude_desktop_config.json`:
-```json
-{
-  "mcpServers": {
-    "@dfinity/caffeine-mcp-server": {
-      "command": "npx",
-      "args": [
-        "@dfinity/caffeine-mcp-server"
-      ],
-      "env": {
-        "CAFFEINE_API_KEY": "{your_api_key}",
-        "CAFFEINE_BASE_URL": "https://caffeine.ai"
-      },
-      "autoApprove": [
-        "deploy",
-        "get_projects",
-        "get_project_metadata"
-      ]
-    }
-  }
-}
-```
-
 ## Development
@@ -213,0 +244,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1364470

0.4%

Lines of code

25565

0.3%

Number of lines in readme file

258

13.66%

No dependency changes