Obsidian GitHub MCP
概览
作者提供的说明(英文原文)
A permissioned MCP gateway for agent proposals to a Git-backed Obsidian vault.
PopNx MCP 的三大支柱
这三项永远不会合并成一个分数:意见、测量和人气是不同的东西。
- 用户评价i暂无评价评价功能将在后续阶段与账户功能一起开放
- 我们的基础检查i1 项中通过 1 项依据公开信息检查;尚未扫描代码
- 使用情况i非常新↓ 52/周 · ★ –
它能帮你做什么
我们还没有为它写通俗的介绍。下面是我们从注册中心读取到的事实。
- 连接方式: 在你的电脑上运行
- 传输方式: Streamable HTTP
- 分类: 文档、表格与办公
- 你需要填写:VAULT_MCP_GITHUB_OWNER, VAULT_MCP_GITHUB_REPO, VAULT_MCP_POLICY_FILE, VAULT_MCP_TOKEN_FILE, GITHUB_TOKEN, GITHUB_APP_PRIVATE_KEY_FILE
安装
选择你使用的 AI 应用,然后复制设置。
安装之前
- 基础检查:1 项中通过 1 项
- 在你的电脑上运行,拥有你的用户账户的权限(文件、网络、应用)。
- 需要你自己填写:
VAULT_MCP_PORT,VAULT_MCP_GITHUB_OWNER,VAULT_MCP_GITHUB_REPO,VAULT_MCP_POLICY_FILE,VAULT_MCP_TOKEN_FILE,GITHUB_TOKEN,GITHUB_APP_ID,GITHUB_APP_INSTALLATION_ID,GITHUB_APP_PRIVATE_KEY_FILE
标为机密的值是你账户的钥匙。千万不要分享给别人,也不要粘贴到聊天里。
你需要
- npm已安装 Node.js(用于 npx 命令)
你用的是哪个应用?
在上方选择你的应用。我们会记住它,下次按钮会显示“安装到 …”。
打开 Claude Desktop → Settings → Developer → Edit Config,把下面的内容粘贴到 claude_desktop_config.json
{
"mcpServers": {
"obsidian-github": {
"command": "npx",
"args": [
"-y",
"@sarutobi-sasuke/obsidian-github-mcp"
],
"env": {
"VAULT_MCP_PORT": "your-value",
"VAULT_MCP_GITHUB_OWNER": "your-value",
"VAULT_MCP_GITHUB_REPO": "your-value",
"VAULT_MCP_POLICY_FILE": "your-value",
"VAULT_MCP_TOKEN_FILE": "your-value",
"GITHUB_TOKEN": "your-value",
"GITHUB_APP_ID": "your-value",
"GITHUB_APP_INSTALLATION_ID": "your-value",
"GITHUB_APP_PRIVATE_KEY_FILE": "your-value"
}
}
}
}在终端中运行这条命令
claude mcp add obsidian-github --env VAULT_MCP_PORT=your-value --env VAULT_MCP_GITHUB_OWNER=your-value --env VAULT_MCP_GITHUB_REPO=your-value --env VAULT_MCP_POLICY_FILE=your-value --env VAULT_MCP_TOKEN_FILE=your-value --env GITHUB_TOKEN=your-value --env GITHUB_APP_ID=your-value --env GITHUB_APP_INSTALLATION_ID=your-value --env GITHUB_APP_PRIVATE_KEY_FILE=your-value -- npx -y @sarutobi-sasuke/obsidian-github-mcp运行前请先填写空着的值。
或者自己复制设置
粘贴到项目中的 .cursor/mcp.json,或 ~/.cursor/mcp.json
{
"mcpServers": {
"obsidian-github": {
"command": "npx",
"args": [
"-y",
"@sarutobi-sasuke/obsidian-github-mcp"
],
"env": {
"VAULT_MCP_PORT": "your-value",
"VAULT_MCP_GITHUB_OWNER": "your-value",
"VAULT_MCP_GITHUB_REPO": "your-value",
"VAULT_MCP_POLICY_FILE": "your-value",
"VAULT_MCP_TOKEN_FILE": "your-value",
"GITHUB_TOKEN": "your-value",
"GITHUB_APP_ID": "your-value",
"GITHUB_APP_INSTALLATION_ID": "your-value",
"GITHUB_APP_PRIVATE_KEY_FILE": "your-value"
}
}
}
}浏览器会先询问是否打开应用,然后应用会显示设置并请你确认。密钥的值会留空,由你自己填写。
或者自己复制设置
粘贴到项目中的 .vscode/mcp.json
{
"servers": {
"obsidian-github": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@sarutobi-sasuke/obsidian-github-mcp"
],
"env": {
"VAULT_MCP_PORT": "your-value",
"VAULT_MCP_GITHUB_OWNER": "your-value",
"VAULT_MCP_GITHUB_REPO": "your-value",
"VAULT_MCP_POLICY_FILE": "your-value",
"VAULT_MCP_TOKEN_FILE": "your-value",
"GITHUB_TOKEN": "your-value",
"GITHUB_APP_ID": "your-value",
"GITHUB_APP_INSTALLATION_ID": "your-value",
"GITHUB_APP_PRIVATE_KEY_FILE": "your-value"
}
}
}
}浏览器会先询问是否打开应用,然后应用会显示设置并请你确认。密钥的值会留空,由你自己填写。
这个服务器在你的电脑上运行,而 ChatGPT 只能连接互联网上的服务器。请选择其他应用。
你的选择通过 Cookie 保存在这台设备上,无需账户。
需要你填写的值
VAULT_MCP_PORTenvLoopback HTTP listening port.- Owner of the operator-authorised vault repository.
- Operator-authorised vault repository name.
- Absolute path to the operator-provisioned policy YAML.
- Absolute path to the operator-provisioned client-token YAML.
- Required for the token-based quickstart. Alternatively configure all three GitHub App variables documented in README.
GITHUB_APP_IDenvGitHub App alternative: set all three App variables instead of GITHUB_TOKEN.GITHUB_APP_INSTALLATION_IDenvGitHub App installation ID, required with GITHUB_APP_ID.- Absolute path to the operator-provisioned App private key; required with GITHUB_APP_ID.
这些设置是根据作者在注册中心的条目生成的。如果 README 的写法不同,请以 README 为准。
它能做什么
它在你的电脑上运行;安装后,工具列表会显示在你的 AI 应用中。
基础检查i
我们检查的是任何人都能看到的信息;我们没有阅读代码。不适用的检查项不计入总数。 · 检查于 2026年11月9日
- ✓ 通过
作者与仓库一致
注册名称已通过 GitHub 账户 SarutobiSasuke8 验证,该账户拥有此仓库
- … 尚未检查
仍在维护
我们还没有从 GitHub 读取这个仓库
- … 尚未检查
有许可证
我们还没有从 GitHub 读取这个仓库
- – 不适用
端点有响应
它在你的电脑上运行,没有互联网端点
- – 不适用
使用 OAuth 登录
在你的电脑上运行,改用本地设置
- … 尚未检查
工具描述中没有隐藏指令
它在你的电脑上运行;我们只能读取互联网端点的工具列表
与“文档、表格与办公”中的其他服务器比较i
- 星标数多于此分类中其他 3660 个服务器的 0%
- 发布到注册中心的时间比此分类中其他 3660 个服务器的 66% 更新
- 基础检查结果等于或优于此分类中其他 3660 个服务器的 100%
与注册中心里这个分类中所有活跃的服务器比较。只有当发布者拥有该仓库时,星标数才计入。
常见问题
Obsidian GitHub MCP 安全吗?
它在 1 项适用的基础检查中通过了 1 项。我们没有阅读代码。在添加密钥或令牌之前,请先看看这个服务器要求哪些权限,并使用只具备所需权限的密钥。
它需要哪些密钥或代码?
你需要填写:VAULT_MCP_GITHUB_OWNER, VAULT_MCP_GITHUB_REPO, VAULT_MCP_POLICY_FILE, VAULT_MCP_TOKEN_FILE, GITHUB_TOKEN, GITHUB_APP_PRIVATE_KEY_FILE
它在我的电脑上运行还是在云端?
它在你的电脑上运行。你的 AI 应用会在需要时启动它,数据不会经过作者的服务器(除非它自己调用在线服务)。
它还在维护吗?
GitHub 仓库最后更新于–,最新版本(0.1.0)于16天前进入注册中心。
哪些应用可以使用它?
支持 MCP 的应用,例如 Claude Desktop、Claude Code、Cursor 和 VS Code。你的电脑上还需要有 Node.js。
有什么可以替代它?
同一分类中有:Agent-Native Calendar, Excel MCP Server, MCP Server for Excel
替代选择
同一分类中其他作者的服务器,按星标数排序。
如何看卡片:↓ 每周下载量i★ GitHub 星标i三大支柱:评价 · 检查 · 使用情况i更新 = 最新版本发布到注册中心的时间i
Excel MCP Server
Create and edit Excel files with AI: charts, PivotTables, formulas. No Excel needed.
MCP Server for Excel
Excel automation for AI - Sheets, Power Query, DAX, VBA, Tables, Ranges and more. Windows only.
作者的 README
打开 README
按原文从作者的仓库复制。PopNx MCP 没有审查或背书其内容。HTML、图片和脚本已被移除。链接会离开本站。
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
| v identity + fixed broker | v agent write scope AND broker publication scope | v deny, path, frontmatter, mutability, size, and secret checks | v server-side GitHub App token | v proposal 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, andimmutablenote 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
| Tool | Purpose |
|---|---|
vault_whoami | Show the authenticated identity, broker, branch, and policy scopes. |
vault_list_allowed_paths | Explain effective read/write/deny boundaries. |
vault_explain_access | Dry run a single path. Report whether read, list, or write would be permitted and which policy rule decides it. No GitHub call. |
vault_list_files | List an authorised directory while filtering denied children. |
vault_read_file | Read an authorised UTF-8 vault file. |
vault_create_file | Create a file on the identity's fixed proposal branch. |
vault_update_file | Update a permitted file while respecting mutability. |
vault_append_file | Append while preserving all existing bytes. |
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.git
cd obsidian-github-mcp npm ci cp .env.example .env cp config/policy.example.yaml config/policy.yaml cp config/tokens.example.yaml config/tokens.yaml npm run token:new npm 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 ci
npm run check npm 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/healthz
POST 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: 1
authority: 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=123456
GITHUB_APP_INSTALLATION_ID=12345678 GITHUB_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 check
npm 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.