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:
@@ -0,0 +1,72 @@
|
||||
using System.ComponentModel;
|
||||
using ModelContextProtocol.Server;
|
||||
using ObsidianMcp.Auth;
|
||||
using ObsidianMcp.Services;
|
||||
|
||||
namespace ObsidianMcp.Tools;
|
||||
|
||||
[McpServerToolType]
|
||||
public class ListVaultTreeTool(VaultPathResolver resolver, IHttpContextAccessor http)
|
||||
{
|
||||
[McpServerTool]
|
||||
[Description(
|
||||
"Return a depth-limited directory tree of the entire Obsidian vault as JSON. " +
|
||||
"Use this first when you need an overview of the vault structure. " +
|
||||
"Each node has { name, type (file|directory), children? }. " +
|
||||
"Blacklisted directories (01-Secret, .obsidian, .trash, .git) are excluded. " +
|
||||
"Prefer this over multiple list_files calls when you need the big picture.")]
|
||||
public object ListVaultTree(
|
||||
[Description("Maximum depth to traverse (default 3). Root is depth 0.")] int depth = 3)
|
||||
{
|
||||
ToolScopeGuard.EnsureScope(http, ScopePolicies.ReadObsidian);
|
||||
|
||||
if (depth < 0) depth = 0;
|
||||
if (depth > 10) depth = 10; // 防止超大 vault 超时
|
||||
|
||||
var root = resolver.VaultRoot;
|
||||
return BuildNode(root, root, depth);
|
||||
}
|
||||
|
||||
private static object BuildNode(string path, string root, int remainingDepth)
|
||||
{
|
||||
var name = path == root ? "/" : Path.GetFileName(path);
|
||||
|
||||
if (File.Exists(path))
|
||||
{
|
||||
return new { name, type = "file" };
|
||||
}
|
||||
|
||||
if (!Directory.Exists(path))
|
||||
return new { name, type = "unknown" };
|
||||
|
||||
if (remainingDepth == 0)
|
||||
return new { name, type = "directory" };
|
||||
|
||||
// 枚举子项,排序:目录先、文件后,各自按名字排序
|
||||
List<object> children = [];
|
||||
|
||||
try
|
||||
{
|
||||
var entries = Directory.GetFileSystemEntries(path)
|
||||
.OrderBy(e => File.Exists(e) ? 1 : 0)
|
||||
.ThenBy(e => Path.GetFileName(e), StringComparer.OrdinalIgnoreCase);
|
||||
|
||||
foreach (var entry in entries)
|
||||
{
|
||||
var segName = Path.GetFileName(entry);
|
||||
// 跳过隐藏文件/目录(以 . 开头)
|
||||
if (segName.StartsWith('.')) continue;
|
||||
// 跳过 01-Secret
|
||||
if (segName.Equals("01-Secret", StringComparison.OrdinalIgnoreCase)) continue;
|
||||
|
||||
children.Add(BuildNode(entry, root, remainingDepth - 1));
|
||||
}
|
||||
}
|
||||
catch (UnauthorizedAccessException)
|
||||
{
|
||||
// 无权限目录跳过
|
||||
}
|
||||
|
||||
return new { name, type = "directory", children };
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user