obsidian-mcp: 初次落地 Obsidian Vault MCP Server (.NET 10, read+write)
把 Obsidian vault 通过 MCP 暴露给 Claude.ai,OAuth 走 nas-auth。 设计文档见 vault Coding/obsidian-mcp/obsidian-mcp 设计.md。 代码层落地参考 vault Coding/obsidian-mcp/MCP 实现指南.md。 V1+V2 同时实现(用户要求跳过分阶段直接全部): 读 Tools(需 scope=read:obsidian): - list_vault_tree(一次性 vault 地图,限制深度) - list_files / read_file(含 offset/limit 大文件分页) - search(子串匹配 + glob 过滤,最多 50 hits) - get_metadata(size / modified_at / has_frontmatter) 写 Tools(需 scope=write:obsidian): - write_file / append_file - 多重门禁:scope 校验 + 路径黑名单 + 写入白名单 + 永禁文件 - 永禁写:任意目录的 AGENTS.md / PROFILE.md / README.md / CLAUDE.md / 01-Secret/** - 白名单:02-ShengquGames/logs/ + Coding/ + NAS/NAS 待办清单.md - 写入审计日志按天 rotate(JSON line) 安全: - VaultPathResolver chroot:path traversal + symlink 双拒绝 - JwtBearer (HS256, Current+Previous fallback, MapInboundClaims=false) - aud=obsidian, iss=https://auth.zhengchentao.win - 黑名单:01-Secret / .obsidian / .trash / .git 技术栈: - .NET 10 + ModelContextProtocol SDK 1.0 - Streamable HTTP transport (POST /mcp) - JwtBearer 10.0 + IdentityModel.Tokens 8.x 部署: - Dockerfile multi-stage,runtime 装 ripgrep(V3 备用),non-root user - .gitea/workflows/build-image.yml:build + deploy 双 job,buildkit v0.13.2 - 容器内 :8080,宿主端口 9090 - 子域名 obs.zhengchentao.win - vault 挂载 /volume1/docker/webdav/data/Zhengchen:/vault:rw(V2 写入需要 rw) 测试:35/35 单测过(VaultPathResolver path traversal/blacklist/symlink + VaultWriteGuard whitelist/forbidden) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
+83
@@ -0,0 +1,83 @@
|
||||
using Microsoft.AspNetCore.Authorization;
|
||||
using ObsidianMcp.Auth;
|
||||
using ObsidianMcp.Config;
|
||||
using ObsidianMcp.Endpoints;
|
||||
using ObsidianMcp.Services;
|
||||
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
|
||||
// ─── 配置绑定 ───────────────────────────────────────────────────────────────
|
||||
|
||||
var jwtOpts = builder.Configuration.GetSection(JwtOptions.Section).Get<JwtOptions>()
|
||||
?? new JwtOptions();
|
||||
|
||||
// ─── 配置对象注册到 DI ───────────────────────────────────────────────────────
|
||||
|
||||
builder.Services.Configure<VaultOptions>(
|
||||
builder.Configuration.GetSection(VaultOptions.Section));
|
||||
builder.Services.Configure<JwtOptions>(
|
||||
builder.Configuration.GetSection(JwtOptions.Section));
|
||||
|
||||
// McpDiscoveryOptions 直接注册为单例(供 DiscoveryEndpoints 依赖注入)
|
||||
var discoveryOpts = builder.Configuration.GetSection(McpDiscoveryOptions.Section).Get<McpDiscoveryOptions>()
|
||||
?? new McpDiscoveryOptions();
|
||||
builder.Services.AddSingleton(discoveryOpts);
|
||||
|
||||
// ─── 认证与授权 ──────────────────────────────────────────────────────────────
|
||||
|
||||
builder.Services.AddObsidianJwtBearer(jwtOpts);
|
||||
|
||||
builder.Services.AddAuthorization(opts =>
|
||||
{
|
||||
opts.AddScopePolicies();
|
||||
// 默认 policy:只要求已认证(JWT 验签通过即可),不要求特定 scope
|
||||
opts.DefaultPolicy = new AuthorizationPolicyBuilder()
|
||||
.RequireAuthenticatedUser()
|
||||
.Build();
|
||||
});
|
||||
|
||||
// scope 自定义 handler
|
||||
builder.Services.AddSingleton<IAuthorizationHandler, ScopeAuthorizationHandler>();
|
||||
|
||||
// IHttpContextAccessor(Tool 里取 User / scope 用)
|
||||
builder.Services.AddHttpContextAccessor();
|
||||
|
||||
// ─── MCP SDK ─────────────────────────────────────────────────────────────────
|
||||
|
||||
builder.Services.AddMcpServer()
|
||||
.WithHttpTransport() // Streamable HTTP(单端点 POST /mcp)
|
||||
.WithToolsFromAssembly(); // 自动扫描 [McpServerToolType]
|
||||
|
||||
// ─── 业务服务 ────────────────────────────────────────────────────────────────
|
||||
|
||||
builder.Services.AddSingleton<VaultPathResolver>();
|
||||
builder.Services.AddSingleton<VaultWriteGuard>();
|
||||
builder.Services.AddSingleton<VaultSearchService>();
|
||||
builder.Services.AddSingleton<AuditLogger>();
|
||||
|
||||
// ─── Build ───────────────────────────────────────────────────────────────────
|
||||
|
||||
var app = builder.Build();
|
||||
|
||||
// ─── Middleware 顺序(顺序不能乱)───────────────────────────────────────────
|
||||
|
||||
app.UseAuthentication();
|
||||
app.UseAuthorization();
|
||||
|
||||
// ─── 路由 ────────────────────────────────────────────────────────────────────
|
||||
|
||||
// /.well-known/oauth-authorization-server(不需要认证)
|
||||
app.MapDiscoveryEndpoints();
|
||||
|
||||
// 健康检查(方便 docker compose 和 NPM 探活)
|
||||
app.MapGet("/health", () => Results.Ok(new { status = "ok", time = DateTime.UtcNow }))
|
||||
.AllowAnonymous();
|
||||
|
||||
// MCP 端点(必须认证,Bearer JWT)。
|
||||
// 端点级只校验"已认证",scope 校验放在每个 Tool 里:
|
||||
// - 读 tool 校验 read:obsidian
|
||||
// - 写 tool 校验 write:obsidian
|
||||
// 这样客户端拿单一 scope(仅读 / 仅写)的 Token 都能正常用对应工具。
|
||||
app.MapMcp("/mcp").RequireAuthorization();
|
||||
|
||||
app.Run();
|
||||
Reference in New Issue
Block a user