Metadata-Version: 2.4
Name: obsidianki-mcp
Version: 0.1.0
Summary: MCP server for generating flashcards using obsidianki
Author-email: ccmdi <ccmdi.dev@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/ccmdi/obsidianki-mcp
Project-URL: Repository, https://github.com/ccmdi/obsidianki-mcp
Project-URL: Issues, https://github.com/ccmdi/obsidianki-mcp/issues
Keywords: mcp,obsidian,anki,flashcards,spaced-repetition
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: mcp[cli]>=1.16.0

# Obsidianki MCP Server

MCP server for generating flashcards using [obsidianki](https://github.com/ccmdi/obsidianki).

## Prerequisites

- [uv](https://docs.astral.sh/uv/getting-started/installation/)
- [obsidianki](https://github.com/ccmdi/obsidianki) installed and available in PATH, >= 0.7

## Installation

Add to your Claude Desktop config file:

**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

```json
{
  "mcpServers": {
    "obsidianki-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/ccmdi/obsidianki-mcp",
        "obsidianki-mcp"
      ]
    }
  }
}
```

## Usage

The server provides one tool: `generate_flashcards`

### Parameters

- `notes` (optional): List of note patterns to process
  - Examples: `["frontend/*"]`, `["docs/*.md:3"]`
  - Supports glob patterns with optional sampling using `:N` suffix
- `cards` (optional): Number of flashcards to generate (recommend 3-6)
- `query` (optional): Query/topic for generating content from chat
- `deck` (optional): Deck name (defaults to your default deck)
- `use_schema` (optional): Use existing cards from deck to match format
