Obsidian GitHub MCP

Obsidian GitHub MCP

A white-label Model Context Protocol server that gives selected AI agents bounded, auditable access to propose changes to an Obsidian vault stored in GitHub.

Each agent receives its own expiring MCP bearer token. The GitHub credential remains server-side. Read and write paths, denials, protected surfaces, proposal branches, and token revocation are controlled by operator-owned YAML files.

This is an independent open-source project. It is not affiliated with or endorsed by Obsidian or GitHub.

Why use it?

Giving an agent a general GitHub token is difficult to constrain and easy to misuse. This server creates a narrower boundary:

AI agent + individual MCP token        |        videntity + fixed broker        |        vagent write scope AND broker publication scope        |        vdeny, path, frontmatter, mutability, size, and secret checks        |        vserver-side GitHub App token        |        vproposal branch for human review

The service has no tools for deleting files, merging branches, pushing to main or master, changing repository settings, editing workflows, or exposing credentials.

Features

• Stateless MCP Streamable HTTP transport
• Unique, expiring bearer tokens stored as SHA-256 bindings
• Per-agent read, write, and deny path globs
• Separate Git broker allowlists and fixed proposal branches
• Configurable frontmatter requirements for shared or sensitive surfaces
• living, review-first, append-only, and immutable note handling
• Path-traversal prevention and file-extension/size allowlists
• Credential-shaped-content detection
• Repository-restricted GitHub App tokens with PAT fallback for local testing
• Content-free JSONL audit records
• Host/origin validation, security headers, rate limiting, and HTTP timeouts
• Docker, CI, tests, and deployment documentation

MCP tools

Requirements

• Node.js 22+
• An Obsidian vault in a GitHub repository
• A dedicated non-default proposal branch for each broker
• A GitHub App installed only on the vault repository with Contents: read and write, or a fine-grained PAT for local testing

Quick start

Install from source (the current supported path):

git clone https://github.com/YOUR_ACCOUNT/obsidian-github-mcp.gitcd obsidian-github-mcpnpm cicp .env.example .envcp config/policy.example.yaml config/policy.yamlcp config/tokens.example.yaml config/tokens.yamlnpm run token:newnpm run check# Configure .env with your GitHub repository and token/app credentials before starting:npm start

Configure .env (specifying your repository and either a GITHUB_TOKEN or GitHub App credentials), replace the sample policy, and put only the generated token's SHA-256 in config/tokens.yaml. Give the raw bearer token to exactly one MCP client.

To verify a checkout before configuring a running service:

npm cinpm run checknpm run test:e2e

These checks use synthetic notes, mock GitHub responses and loopback transports. They need no GitHub or MCP credentials. Note regressions cover Unicode/path encoding, CRLF frontmatter, malformed metadata, UTF-8 size limits and append-only byte preservation. CI runs the same checks on Linux and Windows with Node.js 22 and 24. The 8 tools listed above are the current server surface; tests do not publish proposals to a real vault.

Once v0.1.0 is published to npm, a global install will also be available:

# Available once v0.1.0 is published (not yet on the npm registry).npm install -g @sarutobi-sasuke/obsidian-github-mcp

The default endpoints are:

GET  http://127.0.0.1:3210/healthzPOST http://127.0.0.1:3210/mcp

MCP clients must send:

Authorization: Bearer vault_<generated-token>

Permission model

The effective write scope is the intersection of the agent grant and its broker:

policy_version: 1authority: operator-only
agents:  - id: example-writer    name: Example Writer    role: bounded knowledge worker    disclosure_ceiling: internal    entry_reads: [README.md]    read: [Knowledge/**, Workspace/**]    write: [Workspace/Shared/**, Workspace/Example Writer/**]    deny: [Private/**, People/**, .obsidian/**]
git_brokers:  - broker: example-writer    branch: agent/example-writer    allow: [Workspace/Shared/**, Workspace/Example Writer/**]
never_versioned: [Private/**, People/**, .obsidian/**, secrets/**]
surface_rules:  - path: Workspace/Shared/**    required_frontmatter:      disclosure: public-safe

An auth binding then maps one token hash to that identity and broker. The binding cannot grant paths that the policy does not grant.

See Permissions documentation for provisioning and revocation.

GitHub authentication

Production deployments should use a GitHub App installed only on the vault repository. Configure:

GITHUB_APP_ID=123456GITHUB_APP_INSTALLATION_ID=12345678GITHUB_APP_PRIVATE_KEY_FILE=/run/secrets/vault-mcp.pem

The server creates short-lived installation tokens restricted again to the configured repository and contents: write. A repository-scoped GITHUB_TOKEN is supported as a local-development fallback.

Deployment

The included container runs as a non-root user with a read-only root filesystem. Put TLS, a private overlay network, or an authenticated gateway in front of the service before making it remotely reachable.

See Deployment guide.

Verification

npm run checknpm audit --audit-level=high

Tests cover policy parsing, write-scope intersection, deny precedence, traversal attempts, frontmatter rules, mutability, secret detection, token bindings, and fixed-branch GitHub writes.

Run npm run test:e2e for a clean tarball installation and real MCP HTTP client proof against a test-only GitHub substitute. It exercises proposal writes, denied paths/content, immutable and append-only notes, stale-write conflicts, invalid policy reloads, live token revocation and content-free audit records. CI runs this proof on Windows/Linux with Node 22/24, and the release workflow requires it.

Policy and token files reject unknown keys. Only policy_version: 1 and authority: operator-only are supported. Correct misspelt fields or remove unsupported metadata before upgrading; silently ignored restrictions are no longer accepted. Release evidence and remaining gates.

The draft MCP Registry npm entry describes a self-hosted Streamable HTTP process, not a stdio server. A compatible client starts the process with the declared environment and connects to http://127.0.0.1:{VAULT_MCP_PORT}/mcp (port 3210 by default). Supply the existing policy and token-file paths plus the repository owner/name. For GitHub access, use either GITHUB_TOKEN or all three documented GitHub App variables. The manifest cannot express that alternative group; runtime configuration validates it. The process does not create credentials, provision a hosted endpoint or bypass its existing bearer-token checks. The namespace preserves the exact GitHub owner spelling. prepublishOnly includes the registry/package gate; no login or publication is performed by it.

Security

Read Security policy before deployment. Report suspected vulnerabilities privately rather than opening a public issue with exploit details.

License

Apache-2.0. See Apache-2.0 License.