Obsidian Github MCP

🚀 Obsidian GitHub MCP

AIアシスタントを、Obsidianボルトを含むGitHubリポジトリに接続するModel Context Protocol (MCP)サーバーです。このサーバーにより、GitHub上に保存された知識ベースとのシームレスな統合が可能になり、AIアシスタントがObsidianのノートやドキュメントを読み取り、検索し、分析できるようになります。

🚀 クイックスタート

このセクションでは、Obsidian GitHub MCPの概要と、その利用方法について説明します。

✨ 主な機能

• GitHubリポジトリアクセス：Obsidianボルトを含む任意のGitHubリポジトリに接続できます。
• 型安全な実装：TypeScriptで記述され、包括的な型定義があります。
• 入力検証：Zodスキーマを使用して、すべてのAPI入力に対して堅牢な検証を行います。
• エラーハンドリング：有益なメッセージを伴うエラーハンドリングが行われます。
• MCP統合：Claude、Cursor、Windsurf、ClineなどのMCPホストと完全に互換性があります。

📦 インストール

Smitheryを使用する（推奨）

Obsidian GitHub MCPをインストールする最も簡単な方法は、Smitheryを使用することです。

# For Claude Desktop
npx -y @smithery/cli install @Hint-Services/obsidian-github-mcp --client claude

# For Cursor
npx -y @smithery/cli install @Hint-Services/obsidian-github-mcp --client cursor

# For Windsurf
npx -y @smithery/cli install @Hint-Services/obsidian-github-mcp --client windsurf

# For Cline
npx -y @smithery/cli install @Hint-Services/obsidian-github-mcp --client cline

手動インストール

npm install obsidian-github-mcp

📚 ドキュメント

利用可能なツール

知識ベースアクセス

• getFileContents：Obsidianボルト内の特定のノート、ドキュメント、またはファイルの内容を取得します。
• searchFiles：複数のモードで強化された検索が可能です。
  • filename：正確なファイル名でファイルを検索します（「OKR 2025」のような検索に最適）。
  • path：ファイルパス内の任意の場所を検索します。
  • content：ファイル内容内を検索します。
  • all：ファイル名、パス、および内容全体を包括的に検索します。

プロジェクト管理統合

• searchIssues：知識ベースプロジェクトに関連する問題や議論を検索します。
• getCommitHistory：詳細なコミット履歴と差分を使用して、知識ベースが時間の経過とともにどのように進化したかを追跡します。

ユースケース

知識労働者向け

• 研究アシスタント：AIが研究ノートや参考資料にアクセスできます。
• 執筆支援：知識ベースから関連する背景情報を取得できます。
• アイデア開発：ノート全体で概念がどのように進化したかを追跡できます。

開発者向け

• ドキュメントアクセス：プロジェクトドキュメントや技術ノートを取得できます。
• 学習ジャーナル：学習ノートやコード例にアクセスできます。
• プロジェクト計画：GitHubの問題と統合して、包括的なプロジェクト管理を行えます。

学生や学者向け

• 学習資料：講義ノートや学習ガイドにアクセスできます。
• 研究論文：研究ノートや引用文献を取得できます。
• コラボレーション：GitHubに保存された共有知識ベースで共同作業ができます。

設定

次の設定を使用して、サーバーをMCP設定ファイルに追加します。

{
  "mcpServers": {
    "obsidianGithub": {
      "command": "npx",
      "args": ["-y", "obsidian-github-mcp"],
      "env": {
        "GITHUB_TOKEN": "your-github-token",
        "GITHUB_OWNER": "your-github-username",
        "GITHUB_REPO": "your-obsidian-vault-repo"
      }
    }
  }
}

必要な環境変数

• GITHUB_TOKEN：あなたのGitHub個人アクセストークン (ここで作成)
• GITHUB_OWNER：GitHubリポジトリの所有者/組織
• GITHUB_REPO：あなたのObsidianボルトを含むリポジトリの名前

GitHubトークンの権限

あなたのGitHubトークンには、次の権限が必要です。

• repo（プライベートリポジトリの場合）またはpublic_repo（パブリックリポジトリの場合）
• read:org（組織リポジトリにアクセスする場合）

サンプルワークフロー

日次ノートへのアクセス

{
  "tool": "getFileContents",
  "arguments": {
    "filePath": "Daily Notes/2024-01-15.md"
  }
}

