@spacholski1225/anki-connect-mcp 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -75
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -125,6 +125,8 @@ To use this MCP server with Claude Desktop, add the following configuration to y
|
|
|
125
125
|
```
|
|
126
126
|
|
|
127
127
|
#### Option 2: Using npx (NPM Package)
|
|
128
|
+
|
|
129
|
+
**Then configure your MCP client:**
|
|
128
130
|
```json
|
|
129
131
|
{
|
|
130
132
|
"mcpServers": {
|
|
@@ -209,13 +211,6 @@ When using the Docker option, you **must** configure AnkiConnect with specific s
|
|
|
209
211
|
- Make sure Anki is running with AnkiConnect enabled before using the MCP server
|
|
210
212
|
- For Docker option, the `--network=host` flag allows the container to access AnkiConnect on the host machine
|
|
211
213
|
|
|
212
|
-
### Other MCP Clients
|
|
213
|
-
|
|
214
|
-
For other MCP clients, use the following connection details:
|
|
215
|
-
- **Transport**: stdio
|
|
216
|
-
- **Command**: `node dist/index.js`
|
|
217
|
-
- **Working Directory**: Path to this repository
|
|
218
|
-
|
|
219
214
|
## Usage Examples
|
|
220
215
|
|
|
221
216
|
Once configured with an MCP client like Claude Desktop, you can interact with your Anki collection naturally:
|
|
@@ -226,70 +221,6 @@ Once configured with an MCP client like Claude Desktop, you can interact with yo
|
|
|
226
221
|
- *"Suspend all cards in the 'Difficult Words' deck"*
|
|
227
222
|
- *"Open the deck browser in Anki"*
|
|
228
223
|
|
|
229
|
-
## Development
|
|
230
|
-
|
|
231
|
-
### Project Structure
|
|
232
|
-
|
|
233
|
-
```
|
|
234
|
-
src/
|
|
235
|
-
├── index.ts # Main MCP server setup and tool definitions
|
|
236
|
-
├── methods/
|
|
237
|
-
│ └── anki.ts # AnkiConnect API communication
|
|
238
|
-
├── tools/ # Tool implementations
|
|
239
|
-
│ ├── cards.ts # Card-related operations
|
|
240
|
-
│ ├── decks.ts # Deck management
|
|
241
|
-
│ ├── misc.ts # Utility functions and GUI controls
|
|
242
|
-
│ ├── models.ts # Note type operations
|
|
243
|
-
│ └── notes.ts # Note management
|
|
244
|
-
└── types/ # TypeScript type definitions
|
|
245
|
-
└── anki/ # AnkiConnect API types
|
|
246
|
-
```
|
|
247
|
-
|
|
248
|
-
### Available Scripts
|
|
249
|
-
|
|
250
|
-
- `npm run build` - Compile TypeScript to JavaScript
|
|
251
|
-
- `npm start` - Run the compiled MCP server
|
|
252
|
-
- `npm test` - Run tests (not implemented yet)
|
|
253
|
-
|
|
254
|
-
## Docker Deployment
|
|
255
|
-
|
|
256
|
-
### Building and Running with Docker
|
|
257
|
-
|
|
258
|
-
1. **Build the Docker image**:
|
|
259
|
-
```bash
|
|
260
|
-
docker build -t anki-connect-mcp .
|
|
261
|
-
```
|
|
262
|
-
|
|
263
|
-
2. **Run with default settings** (connects to AnkiConnect on localhost:8765):
|
|
264
|
-
```bash
|
|
265
|
-
docker run -d --name anki-connect-mcp anki-connect-mcp
|
|
266
|
-
```
|
|
267
|
-
|
|
268
|
-
3. **Run with custom AnkiConnect URL**:
|
|
269
|
-
```bash
|
|
270
|
-
docker run -d --name anki-connect-mcp -e ANKI_CONNECT_URL=http://custom-host:8765 anki-connect-mcp
|
|
271
|
-
```
|
|
272
|
-
|
|
273
|
-
### Using Docker Compose
|
|
274
|
-
|
|
275
|
-
1. **Start the service**:
|
|
276
|
-
```bash
|
|
277
|
-
docker-compose up -d
|
|
278
|
-
```
|
|
279
|
-
|
|
280
|
-
2. **Stop the service**:
|
|
281
|
-
```bash
|
|
282
|
-
docker-compose down
|
|
283
|
-
```
|
|
284
|
-
|
|
285
|
-
### Environment Variables
|
|
286
|
-
|
|
287
|
-
- `ANKI_CONNECT_URL`: The URL where AnkiConnect is running (default: `http://localhost:8765`)
|
|
288
|
-
|
|
289
|
-
### Docker Configuration for MCP Clients
|
|
290
|
-
|
|
291
|
-
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.
|
|
292
|
-
|
|
293
224
|
## Troubleshooting
|
|
294
225
|
|
|
295
226
|
### Common Issues
|
|
@@ -299,10 +230,6 @@ When using Docker, update your MCP client configuration to use the containerized
|
|
|
299
230
|
3. **Permission errors**: Ensure the MCP server has proper file system permissions
|
|
300
231
|
4. **Tool not found**: Verify the MCP client configuration and restart the client
|
|
301
232
|
|
|
302
|
-
### Debug Mode
|
|
303
|
-
|
|
304
|
-
To enable debug logging, check the console output when running the MCP server. All AnkiConnect requests and responses are logged for troubleshooting.
|
|
305
|
-
|
|
306
233
|
## Contributing
|
|
307
234
|
|
|
308
235
|
Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spacholski1225/anki-connect-mcp",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.5",
|
|
4
4
|
"description": "MCP server for Anki Connect integration",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"bin": {
|
|
@@ -43,6 +43,7 @@
|
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
45
|
"@modelcontextprotocol/sdk": "^1.12.1",
|
|
46
|
+
"@spacholski1225/anki-connect-mcp": "^1.0.4",
|
|
46
47
|
"axios": "^1.9.0"
|
|
47
48
|
}
|
|
48
49
|
}
|