mySoftwareGuide

Safe & trusted downloads

The best software, verified by experts

Icon of program: obsidian-cli-rest

obsidian-cli-rest for MCP

Obsidian CLI Rest: Programmatic Control for Your Obsidian Vault

  • Free
  • 4.1
  • V 2.0.0

Obsidian CLI Rest: Programmatic Control for Your Obsidian Vault

Obsidian CLI Rest by Dsebastien is a TypeScript-based Obsidian community plugin that acts as both a local HTTP API and an MCP server. It connects directly to the Obsidian desktop app, making its command-line interface functionality accessible programmatically. This tool enables external scripts, tools, and AI assistants to interact with and manage an Obsidian vault, offering a powerful way to automate note-taking and integrate with existing workflows. It can be installed via the in-app community plugins browser or manually.

What does Obsidian CLI Rest connect to?

Obsidian CLI Rest connects to the Obsidian desktop application, exposing its command-line interface (CLI) functionality. It operates as an Obsidian community plugin, functioning as a local HTTP API and an MCP server. This setup allows for programmatic control of an Obsidian vault, enabling external systems to interact directly with the application's core features. It is built using TypeScript and distributed as a plugin.

Core features and tools

The tool exposes all Obsidian CLI commands through REST API endpoints, translating colons to slashes in the URL path (e.g., property:set becomes /api/v1/cli/property/set). Key callable tools include help, version, vault, file, create, read, append, delete, search, daily, tasks, tags, diff, plugin:reload, eval, property:set, orphans, and unresolved. It supports standard HTTP for its REST API and a "2-tool Code Mode interface" at /mcp for AI assistants.

Who is it for?

Obsidian CLI Rest is designed for users, scripts, tools, and AI assistants seeking to automate or integrate with their Obsidian vaults. It caters to those who need to programmatically create, read, search, and modify notes, or connect AI assistants to interact with the vault via MCP. It also serves developers building integrations that hook Obsidian into existing workflows using standard HTTP requests. Skip this if your primary need is a graphical user interface for direct note management.

How to get started

The server authenticates using an API key. This key, an auto-generated Bearer token, is copied from the plugin's security settings within Obsidian and included in the Authorization header for all requests.

Use cases

  • Automating note-taking by creating, reading, searching, and modifying notes from external scripts or tools.
  • Connecting AI assistants to interact with the Obsidian vault via MCP.
  • Building integrations to hook Obsidian into existing workflows using standard HTTP requests.
  • Monitoring vault health through scheduled scripts, for example, to check for orphan notes or unresolved links.

Obsidian CLI Rest offers a powerful bridge for external systems to control Obsidian vaults, supporting automation and AI integration. Its API key authentication and granular command controls provide security for programmatic access. The tool's ability to expose all Obsidian CLI commands via HTTP and MCP makes it a versatile option for extending Obsidian's capabilities.

  • Pros

    • Exposes all Obsidian CLI commands via API.
    • Supports both HTTP REST and MCP for AI clients.
    • Offers granular command controls for security.
    • Enables extensive vault automation and integration.
  • Cons

    • Requires manual API key management and rotation.
    • Server is localhost-only by default.
    • No explicit support for stdio or SSE.
    • Requires Obsidian desktop app to function.
Icon of program: obsidian-cli-rest

obsidian-cli-rest for MCP

  • Free
  • 4.1
  • V 2.0.0