Skip to main content

Headless HTTP MCP server for Obsidian-flavored Markdown vaults

Project description

headless-obsidian-mcp

Headless HTTP MCP server for an Obsidian-flavored Markdown vault

Install

uv sync

Run from PyPI without installing into the current project:

uvx headless-obsidian-mcp run --host 127.0.0.1 --port 8000

Configure

export HEADLESS_OBSIDIAN_MCP_VAULT_ROOT="$HOME/path/to/vault"
export HEADLESS_OBSIDIAN_MCP_AUTH_TOKEN="change-me"

Optional OpenAI-compatible embeddings:

export HEADLESS_OBSIDIAN_MCP_OPENAI_API_KEY="sk-..."
export HEADLESS_OBSIDIAN_MCP_OPENAI_BASE_URL="https://openrouter.ai/api/v1"
export HEADLESS_OBSIDIAN_MCP_EMBEDDING_MODEL="text-embedding-3-small"

Run

uv run headless-obsidian-mcp run --host 127.0.0.1 --port 8000

MCP endpoint:

http://127.0.0.1:8000/mcp

Daemon commands:

uv run headless-obsidian-mcp start
uv run headless-obsidian-mcp status
uv run headless-obsidian-mcp logs -f
uv run headless-obsidian-mcp stop

Tools

  • vault_list
  • vault_read
  • vault_search
  • vault_create_note
  • vault_update_note
  • vault_move_path
  • vault_delete_path
  • vault_backlinks
  • vault_reindex

Tool results return Markdown text for agents and structuredContent for programmatic clients.

The Markdown content is the compatibility path and should contain everything an agent needs. structuredContent is useful for clients that expose it, but some MCP clients still treat it as secondary metadata.

Development

uv sync --extra dev
uv run ruff format --check .
uv run ruff check .
uv run python -m unittest -v

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

headless_obsidian_mcp-0.1.0.tar.gz (78.4 kB view details)

Uploaded Source

Built Distribution

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

headless_obsidian_mcp-0.1.0-py3-none-any.whl (45.2 kB view details)

Uploaded Python 3

File details

Details for the file headless_obsidian_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: headless_obsidian_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 78.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for headless_obsidian_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2f0f95b9e67b4772dd4bba198cf7e065fb1eb168e4364aac39f4cb66819d02be
MD5 8502899a123eae2ccb2114bd0b9b2e68
BLAKE2b-256 d46e7b847c17953ada53be329903d71695ec1bd0c452c1a0e4c4b7257fe15562

See more details on using hashes here.

Provenance

The following attestation bundles were made for headless_obsidian_mcp-0.1.0.tar.gz:

Publisher: publish.yml on esceptico/headless-obsidian-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file headless_obsidian_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for headless_obsidian_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec3684e9f106b6df1e670862c4f59728d99247a094ec47960e4b48fe8d46c32d
MD5 e7bc502241ed7493b7370dd7c9c00204
BLAKE2b-256 ffd90cadd175aacc663fc0a8611970e8fa981335e3e251906c09fab66b9aedb1

See more details on using hashes here.

Provenance

The following attestation bundles were made for headless_obsidian_mcp-0.1.0-py3-none-any.whl:

Publisher: publish.yml on esceptico/headless-obsidian-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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