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 Distribution

obsidian_ai_miniserver-0.1.2.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

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

obsidian_ai_miniserver-0.1.2-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file obsidian_ai_miniserver-0.1.2.tar.gz.

File metadata

  • Download URL: obsidian_ai_miniserver-0.1.2.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for obsidian_ai_miniserver-0.1.2.tar.gz
Algorithm Hash digest
SHA256 aad21503161138e3e2a866be03323eedcab174bf56ba05c765eef69de7b4167f
MD5 e9cd16be987eabd30a4781af9a0394e0
BLAKE2b-256 63ec637b407bd074d662cb30ddd5fc37065187e0f8b5ddd4910a5fd552f097b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for obsidian_ai_miniserver-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 07ac77d46d868b1746d912bdf9fe9c4addc84b8bca2ae51d5e8584484e4bc1a9
MD5 6a8cab6077bd08e3814836ef585b895e
BLAKE2b-256 53829d48cde8fd02a28167d9a384152252cf8830f2121af021225952ebe20386

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