diff --git a/README.md b/README.md index b5dea96..972dd3d 100644 --- a/README.md +++ b/README.md @@ -91,11 +91,13 @@ claude mcp add appwrite-mcp-server "C:\Users\moh12\app-write-mcp\dist\index.js" #### Option B: Cursor IDE Integration -1. **Open Cursor Settings** (Ctrl/Cmd + ,) +> 💡 **Note:** Cursor doesn't support `.env` files for MCP servers, so we pass environment variables directly in the configuration. -2. **Search for "MCP"** in the settings search bar +1. **Open Command Palette** (`Ctrl/Cmd + Shift + P`) -3. **Add MCP Server Configuration:** +2. **Type "Preferences: Open Settings (JSON)"** + +3. **Add MCP Server Configuration to your settings.json:** ```json { "mcp.servers": { @@ -103,19 +105,39 @@ claude mcp add appwrite-mcp-server "C:\Users\moh12\app-write-mcp\dist\index.js" "command": "node", "args": ["C:\\path\\to\\your\\app-write-mcp\\dist\\index.js"], "env": { - "NODE_ENV": "production" + "APPWRITE_PROJECT_ID": "your-project-id-here", + "APPWRITE_API_ENDPOINT": "https://cloud.appwrite.io/v1", + "APPWRITE_API_KEY": "your-api-key-here" } } } } ``` -4. **Alternative: Use Cursor's settings.json file:** - - Open Command Palette (`Ctrl/Cmd + Shift + P`) - - Type "Preferences: Open Settings (JSON)" - - Add the MCP configuration above +4. **Replace the configuration values:** + - **Path**: Update `C:\\path\\to\\your\\app-write-mcp\\dist\\index.js` with your actual path + - **Project ID**: Your Appwrite project ID + - **API Endpoint**: Your Appwrite endpoint (Cloud or self-hosted) + - **API Key**: Your Appwrite API key with required permissions -5. **Restart Cursor** to load the MCP server +5. **Example configuration:** + ```json + { + "mcp.servers": { + "appwrite-mcp-server": { + "command": "node", + "args": ["C:\\Users\\username\\app-write-mcp\\dist\\index.js"], + "env": { + "APPWRITE_PROJECT_ID": "6612345a000818bb9d2e", + "APPWRITE_API_ENDPOINT": "https://cloud.appwrite.io/v1", + "APPWRITE_API_KEY": "standard_1234567890abcdef..." + } + } + } + } + ``` + +6. **Save the file and restart Cursor** to load the MCP server #### Option C: Continue.dev Integration @@ -128,13 +150,20 @@ claude mcp add appwrite-mcp-server "C:\Users\moh12\app-write-mcp\dist\index.js" { "name": "appwrite-mcp-server", "command": "node", - "args": ["C:\\path\\to\\your\\app-write-mcp\\dist\\index.js"] + "args": ["C:\\path\\to\\your\\app-write-mcp\\dist\\index.js"], + "env": { + "APPWRITE_PROJECT_ID": "your-project-id-here", + "APPWRITE_API_ENDPOINT": "https://cloud.appwrite.io/v1", + "APPWRITE_API_KEY": "your-api-key-here" + } } ] } ``` -3. **Restart your IDE** to apply the changes +3. **Replace with your actual credentials** (same as Cursor configuration above) + +4. **Restart your IDE** to apply the changes ### 4️⃣ Verification