项目简介

'Obsidian GitHub MCP' 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在将您存储在 GitHub 仓库中的 Obsidian 笔记库与各种 AI 助手无缝集成。它允许 AI 访问、搜索和分析您的 Obsidian 笔记和文档，从而将您的知识库转化为 AI 可用的上下文信息源。

主要功能点

知识库访问: 从 GitHub 上的 Obsidian 仓库中检索指定笔记或文件内容。
智能搜索: 提供多种搜索模式（按文件名、按路径、按内容或全面搜索），帮助 AI 助手快速定位相关信息。
项目管理集成: 搜索与知识库项目相关的 GitHub Issues 和讨论。
知识演变追踪: 获取详细的提交历史和文件变更（diffs），了解您的想法和笔记如何随时间演变。
诊断工具: 提供诊断功能，帮助检查仓库连接、搜索能力和索引状态。

安装步骤

推荐使用 Smithery CLI (适用于 Claude Desktop, Cursor 等 MCP 客户端): 在命令行中运行以下命令，替换 '--client' 参数为您的 MCP 客户端名称：

# 例如，为 Claude Desktop 安装
npx -y @smithery/cli install @Hint-Services/obsidian-github-mcp --client claude
# 为 Cursor 安装
npx -y @smithery/cli install @Hint-Services/obsidian-github-mcp --client cursor

手动安装 (Node.js 环境): 如果您手动管理 MCP 服务器，可以在您的项目目录中运行：
```
npm install obsidian-github-mcp
```

服务器配置

此 MCP 服务器通过环境变量获取其运行所需的 GitHub 访问凭据和仓库信息。您需要在 MCP 客户端的配置文件中指定服务器的启动命令，并设置相应的环境变量。

通常，在您的 MCP 客户端配置文件的 'mcpServers' 部分，您需要为 'obsidianGithub' 服务器（或其他您选择的名称）提供以下信息：

'command' (启动命令): 设置为 'npx'。
'args' (启动参数): 设置为 '["-y", "obsidian-github-mcp"]'。
'env' (环境变量): 在这里定义以下变量：
- 'GITHUB_TOKEN': 您的 GitHub 个人访问令牌。该令牌需要 'repo' (针对私有仓库) 或 'public_repo' (针对公共仓库) 权限，如果访问组织仓库还需要 'read:org' 权限。请访问 GitHub Token 设置创建。
- 'GITHUB_OWNER': GitHub 仓库的拥有者用户名或组织名称。
- 'GITHUB_REPO': 包含您 Obsidian 笔记库的 GitHub 仓库名称。

基本使用方法

配置完成后，您的 AI 助手即可通过调用此 MCP 服务器提供的工具来与 GitHub 上的 Obsidian 知识库互动。以下是一些示例用法：

获取特定笔记内容: AI 可以请求获取 'Daily Notes/2024-01-15.md' 文件的内容。
按文件名搜索文件: AI 可以搜索名为 'OKR 2025' 的文件（使用 'searchIn: "filename"' 参数）。
按内容搜索研究资料: AI 可以搜索包含 'machine learning algorithms' 关键词的文件内容（使用 'searchIn: "content"' 参数）。
追踪知识库演变: AI 可以请求过去 30 天的提交历史，包括文件变更详情。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息