obsidian-mcp-server

shreeshauppunda/obsidian-mcp-server

3.2

If you are the rightful owner of obsidian-mcp-server and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

The Obsidian MCP Server is a tool designed to integrate Obsidian vaults with OpenAI, enhancing note-taking with AI capabilities.

Universal MCP Server for Obsidian Vault Integration with OpenAI

GitHub repo size GitHub issues GitHub stars GitHub forks

Table of Contents

Overview

The Obsidian MCP Server provides a seamless way to integrate your Obsidian vault with OpenAI. This server supports various clients, making it a versatile tool for enhancing your note-taking experience.

You can find the latest releases here. Download the necessary files and execute them to get started.

Features

  • Universal Compatibility: Works with Windsurf, Claude Desktop, Cursor, and any MCP client.
  • Markdown Support: Leverage Markdown formatting in your notes.
  • AI Integration: Use OpenAI to enhance your notes and insights.
  • TypeScript Implementation: Built using TypeScript for better performance and type safety.
  • Easy Setup: Quick installation and straightforward usage.

Installation

To set up the Obsidian MCP Server, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/shreeshauppunda/obsidian-mcp-server.git

  2. Navigate to the Directory:

    cd obsidian-mcp-server

  3. Install Dependencies:

    npm install

  4. Run the Server:

    npm start

For the latest version, visit the Releases section. Download the required files and execute them as needed.

Usage

Once the server is running, you can connect your MCP client. The server listens for requests and processes them using OpenAI's API.

Example Request

To send a request, use the following format:

{
  "prompt": "Your question or note content here",
  "max_tokens": 150
}

The server will respond with generated content based on your input.

Supported Clients

The Obsidian MCP Server works with the following clients:

  • Windsurf: A lightweight client for quick access.
  • Claude Desktop: A desktop application designed for deep integration.
  • Cursor: A versatile client for various use cases.
  • Any MCP Client: The server is designed to be compatible with any client that follows the MCP protocol.

Contributing

We welcome contributions to improve the Obsidian MCP Server. To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit them (git commit -m 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Create a pull request.

License

This project is licensed under the MIT License. See the file for details.

Contact

For questions or feedback, reach out to the repository owner:

Explore the capabilities of the Obsidian MCP Server and enhance your note-taking experience with AI. Don't forget to check the Releases for updates and new features.