Obsidian MCP Tools

🚀 MCP Tools Plugin

The MCP Tools Plugin (Model Context Protocol Tools) is a set of plugins designed for Obsidian, enabling interaction with AI services adhering to the Model Context Protocol (MCP). It supports various functions such as data input, processing, and output, and is compatible with multiple MCP clients.

🚀 Quick Start

Prerequisites

• The latest version of Obsidian
• Internet connection

Download and Installation

1. Visit the MCP Tools repository.
2. Download the plugin package suitable for your system on the Releases page.
3. Unzip the downloaded .zip file and copy it to the Plugins folder under the appdata directory:

   Windows: C:\Users\<Your username>\AppData\Roaming\Obsidian\Plugins
   macOS: /Users/<Your username>/Library/Application Support/Obsidian/Plugins
   Linux: ~/.config/obsidian/Plugins
   

✨ Features

Function Overview

The main functions of the MCP Tools Plugin include:

• Interacting with AI services following the MCP protocol
• Providing data input, processing, and output functions
• Supporting data exchange in multiple formats

Getting Started

1. Restart Obsidian after installation.
2. Open the sidebar and select the MCP Tools Plugin icon.
3. Configure the API key or access token in the pop - up interface.
4. Start using the MCP service.

📦 Installation

Prerequisites

• The latest version of Obsidian
• Internet connection

Download and Installation

1. Visit the MCP Tools repository.
2. Download the plugin package suitable for your system on the Releases page.
3. Unzip the downloaded .zip file and copy it to the Plugins folder under the appdata directory:

   Windows: C:\Users\<Your username>\AppData\Roaming\Obsidian\Plugins
   macOS: /Users/<Your username>/Library/Application Support/Obsidian/Plugins
   Linux: ~/.config/obsidian/Plugins
   

💻 Usage Examples

Basic Usage

1. Install and restart Obsidian.
2. Open the sidebar and click the MCP Tools Plugin icon.
3. Configure the API key or access token.
4. Start using the MCP service.

🔧 Technical Details

Project Structure

The MCP Tools Plugin uses a monorepo architecture, including the following modules:

packages/
├── mcp-server/        # Server implementation
├── obsidian-plugin/   # Obsidian plugin
└── shared/           # Common tools and types

Using Cline

Part of the code is implemented by the AI coding agent Cline. Refer to the cline_docs/ and .clinerules files to understand the project architecture.

Workspace

This project uses the Bun workspace structure:

Dependency Management

1. Install dependencies:

   bun install
   

2. Build all packages:

   bun run build
   

3. Run in development mode:

   bun run dev
   

Configuration Requirements

• Bun v1.1.42 or higher
• TypeScript 5.0+

🤝 Contribution Guidelines

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Run tests:

   bun test
   

5. Submit a Pull Request.

For detailed guidelines, please refer to CONTRIBUTING.md.

🛠️ Support

• Report issues and feature requests in Issues.
• Seek help in Discussions.

📜 Changelog

For detailed change records, please refer to CHANGELOG.md.

📄 License

The project follows the MIT license. For specific terms, see the LICENSE file.

📌 Footnotes

1. The MCP protocol defines the interaction standard between AI services and clients.
2. The API formats supported by the plugin include JSON, XML, and custom formats.
3. All scripts have been rigorously tested to ensure compatibility and stability.