Content
AI agent that organizes scattered materials (web links, PDFs, chat logs, text) into notes in your Obsidian vault and indexes them in Notion if desired.
**[English](./README.en.md)**
> 📘 **New to Wikimate?** Follow the [beginner's guide](./GUIDE.en.md) ([PDF](./GUIDE.en.pdf)) for a step-by-step tutorial.
> Status: **v0.7.1** — Organization, search, vault health check, task log, and **automatic vault detection** (5 MCP tools) are working as expected. Notion indexing works in environments with the Notion tool connected.
> 📱 **System requirements:** Wikimate is exclusive to **Windows PCs (desktop and laptop)** and does not support smartphones or tablets.
## What can Wikimate do?
- 🧹 **Natural language organization** — Just say "Organize this" and a note will be created. (If auto-activation doesn't work, use **`/wikimate <link>`** slash command.)
- 🧭 **Automatic vault detection (v0.7.1)** — Wikimate finds registered vaults and suggests organizing materials there.
- 📒 **Direct organization to your Obsidian vault** — Uses installed Obsidian tools (MCP/CLI) and falls back to file-based organization if not found.
- 🗂️ **Notion indexing (optional)** — Adds an index row if the Notion tool is connected (Obsidian as the original, Notion as a one-way index).
- ✋ **Always plans first → executes after approval** — No unauthorized actions.
- 🔁 **Duplicate blocking** — Only one entry per `source_hash`.
- 🛡️ **Safe design** — Blocks paths outside the vault, treats external text as data, not commands (prompt injection defense).
- 🔎 **Querying** — Ask "Find ~ in my vault" and get answers with sources from organized notes.
- 🩺 **Vault health check** — Finds and reports duplicate, broken `[[links]]`, orphan notes, and missing frontmatter, and suggests fixes.
- 🧾 **Task log** — Automatically records actions taken in your vault.
## 30-second terminology beginners)
| Term explanation |
|---|---|
Plugin** | Additional for a program (like app installation) |
| **** | App store for| **MCP / MCP tool** | Interface between AI and tools / functional button for |
| **Vault Collection folder for notes in Obsidian (has a name) |
| **dry-run** | Previewing plans before execution |
## Installation (Claude Code)
> ⚠️ Enter the **two commands separately**. (Copying and pasting them together may cause URL corruption.)
**1) Add marketplace** — Enter "added":
```
/plugin marketplace add https.com/sodam-ai/SoDam-W.git
```
**2) Install plugin** —1) is complete:
```
/plugin install wikimate@-marketplace
```
Restart to complete installation.
## Usage
Just talk to Wik> "Organize into my 'Vault'> ⭐ **Recommended Natural language "Organ" may not always auto-activate. Use **`/ <link/text>`** slash command for 100%- 📎 ** be anything** — A text, a web or a file path. needed.
- 🧭 **Vault name not required0.7.1)** — Wikimate finds registered vaults and suggests organization.
## Environment variables (optional)
| Variable | Purpose |
|---|---|
| `OBSIDIAN_VAULT_PATH` | Absolute path to vault folder (for and duplicate checking) |
| `OBSIDIAN_V_NAME` | Name of vault registered in Obsidian () |
| `NOTSEARCH_DB_ID` Notion index DB ( set, search or |
## Folder structure.claude-plugin/ manifest
mcp/server.mjs Independent MCPstdio) — (collect, lint, fix, runlog, vaults)
mcp/lib/collect.mjs Collection (safe naming, duplicate blocking)
mcp/lib/lint.mjs Health check (read-only)
mcp/lib/fix.mjs Safe modification (no deletion, backup)
mcp/lib/runlog.mjs Task log
skills/ Natural language auto-activation skills (organize, query, lint)
commands/ /wikimate and /wikimate-lint commands
adapters/codex/ Codex setup guide
templates/ Note templates
scripts/ Verification scripts (verify-* and smoke-*)
(.wikimate/runlog.jsonl) Task log (hidden)
```
## Safety and security
- ✅ **Approval required for writing**. (Default `dry_run` shows plans first.)
- ✅ **Path sanitization** and blocking of vault-external paths.
- ✅ **External data treated as data, not commands** (prompt injection defense).
- ✅ **No modification of Obsidian's `.obsidian/` folder**.
- ✅ **Task logging** — Records actions in `.wikimate/runlog.jsonl` (hidden).
## Current status
- ✅ **Obsidian organization**: Confirmed to create notes in actual vaults (including natural language auto-activation).
- ✅ **Health check, safe modification, and task log**: Verified with unit tests and end-to-end server protocol testing.
- 🟡 **Notion indexing**: Works in environments with connected Notion tools.
- ⚠️ **Live session not verified**: User environment testing recommended.
## Troubleshooting
- **Organization fails** → Use **`/wikimate <link>`** slash command for 100% activation.
- **`marketplace not found`** → Re-register marketplace.
- **`/mcp` not shown** → Restart Claude Code.
## Related tools
[notesmd-cli](https://github.com/Yakitrak/notesmd-cli) · [mcp-obsidian](https://github.com/MarkusPfundstein/mcp-obsidian) · [notion-mcp-server](https://github.com/makenotion/notion-mcp-server) · [ntn CLI](https://developers.notion.com/cli/get-started/overview)
## License, copyright, and commercial use
> ⚖️ This is a general guide and **not legal advice.** Refer to `LICENSE` and `NOTICE` for precise terms.
- **Wikimate: Apache License 2.0** 2026 SoDam AI Studio.
- **External tools not bundled** — Each has its own license.
