@spacholski1225/anki-connect-mcp 1.0.4 → 1.0.6

package/README.md

@@ -2,6 +2,8 @@
 
 A Model Context Protocol (MCP) server that provides seamless integration with Anki through the AnkiConnect add-on. This server enables AI assistants and other MCP clients to interact with your Anki flashcard collection programmatically.
 
+![Project](assets/anki-connect-mcp.gif)
+
 ## What is Anki Connect?
 
 [AnkiConnect](https://ankiweb.net/shared/info/2055492159) is a powerful Anki add-on that exposes Anki's functionality through a REST API. It allows external applications to:
@@ -22,35 +24,35 @@ The Model Context Protocol is a standardized way for AI assistants to connect to
 This MCP server provides comprehensive access to AnkiConnect functionality through the following tools:
 
 ### Flashcard Management
-- [`create_flashcard()`](src/index.ts:67) - Create new flashcards with front and back content
-- [`add_note()`](src/tools/notes.ts:22) - Add notes with custom fields and tags
-- [`add_notes()`](src/tools/notes.ts) - Bulk add multiple notes
-- [`update_note_fields()`](src/tools/notes.ts) - Update existing note fields
-- [`find_notes()`](src/tools/notes.ts) - Search for notes using Anki's query syntax
+- `create_flashcard()` - Create new flashcards with front and back content
+- `add_note()` - Add notes with custom fields and tags
+- `add_notes()` - Bulk add multiple notes
+- `update_note_fields()` - Update existing note fields
+- `find_notes()` - Search for notes using Anki's query syntax
 
 ### Deck Management
-- [`deck_names()`](src/tools/decks.ts:19) - Get all deck names
-- [`deck_names_and_ids()`](src/tools/decks.ts:30) - Get deck names with their IDs
-- [`change_deck()`](src/tools/decks.ts) - Move cards between decks
-- [`delete_decks()`](src/tools/decks.ts) - Delete decks and optionally their cards
-- [`get_deck_config()`](src/tools/decks.ts) - Retrieve deck configuration settings
+- `deck_names()` - Get all deck names
+- `deck_names_and_ids()` - Get deck names with their IDs
+- `change_deck()` - Move cards between decks
+- `delete_decks()` - Delete decks and optionally their cards
+- `get_deck_config()` - Retrieve deck configuration settings
 
 ### Card Operations
-- [`find_cards()`](src/tools/cards.ts) - Search for cards
-- [`cards_info()`](src/tools/cards.ts) - Get detailed card information
-- [`suspend()`](src/tools/cards.ts:18) / [`unsuspend()`](src/tools/cards.ts) - Suspend/unsuspend cards
-- [`are_suspended()`](src/tools/cards.ts) / [`are_due()`](src/tools/cards.ts) - Check card status
+- `find_cards()` - Search for cards
+- `cards_info()` - Get detailed card information
+- `suspend()` / `unsuspend()` - Suspend/unsuspend cards
+- `are_suspended()` / `are_due()` - Check card status
 
 ### GUI Control
-- [`gui_deck_browser()`](src/index.ts:177) - Open deck browser
-- [`gui_deck_review()`](src/index.ts:185) - Start deck review
-- [`gui_browse()`](src/index.ts:196) - Open card browser with search
-- [`gui_add_cards()`](src/index.ts:207) - Open add cards dialog
+- `gui_deck_browser()` - Open deck browser
+- `gui_deck_review()` - Start deck review
+- `gui_browse()` - Open card browser with search
+- `gui_add_cards()` - Open add cards dialog
 
 ### Utility Tools
-- [`version()`](src/index.ts:98) - Get AnkiConnect version
-- [`get_tags()`](src/index.ts:114) - Retrieve all tags
-- [`multi()`](src/index.ts:223) - Execute multiple AnkiConnect requests in batch
+- `version()` - Get AnkiConnect version
+- `get_tags()` - Retrieve all tags
+- `multi()` - Execute multiple AnkiConnect requests in batch
 
 ## Prerequisites
 
@@ -125,6 +127,8 @@ To use this MCP server with Claude Desktop, add the following configuration to y
 ```
 
 #### Option 2: Using npx (NPM Package)
+
+**Then configure your MCP client:**
 ```json
 {
   "mcpServers": {
@@ -209,13 +213,6 @@ When using the Docker option, you **must** configure AnkiConnect with specific s
 - 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
-
-For other MCP clients, use the following connection details:
-- **Transport**: stdio
-- **Command**: `node dist/index.js`
-- **Working Directory**: Path to this repository
-
 ## Usage Examples
 
 Once configured with an MCP client like Claude Desktop, you can interact with your Anki collection naturally:
@@ -226,70 +223,6 @@ Once configured with an MCP client like Claude Desktop, you can interact with yo
 - *"Suspend all cards in the 'Difficult Words' deck"*
 - *"Open the deck browser in Anki"*
 
-## Development
-
-### Project Structure
-
-```
-src/
-├── index.ts              # Main MCP server setup and tool definitions
-├── methods/
-│   └── anki.ts          # AnkiConnect API communication
-├── tools/               # Tool implementations
-│   ├── cards.ts         # Card-related operations
-│   ├── decks.ts         # Deck management
-│   ├── misc.ts          # Utility functions and GUI controls
-│   ├── models.ts        # Note type operations
-│   └── notes.ts         # Note management
-└── types/               # TypeScript type definitions
-    └── anki/            # AnkiConnect API types
-```
-
-### Available Scripts
-
-- `npm run build` - Compile TypeScript to JavaScript
-- `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
@@ -299,10 +232,6 @@ When using Docker, update your MCP client configuration to use the containerized
 3. **Permission errors**: Ensure the MCP server has proper file system permissions
 4. **Tool not found**: Verify the MCP client configuration and restart the client
 
-### Debug Mode
-
-To enable debug logging, check the console output when running the MCP server. All AnkiConnect requests and responses are logged for troubleshooting.
-
 ## Contributing
 
 Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spacholski1225/anki-connect-mcp",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "MCP server for Anki Connect integration",
   "main": "dist/index.js",
   "bin": {
@@ -43,6 +43,7 @@
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.12.1",
+    "@spacholski1225/anki-connect-mcp": "^1.0.4",
     "axios": "^1.9.0"
   }
 }