Typescript MCP Server with Obsidian Integration

What is Typescript MCP Server with Obsidian Integration?

A command-line interface (CLI) for interacting with your Obsidian vault, built as a Model Context Protocol (MCP) server. It allows developers to search, list, and read notes via CLI commands or an HTTP API.

How to use Typescript MCP Server with Obsidian Integration?

Set up by cloning the repository, installing dependencies (npm install), and creating a .env file with your vault path (OBSIDIAN_VAULT_PATH). Then run commands like npm run cli search "query", npm run cli list "directory", or npm run cli read "path/to/note.md". Optionally install globally with npm link to use obsidian-cli from anywhere.

Key features of Typescript MCP Server with Obsidian Integration

• Search notes by text content with configurable result limits
• List notes in any vault directory (default 10 results)
• Read full content of a specific note file
• HTTP API endpoints for search, list, and read operations
• React frontend available at http://localhost:5173
• Global CLI installation for system-wide use
• Development mode with auto-reload via nodemon

Use cases of Typescript MCP Server with Obsidian Integration

• Automate note retrieval for development workflows or scripts
• Integrate with MCP-compatible clients to query an Obsidian vault
• Quickly search and read notes from the command line without opening Obsidian
• Build custom tooling that indexes or processes vault content

FAQ from Typescript MCP Server with Obsidian Integration

What are the prerequisites?

You need Node.js 14.x or later, npm or yarn, and an existing Obsidian vault.

How do I configure the vault path?

Set the environment variable OBSIDIAN_VAULT_PATH in a .env file in the project root to the absolute path of your vault.

Can I limit the number of search results?

Yes. Use the --limit flag, e.g., npm run cli search "query" -- --limit 10. The default limit is 5 for search and 10 for listing.

Is there a web UI?

Yes, a React frontend is available. Start it with cd client && npm install && npm run dev, then visit http://localhost:5173.

Can I use the server globally without typing npm run?

Yes. Run npm link from the project directory to install the obsidian-cli command globally, then use obsidian-cli list etc. from any terminal.