ファイル名でのファイル検索（「OKR 2025」の例に最適！）

{
  "tool": "searchFiles",
  "arguments": {
    "query": "OKR 2025",
    "searchIn": "filename"
  }
}

パスでのファイル検索

{
  "tool": "searchFiles",
  "arguments": {
    "query": "Daily Notes",
    "searchIn": "path"
  }
}

トピックに関する研究の検索（内容検索）

{
  "tool": "searchFiles",
  "arguments": {
    "query": "machine learning algorithms",
    "searchIn": "content",
    "perPage": 10
  }
}

包括的な検索（ファイル名、パス、および内容）

{
  "tool": "searchFiles",
  "arguments": {
    "query": "project planning",
    "searchIn": "all"
  }
}

高度なGitHub検索構文

{
  "tool": "searchFiles",
  "arguments": {
    "query": "path:*.md extension:md",
    "searchIn": "content"
  }
}

知識の進化の追跡

{
  "tool": "getCommitHistory",
  "arguments": {
    "days": 30,
    "includeDiffs": true,
    "maxCommits": 10
  }
}

検索ヒントとトラブルシューティング

ファイル名でファイルが見つからない場合

問題：「OKR 2025」を検索しても、「OKR 2025.md」という名前のファイルが見つからない。 解決策：searchIn: "filename"パラメータを使用します。

{
  "tool": "searchFiles",
  "arguments": {
    "query": "OKR 2025",
    "searchIn": "filename"
  }
}

高度な検索手法

1. 正確なフレーズ：複数単語の検索には引用符を使用します。

   {
     "query": "\"project planning 2025\"",
     "searchIn": "content"
   }
   

2. ファイル拡張子：特定のファイルタイプを検索します。

   {
     "query": "path:*.md",
     "searchIn": "content"
   }
   

3. ディレクトリ指定：フォルダ内を検索します。

   {
     "query": "path:\"Daily Notes/\"",
     "searchIn": "content"
   }
   

プロジェクト構造

obsidian-github-mcp/
├── src/
│   ├── index.ts          # メインのMCPサーバーエントリポイント
│   └── github/           # GitHub API統合
│       ├── client.ts     # GitHubクライアントの実装
│       └── types.ts      # TypeScriptの型定義
├── docs/                 # ドキュメント
├── package.json          # プロジェクト構成
└── tsconfig.json         # TypeScript構成

開発者向け

このプロジェクトに貢献したい場合、またはこのサーバーを使用して独自のツールを開発したい場合は、開発ガイドを参照してください。

開発コマンド

• pnpm install - 依存関係をインストールします。
• pnpm run build - プロジェクトをビルドします。
• pnpm run dev - インスペクター付きで開発モードで実行します。
• pnpm run inspector - テスト用のMCPインスペクターを起動します。

mcp-private-github-searchからの移行

古いmcp-private-github-searchパッケージから移行する場合：

1. 設定内のパッケージ名を更新します。

   {
     "mcpServers": {
       "obsidianGithub": {
         "command": "npx",
         "args": ["-y", "obsidian-github-mcp"]
       }
     }
   }
   

2. 機能は同じままです - すべての既存のツールは同じように動作します。
3. 新しいObsidianに焦点を当てたユースケースとワークフローを検討してください。

詳細情報

MCPエコシステムに関する詳細情報については、以下を参照してください。

• Model Context Protocol Documentation：MCPのアーキテクチャと設計原則の詳細な説明
• Smithery - MCP Server Registry：MCPサーバーを公開するためのガイドライン
• MCP TypeScript SDK Documentation：包括的なTypeScript SDKドキュメント
• Obsidian：このツールのインスピレーションとなった知識管理アプリ

Hint Servicesについて

"未来はすでに存在している、ただ均等に分布していないだけだ"

— ウィリアム・ギブソン、作家

Hint Servicesは、ユーザーインターフェイスが人工知能技術をどのように活用するかを開発・拡大することを使命とするブティックコンサルティング会社です。AIとユーザー体験の交差点で野心的なアーキテクチャを構築し、ベン・ホファーバーによって設立・率いられています。

私たちは、開発者にならずにAIツールを受け入れたいデザインチーム向けに、専門的なAIワークショップを提供しています。私たちのトレーニングとワークショップについて詳しく学ぶ