mcpserver.so LogoMCPFly
Submit
Obsidian MCP Lite logo

Obsidian MCP Lite

by yokarilight

Productivity/Note TakingObsidianAPITypeScriptAutomation

Obsidian MCP Lite is a TypeScript-based MCP server for Obsidian, providing a simple interface to interact with Obsidian vaults. It allows you to programmatically access and modify your Obsidian notes.

View on GitHub

Last updated: N/A

What is Obsidian MCP Lite?

Obsidian MCP Lite is a lightweight server that acts as a bridge between external applications and your Obsidian vault. It implements the Model Context Protocol (MCP) to provide a standardized way to interact with your notes.

How to use Obsidian MCP Lite?

  1. Install Node.js and Obsidian with the Local REST API plugin.
  2. Clone the repository and install dependencies using pnpm install.
  3. Build the server using pnpm run build.
  4. Configure the server by copying .env.example to .env and setting your Obsidian API key and host.
  5. Run the server using node dist/index.js.
  6. Use the provided API endpoints to interact with your Obsidian vault.

Key features of Obsidian MCP Lite

  • List files in vault

  • List files in directory

  • Get file contents

  • Search specific texts from files

  • Patch content

  • Append content

  • Delete files

Use cases of Obsidian MCP Lite

  • Automated note processing

  • Integrating Obsidian with other applications

  • Building custom Obsidian plugins

  • Programmatically managing your notes

FAQ from Obsidian MCP Lite

What is MCP?

MCP stands for Model Context Protocol. It's a protocol for interacting with models, in this case, an Obsidian vault.

Do I need the Local REST API plugin?

Yes, the Obsidian Local REST API plugin is required for this server to communicate with your Obsidian vault.

Where do I find my Obsidian API key?

The API key is generated by the Local REST API plugin in Obsidian. Refer to the plugin's documentation for instructions.

What version of Node.js is required?

Node.js version 18.16.0 or higher is required.

How do I debug the server?

Use the MCP Inspector with the command npx @modelcontextprotocol/inspector -e OBSIDIAN_API_KEY=your-api-key-here node dist/index.js