zhengchen.tao/obsidian-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): 加 i18n 切换 + 中文版 + nas-auth 引用

Browse Source 
- README.md L3 加'English | 简体中文'切换 header
- Choosing an AS / Self-hosted minimal 段:把"Write your own 500 LoC"
  改成显式指向 [nas-auth](https://github.com/ZhengchenTao/nas-auth),
  本 server 开发过程中对接的就是它,作 reference 实现
- 新增 README.zh-CN.md

CI build-image.yml paths-ignore '**.md',本次 docs-only push 不触发
build。
This commit is contained in:
Zhengchen Tao
2026-05-20 10:46:54 +08:00
parent 2b595ea27b
commit d0852a222e
2 changed files with 178 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -2
View File
@@ -1,5 +1,7 @@
# obsidian-mcp
English | [简体中文](README.zh-CN.md)
Read and write an Obsidian vault via [MCP (Model Context Protocol)](https://modelcontextprotocol.io/),
gated by OAuth-issued JWT bearer tokens.
@@ -162,8 +164,7 @@ Public keys are fetched automatically from `<Issuer>/.well-known/openid-configur
[Keycloak](https://www.keycloak.org), [ZITADEL](https://github.com/zitadel/zitadel), [Logto](https://github.com/logto-io/logto), [Authentik](https://goauthentik.io).
**Self-hosted, minimal** — HS256 mode:
Write your own ~500 LoC AS that issues HS256 JWTs with the right claims. The
MCP server's `Jwt__SigningKey__Current` and the AS's signing key must match.
See [nas-auth](https://github.com/ZhengchenTao/nas-auth) — the reference ~500 LoC AS this server was developed against. Or write your own. The MCP server's `Jwt__SigningKey__Current` and the AS's signing key must match.
**Required AS features regardless of choice:**
- OAuth 2.1 + PKCE (RFC 7636)
README.zh-CN.md
+175
View File
@@ -0,0 +1,175 @@
# obsidian-mcp
[English](README.md) | 简体中文
通过 [MCP（Model Context Protocol）](https://modelcontextprotocol.io/) 协议读写 Obsidian vault，访问由 OAuth 签发的 JWT bearer token 控制。
本 server 可对接任何能签发包含 `aud` / `iss` / `sub` / `scope` claim 的 OAuth 2.1 + PKCE AS。支持两种签名模式：
- **HS256**（默认）—— AS 与本 server 共享对称密钥。用于自建的极简 AS。
- **RS256** —— 自动通过 `<Issuer>/.well-known/openid-configuration` 的 OIDC discovery 拉取 JWKS。可对接任意标准 provider：[Logto](https://logto.io)、[ZITADEL](https://zitadel.com)、[Keycloak](https://www.keycloak.org)、[Auth0](https://auth0.com) 等。
部署指引见下方 [Choosing an AS](#choosing-an-as)。
## Architecture
```
MCP client (Claude.ai, etc.)
│
│ ① GET /.well-known/oauth-authorization-server (RFC 8414)
│ ② OAuth Authorization Code + PKCE (against your AS)
│ ③ Bearer JWT (aud=obsidian, scope=read:obsidian | write:obsidian)
│
▼
obsidian-mcp /mcp
│ JWT verify (HS256, shared key with AS)
│ VaultPathResolver — chroot + blacklist
│ VaultWriteGuard — whitelist for writes
│
▼
/vault (mounted directory — local folder, WebDAV sync target, etc.)
```
## MCP tools
| 工具 | 所需 scope | 说明 |
|---|---|---|
| `list_vault_tree` | `read:obsidian` | 限定深度的 vault 目录树 |
| `list_files` | `read:obsidian` | 列出某个目录下的文件与子目录 |
| `read_file` | `read:obsidian` | 读取文件内容（UTF-8，可选 byte-range 参数） |
| `search` | `read:obsidian` | 纯字符串子串搜索，可用 glob 过滤 |
| `get_metadata` | `read:obsidian` | size、modified_at、has_frontmatter |
| `write_file` | `write:obsidian` | 覆盖写一个 whitelist 内的文件 |
| `append_file` | `write:obsidian` | 在 whitelist 内的文件末尾追加 |
## Configuration
所有配置项通过 `Vault__` / `Jwt__` / `Mcp__OAuthDiscovery__` 前缀绑定（double underscore 表示嵌套 section）。生产环境必须通过环境变量注入。
| 变量 | 默认值 | 必填 | 说明 |
|---|---|---|---|
| `Vault__Root` | `/vault` | 是 | 容器内的 vault 根目录 |
| `Vault__Blacklist__0` | — | 否 | 额外要拒绝的路径片段（`.obsidian`、`.trash`、`.git` 始终被拒） |
| `Vault__WriteWhitelist__0` | — | 写工具需要 | 可写路径项（见下方） |
| `Jwt__Algorithm` | `HS256` | 否 | `HS256` 或 `RS256` |
| `Jwt__Issuer` | — | **是** | 期望的 `iss` claim —— 你 AS 的 issuer URL |
| `Jwt__Audience` | `obsidian` | 否 | 期望的 `aud` claim |
| `Jwt__SigningKey__Current` | — | 仅 HS256 | HS256 签名密钥，与你的 AS 共享 |
| `Jwt__SigningKey__Previous` | — | 否 | 轮换窗口内的旧 HS256 密钥 |
| `Mcp__OAuthDiscovery__Issuer` | — | **是** | `/.well-known/oauth-authorization-server` 中的 `issuer` 字段 |
| `Mcp__OAuthDiscovery__AuthorizationEndpoint` | — | **是** | 你 AS 的 `/authorize` URL |
| `Mcp__OAuthDiscovery__TokenEndpoint` | — | **是** | 你 AS 的 `/token` URL |
| `Mcp__OAuthDiscovery__RegistrationEndpoint` | — | 否 | 你 AS 的 `/register` URL（DCR） |
| `Mcp__OAuthDiscovery__ResourceUrl` | request host | 否 | RFC 9728 中本 MCP server 的 `resource` 标识 |
| `AuditLog__Directory` | `/app/logs` | 否 | 审计日志目录 |
| `ASPNETCORE_ENVIRONMENT` | `Production` | 否 | `Development` 启用详细日志 |
### Write whitelist format
`Vault__WriteWhitelist__N` 每一项都对 write / append 操作起 gate 作用：
- 以 `/`（或 `\`）结尾 → 前缀匹配。例如 `Notes/` 允许 `Notes/` 下任意路径。
- 否则 → 精确路径匹配。例如 `todo.md` 仅允许这一个文件。
无论 whitelist 如何，以下文件名永远禁止写入：`AGENTS.md`、`README.md`、`CLAUDE.md`（这些是常见的 agent context 文件，被改写后容易让下游工具混乱）。
`WriteWhitelist` 为空时，所有写操作都被拒绝。
## Local development
```bash
# 1. 建一个测试 vault
mkdir -p test-vault/Notes
echo "# Test" > test-vault/Notes/test.md
# 2. 设置必要的环境变量
export Vault__Root=./test-vault
export Vault__WriteWhitelist__0=Notes/
export Jwt__Issuer=https://your-auth-server.example.com
export Jwt__Audience=obsidian
export Jwt__SigningKey__Current=dev-secret-key-at-least-32-chars-long
export Mcp__OAuthDiscovery__Issuer=https://your-auth-server.example.com
export Mcp__OAuthDiscovery__AuthorizationEndpoint=https://your-auth-server.example.com/authorize
export Mcp__OAuthDiscovery__TokenEndpoint=https://your-auth-server.example.com/token
# 3. 跑起来
dotnet run
# 4. 生成测试用 JWT（需要 dotnet user-jwts）
dotnet user-jwts create \
--issuer https://your-auth-server.example.com \
--audience obsidian \
--name tester \
--claim sub=tester \
--claim scope="read:obsidian write:obsidian"
# 5. 用 MCP Inspector 测试
npx @modelcontextprotocol/inspector
# Transport: Streamable HTTP
# URL: http://localhost:5000/mcp
# Bearer Token: <粘贴步骤 4 得到的 JWT>
```
## Docker
仓库内附 multi-stage Dockerfile。本地构建：
```bash
docker build -t obsidian-mcp .
```
挂载 vault 后运行：
```bash
docker run --rm -p 8080:8080 \
-v /path/to/vault:/vault \
-e Jwt__Issuer=https://your-auth-server.example.com \
-e Jwt__SigningKey__Current=$JWT_SIGNING_KEY \
-e Mcp__OAuthDiscovery__Issuer=https://your-auth-server.example.com \
-e Mcp__OAuthDiscovery__AuthorizationEndpoint=https://your-auth-server.example.com/authorize \
-e Mcp__OAuthDiscovery__TokenEndpoint=https://your-auth-server.example.com/token \
-e Vault__WriteWhitelist__0=Notes/ \
obsidian-mcp
```
仓库内的 `.gitea/workflows/build-image.yml` 是一个 Gitea Actions workflow，负责构建并推送镜像。需要在仓库设置中配置：
- `vars.REGISTRY` —— registry 主机名（例如 `ghcr.io`）
- `vars.IMAGE_OWNER` —— registry 的 owner / namespace
- `secrets.PACKAGES_TOKEN` —— registry 推送 token
## Choosing an AS
Claude.ai 网页端强制走完整的 OAuth Authorization Code + PKCE 流程，对接你 MCP server 的 `/.well-known/oauth-authorization-server` 端点 —— 没有 bearer token 捷径可用。在下面几条路径中选一条：
**Hosted (fastest start, recommended for new setups)** —— RS256 模式：
| Provider | 免费额度 | 备注 |
|---|---|---|
| [Logto Cloud](https://logto.io) | 5000 MAU | 最轻量，约 30 分钟搭好 |
| [ZITADEL Cloud](https://zitadel.com) | 25k auths / 月 | 功能更全，文档稍重 |
设置 `Jwt__Algorithm=RS256` 与 `Jwt__Issuer=<你的 tenant issuer URL>`。公钥会自动从 `<Issuer>/.well-known/openid-configuration` 拉取。
**Self-hosted, full-featured** —— RS256 模式：
[Keycloak](https://www.keycloak.org)、[ZITADEL](https://github.com/zitadel/zitadel)、[Logto](https://github.com/logto-io/logto)、[Authentik](https://goauthentik.io)。
**Self-hosted, minimal** —— HS256 模式：
参见 [nas-auth](https://github.com/ZhengchenTao/nas-auth) —— 本 server 在开发过程中对接的那个约 500 行 LoC 的参考 AS。或者自己写一个。MCP server 的 `Jwt__SigningKey__Current` 必须与 AS 的签名密钥保持一致。
**不论选哪条，AS 必须支持：**
- OAuth 2.1 + PKCE（RFC 7636）
- Dynamic Client Registration（RFC 7591）—— 让 Claude.ai 能自助注册
- `resource` 参数（RFC 8707）—— 用于签发 audience-bound token
- 自定义 scope 支持（`read:obsidian`、`write:obsidian`）
## Running tests
```bash
cd obsidian-mcp.Tests
dotnet test
```
## License
MIT