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,55 @@
|
||||
using System.ComponentModel;
|
||||
using ModelContextProtocol.Server;
|
||||
using ObsidianMcp.Auth;
|
||||
using ObsidianMcp.Services;
|
||||
|
||||
namespace ObsidianMcp.Tools;
|
||||
|
||||
[McpServerToolType]
|
||||
public class ReadFileTool(VaultPathResolver resolver, IHttpContextAccessor http)
|
||||
{
|
||||
[McpServerTool]
|
||||
[Description(
|
||||
"Read the full content of a vault file (UTF-8). " +
|
||||
"This is the primary tool for reading notes, design docs, logs, and config files. " +
|
||||
"Use get_metadata first if you want to check the file size before reading. " +
|
||||
"For very large files (>100 KB), use the offset and limit parameters (in bytes) " +
|
||||
"to read specific byte ranges and avoid context window overflow. " +
|
||||
"Returns the raw Markdown text including frontmatter.")]
|
||||
public async Task<string> ReadFile(
|
||||
[Description("Vault-relative path to the file. " +
|
||||
"e.g. 'NAS/NAS 总览.md', 'PROFILE.md', '02-ShengquGames/logs/2026-05.md'")] string path,
|
||||
[Description("Byte offset to start reading from (0-based). Omit to read from the beginning.")] long? offset = null,
|
||||
[Description("Number of bytes to read. Omit to read the entire file.")] long? limit = null)
|
||||
{
|
||||
ToolScopeGuard.EnsureScope(http, ScopePolicies.ReadObsidian);
|
||||
|
||||
var absPath = resolver.Resolve(path);
|
||||
|
||||
if (!File.Exists(absPath))
|
||||
throw new FileNotFoundException($"文件不存在:{path}");
|
||||
|
||||
// 无分页时直接读全文
|
||||
if (offset is null && limit is null)
|
||||
return await File.ReadAllTextAsync(absPath);
|
||||
|
||||
// 有分页参数时按字节切片
|
||||
await using var fs = new FileStream(absPath, FileMode.Open, FileAccess.Read, FileShare.Read);
|
||||
|
||||
long startByte = offset ?? 0;
|
||||
if (startByte < 0) startByte = 0;
|
||||
if (startByte >= fs.Length)
|
||||
return string.Empty;
|
||||
|
||||
fs.Seek(startByte, SeekOrigin.Begin);
|
||||
|
||||
long bytesToRead = limit.HasValue
|
||||
? Math.Min(limit.Value, fs.Length - startByte)
|
||||
: fs.Length - startByte;
|
||||
|
||||
var buffer = new byte[bytesToRead];
|
||||
var read = await fs.ReadAsync(buffer.AsMemory(0, (int)bytesToRead));
|
||||
|
||||
return System.Text.Encoding.UTF8.GetString(buffer, 0, read);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user