Obsidan GitHub

MCP Server to search individual private Github Repositories

typescript

8

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "hint-services-obsidian-github-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "obsidian-github-mcp"
      ],
      "env": {
        "GITHUB_REPO": "YOUR_OBSIDIAN_VAULT_REPO",
        "GITHUB_OWNER": "YOUR_GITHUB_OWNER",
        "GITHUB_TOKEN": "YOUR_GITHUB_TOKEN"
      }
    }
  }
}

You can connect AI assistants to your Obsidian vaults stored in GitHub using the Obsidian GitHub MCP server. This server lets you read, search, and analyze your Obsidian notes from your AI environment, while enabling you to track changes, access files, and integrate with GitHub-based project workflows.

How to use

Install and run the Obsidian GitHub MCP server in your MCP environment, then configure your MCP client to communicate with it. Once connected, you can use the available tools to retrieve file contents, search across filenames, paths, and content, and integrate with GitHub issues and commit history. You can craft workflows where your AI assistant fetches notes for background research, pulls related documents for writing tasks, or traces the evolution of concepts through commit history.

How to install

Prerequisites you need before installing:
- Node.js (LTS version recommended) and npm (or yarn).
- Access to a GitHub repository containing your Obsidian vault if you plan to use the GitHub integration.

Option A: Using Smithery (recommended for quick setup) Run one of the following commands to install the MCP server for your preferred MCP client.

# 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

Option B: Manual installation

Install the MCP package directly without Smithery to add the server to your environment.

npm install obsidian-github-mcp

Available tools

getFileContents

Retrieve the contents of a specific file or note from the Obsidian vault stored in GitHub.

searchFiles

Search files across the vault by filename, path, content, or all sources with multiple modes like filename, path, content, and all.

searchIssues

Query GitHub issues and discussions related to your knowledge base projects for context and planning.

getCommitHistory

Fetch commit history and diffs to track how your knowledge base has evolved over time.