@spacholski1225/anki-connect-mcp 1.0.1 → 1.0.2

package/README.md

@@ -100,16 +100,39 @@ To use this MCP server with Claude Desktop, add the following configuration to y
 - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
 - **Linux**: `~/.config/Claude/claude_desktop_config.json`
 
-**Configuration:**
+**Configuration Options:**
+
+#### Option 1: Using Node.js (Local Installation)
 ```json
 {
   "mcpServers": {
     "anki-connect": {
       "command": "node",
       "args": [
-        "dist/index.js"
+        "C:\\Sources\\anki-connect-mcp\\dist\\index.js"
+      ],
+      "env": {},
+      "disabled": false,
+      "alwaysAllow": [
+        "deck_names",
+        "cards_info",
+        "deck_names_and_ids",
+        "gui_deck_browser"
+      ]
+    }
+  }
+}
+```
+
+#### Option 2: Using npx (NPM Package)
+```json
+{
+  "mcpServers": {
+    "anki-connect": {
+      "command": "npx",
+      "args": [
+        "@spacholski1225/anki-connect-mcp"
       ],
-      "cwd": "/path/to/your/mcp-server",
       "env": {},
       "disabled": false,
       "alwaysAllow": [
@@ -123,10 +146,68 @@ To use this MCP server with Claude Desktop, add the following configuration to y
 }
 ```
 
+#### Option 3: Using Docker
+```json
+{
+  "mcpServers": {
+    "anki-connect": {
+      "command": "docker",
+      "args": [
+        "run",
+        "--rm",
+        "-i",
+        "--network=host",
+        "-e", "ANKI_CONNECT_URL=http://host.docker.internal:8765",
+        "spacholski/anki-connect-mcp:latest"
+      ],
+      "env": {},
+      "disabled": false,
+      "alwaysAllow": [
+        "deck_names",
+        "cards_info",
+        "deck_names_and_ids",
+        "gui_deck_browser"
+      ]
+    }
+  }
+}
+```
+
+**Docker-Specific AnkiConnect Configuration:**
+
+When using the Docker option, you **must** configure AnkiConnect with specific settings to allow Docker container access:
+
+1. Go to **Tools** → **Add-ons** in Anki
+2. Select **AnkiConnect** and click **Config**
+3. Update the configuration with the following settings:
+
+```json
+{
+    "apiKey": null,
+    "apiLogPath": null,
+    "ignoreOriginList": [],
+    "webBindAddress": "0.0.0.0",
+    "webBindPort": 8765,
+    "webCorsOriginList": [
+        "http://localhost",
+        "http://host.docker.internal",
+        "http://host.docker.internal:3000"
+    ]
+}
+```
+
+**Key Docker Configuration Points:**
+- **`webBindAddress: "0.0.0.0"`** - Allows AnkiConnect to accept connections from any IP address (required for Docker containers)
+- **`webCorsOriginList`** - Must include `"http://host.docker.internal"` and related origins to allow cross-origin requests from Docker containers
+- Restart Anki after making these configuration changes
+
 **Important Notes:**
-- Replace `/path/to/your/mcp-server` with the actual path to your cloned repository
+- **For Node.js option**: Replace the path in `args` with the actual path to your built `index.js` file
+- **For npx option**: Uses the published NPM package `@spacholski1225/anki-connect-mcp` - no local installation required
+- **For Docker option**: Uses the pre-built Docker image `spacholski/anki-connect-mcp:latest`
 - The `alwaysAllow` array contains tools that won't require confirmation each time
 - Make sure Anki is running with AnkiConnect enabled before using the MCP server
+- For Docker option, the `--network=host` flag allows the container to access AnkiConnect on the host machine
 
 ### Other MCP Clients
 
@@ -170,6 +251,45 @@ src/
 - `npm start` - Run the compiled MCP server
 - `npm test` - Run tests (not implemented yet)
 
+## Docker Deployment
+
+### Building and Running with Docker
+
+1. **Build the Docker image**:
+```bash
+docker build -t anki-connect-mcp .
+```
+
+2. **Run with default settings** (connects to AnkiConnect on localhost:8765):
+```bash
+docker run -d --name anki-connect-mcp anki-connect-mcp
+```
+
+3. **Run with custom AnkiConnect URL**:
+```bash
+docker run -d --name anki-connect-mcp -e ANKI_CONNECT_URL=http://custom-host:8765 anki-connect-mcp
+```
+
+### Using Docker Compose
+
+1. **Start the service**:
+```bash
+docker-compose up -d
+```
+
+2. **Stop the service**:
+```bash
+docker-compose down
+```
+
+### Environment Variables
+
+- `ANKI_CONNECT_URL`: The URL where AnkiConnect is running (default: `http://localhost:8765`)
+
+### Docker Configuration for MCP Clients
+
+When using Docker, update your MCP client configuration to use the containerized version. The exact configuration depends on your setup, but you may need to adjust network settings to allow the MCP client to communicate with the Docker container.
+
 ## Troubleshooting
 
 ### Common Issues

package/dist/methods/anki.js

@@ -1,5 +1,6 @@
 import axios from 'axios';
-const BASE_URL = 'http://localhost:8765';
+// Use environment variable with fallback to default
+const BASE_URL = process.env.ANKI_CONNECT_URL || 'http://localhost:8765';
 const api = axios.create({
     baseURL: BASE_URL,
     timeout: 5000,
@@ -10,13 +11,9 @@ const api = axios.create({
 export async function callAnkiConnect(request) {
     try {
         const response = await api.post('/', request);
-        console.log('Request:', request);
-        console.log('===RESPONSE===');
-        console.log(response.data);
         return response.data;
     }
     catch (error) {
-        console.log('Anki Connect Error:', error);
         throw error;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spacholski1225/anki-connect-mcp",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "MCP server for Anki Connect integration",
   "main": "dist/index.js",
   "bin": {
@@ -15,7 +15,12 @@
     "type": "git",
     "url": "git+https://github.com/spacholski1225/anki-connect-mcp.git"
   },
-  "keywords": ["mcp", "anki", "server", "connect"],
+  "keywords": [
+    "mcp",
+    "anki",
+    "server",
+    "connect"
+  ],
   "author": "spacholski1225",
   "license": "MIT",
   "type": "module",