Skip to main content

Expose your Obsidian vault via REST API and streamable HTTP MCP server for AI tool access

Project description

obsidian-ai-miniserver

Makes your Obsidian vault accessible via REST API (OpenAPI) and a streamable HTTP MCP server. Enables AI to find, read, and edit text notes. Supports multiple users with token-based auth and path-level access control.

Quick start

pip install obsidian-ai-miniserver
obs_ai_ms start /path/to/vault --admin-token your_token

This starts both servers on their default ports. Connect your AI to the MCP endpoint or the REST API.

Options

Option Default Description
vault_path (required) Path to the Obsidian vault
--admin-token (required) Auth token for the admin user
--openapi-port 8747 Port for the REST API server (-1 to disable)
--mcp-port 8716 Port for the MCP server (-1 to disable)
--host 127.0.0.1 Host to bind to. Use 0.0.0.0 to allow remote access

Persistence

Config is stored at .obsidian/obsidian_ai_miniserver.json inside the vault — user list with tokens and path access rules.

API reference

See openapi.json for full request/response definitions.

All requests go to POST /api/obsidian with a kind field that discriminates the request type. Available kinds:

  • get_vault_info — vault name, daily notes folder, your user info
  • list_files — list files and folders at a path
  • read_text — read a note's text
  • write_text — overwrite a note
  • append_text — append to a note
  • replace_text — find and replace text in a note
  • move_file — move, copy, or delete a file
  • list_users / upsert_user — admin user management

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

obsidian_ai_miniserver-0.1.1-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file obsidian_ai_miniserver-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for obsidian_ai_miniserver-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 54a3e8fb49c1d4f23ea39baee0bdaaceba77471cf5c080d60ec378519dbe3fc8
MD5 05548a1d163666ece2562ce37c3f0151
BLAKE2b-256 b0ae5c5321af89233bb5d69b4e678e12d117cc36aa15d585c10171ecc77fed36

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page