MXManage-Obsidian-MCP

# Tool List <p align="center"> <img src="assets/heading.png" alt="MXManage Obsidian MCP" width="100%"> </p> <p align="center"> <img src="https://img.shields.io/badge/MCP-Protocol-blue?style=for-the-badge" alt="MCP"> <img src="https://img.shields.io/badge/Obsidian-Vault-purple?style=for-the-badge" alt="Obsidian"> <img src="https://img.shields.io/badge/Git-Auto--Sync-orange?style=for-the-badge" alt="Git Sync"> <img src="https://img.shields.io/badge/Docker-Compatible-blue?style=for-the-badge" alt="Docker"> <img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge" alt="MIT"> </p> Obsidian MCP Service for Personal and Team Knowledge Base. This project deeply integrates AI clients with Git-hosted Obsidian repositories through the MCP protocol. AI writes and automatically executes Git synchronization (commit/push) to ensure your full-stack note library is updated and secure in real-time. ### Documentation Navigation - [**USAGE.md - Configuration, Authentication, and Client Access**](./USAGE.md) - [**DEPLOYMENT.md - Docker Deployment Details**](./DEPLOYMENT.md) ## Core Features - 📂 **Full Note Operations**: Read, write, create, delete, rename, support semantic patches and Diff modifications. - 🔍 **Intelligent Semantic Search**: Built-in fuzzy search rating and context fragment return, making AI understand your notes better. - 🧠 **RAG Context Skills**: Slice Markdown by title, return citable fragments, context packages, and knowledge graphs. - 🏷️ **Tag Automation System**: Full-library tag aggregation, statistics, merging, and renaming, eliminating tag chaos. - 🗓️ **Structured Workflow**: Automatically maintain daily journals, structurally record AI interactions and work summaries. - 🔄 **Git Automation Engine**: Native support for GitHub, GitLab, Gitee, write and backup immediately. - 🛡️ **Dual Operation Modes**: - **Stdio Mode**: Extremely fast local call, suitable for Claude Desktop, Cursor, and other clients. - **HTTP Mode**: Based on OAuth2 and PKCE authentication, support remote connection and multi-user scenarios. ## MCP Tool Manual | Category | Tool | Function Description | | :------------- | :--------------------- | :------------------------------------------------------------------------------------ | | **File Management** | `read-note(s)` | Read single or multiple note contents | | | `create/edit-note` | Create or overwrite update notes, support automatic directory creation | | | `append/patch-content` | **[Powerful]** Append content or make local patches based on semantic anchors | | | `apply-diff-patch` | Apply standard Unified Diff patches, precise modification | | | `delete/move-note` | Safe delete or rename/move notes | | **Directory Architecture** | `create-directory` | Recursively create directory structures | | | `list-files-in-vault` | Full-library file structure scan (support type filtering) | | | `list-files-in-dir` | Get file list under specified directory | | **Intelligent Search** | `search-vault` | Fuzzy + precise mixed search, with rating and context preview | | **RAG Knowledge Base** | `rag-search` | Title-aware slice search for Q&A, return citation-ready fragments | | | `build-note-context` | Construct budget-constrained source context packages by path, tag, or theme | | | `inspect-knowledge-map`| Scan Obsidian double chains, anti-chains, tag clusters, and isolated notes | | **Tag Governance** | `add/remove-tags` | Add or remove tags for notes | | | `rename-tag` | **[Full-library]** Automatically rename old tags in all files | | | `manage-tags` | Tag aggregation list, count statistics, and logical merging | | **Journal Workflow** | `log-journal-entry` | **[Recommended]** Automatically append structured work progress in daily notes | ## Quick Start ### 1. Quick Configuration ```bash # Install dependencies npm install # Configure environment variables (refer to .env.example) cp .env.example .env ``` ### 2. Run and Deploy For **Stdio/HTTP/Docker deployment methods**, **development detailed commands**, and **Git provider (GitHub/Gitee) configuration**, please refer to: 👉 **[Detailed Deployment and Running Guide (DEPLOYMENT.md)](DEPLOYMENT.md)** ## Contribute We welcome contributions in any form! Whether it's feature suggestions, bug feedback, or code submissions. - **Open-source License**: [MIT License](LICENSE) <p align="right"> Made with ❤️ for the Obsidian Community </p>