AI导哈

Obsidian MCP服务器

Obsidian MCP是一个模型上下文协议服务器，允许AI助手通过本地REST API插件与Obsidian库交互。

  • by shaike1
  • Shell
  • 本地部署
  • 更新于
在 GitHub 查看 shaike1/obsidian-mcp

使用说明

黑曜石MCP设置

用于将黑曜石MCP添加到新机器的自动设置脚本和文档。

什么是黑曜石MCP？

黑曜石MCP 是一个模型上下文协议服务器，允许AI助手（Claude、GitHub Copilot等）通过本地REST API插件与您的黑社会保险库交互。

快速开始

先决条件

  • Python 3.7+ （或紫外线）
  • 黑曜石 随着 本地REST API社区插件 安装
  • API密钥 从插件

安装

1.安装Obsidian本地REST API插件

黑曜石：

  1. 设置→ 社区插件→ 浏览
  2. 搜索 “本地REST API” 通过 coddingtonbear
  3. 安装并启用
  4. 复制您的 API密钥 来自插件设置
  5. 注意你的 主机 和 端口 （默认值：127.0.0.1:27124）

2.安装MCP黑曜石服务器

pip install mcp-obsidian

或者使用uvx：

# uvx will handle installation automatically
uvx mcp-obsidian

3.运行安装脚本

bash <(curl -fsSL https://raw.githubusercontent.com/shaike1/obsidian-mcp/main/setup-mcp-obsidian.sh) \
  --api-key YOUR_API_KEY \
  --host 192.168.88.30 \
  --port 27124

或本地：

git clone https://github.com/shaike1/obsidian-mcp.git
cd obsidian-mcp
chmod +x setup-mcp-obsidian.sh
./setup-mcp-obsidian.sh --api-key YOUR_API_KEY --host 192.168.88.30 --port 27124

配置

GitHub Copilot的手动配置

mkdir -p ~/.copilot
cat > ~/.copilot/mcp-config.json << 'EOFCONFIG'
{
  "mcpServers": {
    "obsidian": {
      "type": "local",
      "command": "mcp-obsidian",
      "args": [],
      "tools": ["*"],
      "env": {
        "OBSIDIAN_API_KEY": "YOUR_API_KEY_HERE",
        "OBSIDIAN_HOST": "192.168.88.30",
        "OBSIDIAN_PORT": "27124"
      }
    }
  }
}
EOFCONFIG

Claude手动配置（带uvx）

mkdir -p ~/.claude
cat > ~/.claude/claude_desktop_config.json << 'EOFCONFIG'
{
  "mcpServers": {
    "obsidian": {
      "command": "uvx",
      "args": ["mcp-obsidian"],
      "env": {
        "OBSIDIAN_API_KEY": "YOUR_API_KEY_HERE",
        "OBSIDIAN_HOST": "192.168.88.30",
        "OBSIDIAN_PORT": "27124"
      }
    }
  }
}
EOFCONFIG

可用工具

  • list_files_in_vault -列出所有vault文件
  • list_files_in_dir -列出目录中的文件
  • get_file_contents -读取文件内容
  • batch_get_file_contents -读取多个文件
  • simple_search -文本搜索
  • complex_search -高级搜索
  • put_content -创建/更新文件
  • append_content -附加到文件
  • patch_content -补丁部分
  • delete_file -删除文件
  • get_periodic_note -获取当前定期票据
  • get_recent_periodic_notes -获取最近的笔记
  • get_recent_changes -获取最近修改的文件

故障排除

“mcp黑曜石：找不到命令”

pip install --upgrade mcp-obsidian

“连接被拒绝”

  • 确保黑曜石正在运行
  • 检查本地REST API插件是否已启用
  • 验证主机和端口是否正确

“未经授权”（401）

  • 验证您的API密钥是否正确
  • 如果需要，在插件设置中重新生成密钥

网络问题

# Test connectivity
ping 192.168.88.30
nc -zv 192.168.88.30 27124

此回购中的文件

  • setup-mcp-obsidian.sh -自动设置脚本
  • MCP-Obsidian-Setup-Guide.md -完整的文档
  • README.md -此文件

文档

有关完整文档，请参阅 MCP-Obsidian-Setup-Guide.md

参考文献

安全

⚠️ 永远不要将API密钥提交到公共存储库。使用环境变量或密码管理器安全地存储它们。

由以下材料制成❤️

相关 MCP