WithContext MCP Server

让您的AI编码代理直接写入笔记应用。 WithContext为与Obsidian合作的AI代理提供了项目范围内的笔记管理，使它们能够在编写代码时创建文档、跟踪更改并组织知识。

为什么选择WithContext？

您的AI编码代理需要一个地方来存储文档、会议记录和项目更新。WithContext赋予它们直接访问您的Obsidian保险库的能力，包括：

• 自动项目范围划分 - 每个项目都有自己的文件夹，避免交叉污染
• 智能编辑 - 代理可以更新元数据、替换部分、在内容前后添加
• 会话跟踪 - 使用变更日志和待办事项跟踪代理所做的更改
• 智能组织 - 内置预设以保持保险库整洁
• 模板系统 - 专业模板以保持文档一致

您只需设置一次。您的AI代理处理其余部分。

快速设置

1. 安装Obsidian REST API插件

1. 打开Obsidian设置 → 社区插件 → 浏览
2. 搜索**“本地REST API”**并安装
3. 启用插件并复制您的API密钥

2. 安装WithContext

npm install -g with-context-mcp

3. 配置您的AI客户端

在您的AI客户端的MCP配置中添加以下内容：

OpenCode (opencode.jsonc)：

{
  "mcp": {
    "with-context": {
      "type": "local",
      "command": "npx",
      "args": ["-y", "with-context-mcp"],
      "environment": {
        "OBSIDIAN_API_KEY": "{env:OBSIDIAN_API_KEY}",
        "OBSIDIAN_API_URL": "{env:OBSIDIAN_API_URL}",
        "OBSIDIAN_VAULT": "{env:OBSIDIAN_VAULT}",
        "PROJECT_BASE_PATH": "{env:PROJECT_BASE_PATH}",
      },
      "enabled": true,
    },
  },
}

其他客户端： Claude Desktop, Cline, Cursor, Windsurf, Continue.dev, GitHub Copilot →

4. 设置环境变量

export OBSIDIAN_API_KEY="your_api_key_here"
export OBSIDIAN_API_URL="https://127.0.0.1:27124"
export OBSIDIAN_VAULT="MyVault"
export PROJECT_BASE_PATH="Projects"

就这样！ 您的AI代理现在可以访问超过33种工具来管理MyVault/Projects/中的笔记。

您的代理可以做什么

一旦配置完成，您的AI编码代理可以：

• 创建和更新文档 在编写代码时
• 跟踪更改 自动生成变更日志和待办事项
• 整理保险库 使用智能预设
• 编辑YAML元数据 添加标签和元数据
• 搜索和更新现有笔记 根据内容或文件名
• 从模板生成笔记 保持格式一致
• 替换特定部分 在markdown文件中通过标题

您不需要学习这些工具。 您的AI代理将在需要记录某些内容、跟踪更改或整理笔记时自动使用它们。

示例工作流程

当您的AI代理处理一个特性时，它可能会：

1. 开始会话：start_session({ project_folder: 'my-app' })
2. 创建API文档：write_note({ path: 'docs/api.md', content: '...' })
3. 跟踪更改：add_changelog_entry({ type: 'feature', message: '添加用户API' })
4. 添加待办事项：add_todo({ content: '编写集成测试' })
5. 更新元数据：update_frontmatter({ path: 'docs/api.md', frontmatter: { status: '草稿' } })

您的保险库会自动保持如下组织：

MyVault/Projects/my-app/
├── docs/api.md
└── CHANGELOG.md

文档

设置： 安装及设置 • 配置

参考： 所有工具 • 常见工作流 • 会话 • 保险库组织

v3.0.6 新增功能

• 前置模式 - 将内容添加到笔记的开头
• update_frontmatter - 使用合并/替换模式编辑YAML元数据
• 模糊查找 - 快速文件搜索并高亮匹配项
• replace_section - 通过标题编辑特定的markdown部分

完整变更日志 →

可用工具

您的AI代理可以访问6类33种工具：

类别	工具
核心	写入、读取、列出、搜索、删除、批量写入、获取元数据
编辑	更新元数据、替换部分
会话	开始、暂停、恢复、结束、状态、变更日志、待办事项、提交建议
组织	分析结构、生成计划、重新组织
配置	设置、验证、预览、导入、传送、同步
模板	列出模板、从模板创建

详细工具文档 →

故障排除

连接问题？ 确保Obsidian正在运行，本地REST API插件已启用，并且OBSIDIAN_API_URL与插件端口匹配（默认：2.7124）

身份验证失败？ 验证插件设置中的OBSIDIAN_API_KEY并检查是否有额外空格

路径错误？ 仅使用相对路径（不使用../或绝对路径） - 所有路径都相对于您的项目文件夹

更多帮助 →

安全性

• 项目范围划分 - 操作限制在配置的项目文件夹内
• 路径验证 - 防止目录遍历攻击
• HTTPS - 与Obsidian本地REST API的安全连接
• API密钥认证 - 所有操作都需要

贡献

欢迎贡献！分叉仓库，创建功能分支，添加测试，并提交拉取请求。

贡献指南 →

链接

npm: with-context-mcp • GitHub: boxpositron/with-context-mcp • 问题报告: 报告错误或请求功能

---

专为AI编码代理及其合作的人类设计