Kani MCP Server
Read-only access to WaniKani progress and study data through MCP.
التثبيت
أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: .cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).
kani-mcp-serverclaude mcp add kani-mcp-server -e 'WANIKANI_API_TOKEN=<your wanikani_api_token>' -e 'WANIKANI_API_BASE_URL=https://api.wanikani.com/v2' -- npx -y kani-mcp-server@0.1.4
{
"mcpServers": {
"kani-mcp-server": {
"command": "npx",
"args": [
"-y",
"kani-mcp-server@0.1.4"
],
"env": {
"WANIKANI_API_TOKEN": "<your wanikani_api_token>",
"WANIKANI_API_BASE_URL": "https://api.wanikani.com/v2"
}
}
}
}
متغيرات البيئة
WANIKANI_API_TOKENإلزامي سري Read-only WaniKani API v2 personal access tokenWANIKANI_API_BASE_URLWaniKani API v2 base URL
التوثيق
مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.
المحتويات
Kani MCP Server
A small, read-only Model Context Protocol server that gives MCP clients access to a user's WaniKani progress and WaniKani reference data through the official API v2.
It can answer questions such as:
- What reviews and lessons are coming up today?
- Which kanji are assigned at a given level?
- Which subjects have the lowest review accuracy?
- What notes or synonyms have I saved?
The server runs locally over stdio. It does not store data, expose an HTTP service, or modify WaniKani.
Requirements
- Node.js 18 or newer
- A WaniKani personal access token with read-only permissions, created in WaniKani API Tokens
Keep the token secret. It grants access to account and study data.
Install
The simplest MCP configuration runs the published package directly with npx:
{
"mcpServers": {
"wanikani": {
"command": "npx",
"args": ["-y", "kani-mcp-server@latest"],
"env": {
"WANIKANI_API_TOKEN": "your-read-only-token"
}
}
}
}
Alternatively, install the executable globally:
npm install --global kani-mcp-server
kani-mcp-server
Restart the MCP client after changing its configuration. Prefer the client's secure secret facility, when available, over writing a token into a JSON file.
Run from source
git clone https://github.com/Alexxanddr/kani-mcp-server.git
cd kani-mcp-server
npm ci
cp .env.example .env
# Edit .env and set WANIKANI_API_TOKEN.
npm run build
node --env-file=.env dist/index.js
To configure an MCP client against a source checkout, replace the path and token:
{
"mcpServers": {
"wanikani": {
"command": "node",
"args": ["/absolute/path/to/kani-mcp-server/dist/index.js"],
"env": {
"WANIKANI_API_TOKEN": "your-read-only-token"
}
}
}
}
The process communicates via MCP on stdin/stdout, so an empty terminal after startup is normal.
Tools
| Tool | Purpose |
|---|---|
get_user | User profile, level, preferences, and subscription state |
get_summary | Lessons and reviews available during the next 24 hours |
list_assignments | Assignments filtered by subjects, levels, SRS stages, or state |
list_subjects | Radicals, kanji, vocabulary, and kana vocabulary |
list_review_statistics | Accuracy and incorrect-answer totals by subject |
list_reviews | Completed review history |
list_study_materials | Personal notes and meaning/reading synonyms |
list_level_progressions | Level progression history |
list_resets | Account reset history |
list_spaced_repetition_systems | SRS stage definitions |
list_voice_actors | Pronunciation voice actor metadata |
get_resource | One supported resource by type and numeric ID |
Collection tools return one API page. Use page_after_id or page_before_id from the WaniKani collection pagination data to continue. Arrays are sent as the comma-delimited filters expected by the API.
Example prompts:
Show my WaniKani level and the reviews due in the next 24 hours.
List my level 10 kanji assignments and explain their current SRS stages.
Find review statistics below 70%, then fetch the matching subjects.
See MCP contracts for exact inputs and outputs.
Configuration
| Variable | Required | Meaning |
|---|---|---|
WANIKANI_API_TOKEN | Yes | Personal WaniKani API v2 bearer token |
WANIKANI_API_BASE_URL | No | API root; defaults to https://api.wanikani.com/v2 |
Changing the base URL sends the bearer token to that host. Remote overrides must use HTTPS; localhost HTTP is accepted for tests and local development.
Development
npm ci
npm run check
npm pack --dry-run
npm run dev: run TypeScript directly over stdionpm test: run unit and MCP contract testsnpm run type-check: check TypeScript without emitting filesnpm run build: create the bundled executable indist/
Read CONTRIBUTING.md, architecture, and testing before changing public tools.
Troubleshooting
WANIKANI_API_TOKEN is required: pass the variable in the MCP client'senvblock or start Node with--env-file=.env.- 401 Unauthorized: verify the token and recreate it if it may have been exposed.
- 429 Too Many Requests: wait for WaniKani's rate-limit reset and request narrower collections.
- Large responses: add filters and paginate rather than requesting broad subject or review histories.
- Client shows disconnected: use an absolute script path, run
npm run build, and confirm Node 18+ is on the client's PATH.
Limitations
- Read-only: starting assignments, submitting reviews, changing user settings, and editing study materials are intentionally absent.
- No automatic multi-page aggregation, caching, resources, or prompts.
- API response objects are passed through unchanged, so upstream additions appear without a package release.
License and distribution
This project is available under the MIT License and is packaged for the public npm registry as kani-mcp-server. GitHub releases publish matching package versions through npm Trusted Publishing; see publishing for the one-time setup and release procedure.
WaniKani is a trademark of Tofugu LLC. This independent project is not affiliated with, endorsed by, or sponsored by WaniKani or Tofugu.
الأسئلة الشائعة
ما هو Kani MCP Server؟
Read-only access to WaniKani progress and study data through MCP.
كيف أثبّت Kani MCP Server؟
يعمل على جهازك. في Claude Code: claude mcp add kani-mcp-server -e 'WANIKANI_API_TOKEN=<your wanikani_api_token>' -e 'WANIKANI_API_BASE_URL=https://api.wanikani.com/v2' -- npx -y kani-mcp-server@0.1.4. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.
هل يحتاج Kani MCP Server إلى مفتاح API؟
نعم. يتطلب WANIKANI_API_TOKEN، وتضبطها في إعداداته.
هل Kani MCP Server مفتوح المصدر؟
نعم. شيفرته متاحة على GitHub بترخيص MIT.
من يصون Kani MCP Server؟
ينشره Alexxanddr. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.
من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.