Loglmhq MCP Server Github Repo

🚀 GitHub 仓库 MCP 协议服务器

本项目实现了一个支持 Model Context Protocol (MCP) 的服务器，旨在为 AI 助手提供访问 GitHub 仓库内容的能力，让其可以浏览并读取指定仓库中的文件，极大地拓展了 AI 助手获取信息的范围。

🚀 快速开始

配置环境变量

服务器运行依赖以下环境变量，请在运行前进行配置：

GITHUB_PERSONAL_ACCESS_TOKEN=your_github_token
GITHUB_OWNER=repository_owner
GITHUB_REPO=repository_name
GITHUB_BRANCH=branch_name  # 可选

安装依赖与构建

安装项目所需的依赖项：

npm install

构建服务器：

npm run build

若需要在开发过程中实现自动重建功能，可使用以下命令：

npm run watch

安装与配置

若要与 Claude 桌面配合使用，需要在相应的配置文件中添加服务器配置：

• MacOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%/Claude/claude_desktop_config.json

在配置文件中添加如下内容：

{
  "mcpServers": {
    "mcp-server-github-repo": {
      "command": "/path/to/mcp-server-github-repo/build/index.js"
    }
  }
}

✨ 主要特性

资源访问

• 灵活的文件访问：可通过 URI 访问仓库中的任意文件。
• 目录导航：支持列出仓库内容并导航目录。
• 多分支支持：允许访问特定分支下的文件。
• 纯文本输出：文件内容以纯文本形式提供。

资源 URI 格式

• 基本 URL 格式：https://api.github.com/repos/{owner}/{repo}/contents/{path}
• 类型支持：既支持文件访问，也支持目录访问。文件使用 text/plain MIME 类型，目录使用 application/x-directory MIME 类型。

📦 安装指南

与 Claude 桌面集成

按照上述配置位置和配置内容，将服务器配置添加到 Claude 桌面的配置文件中，即可完成安装。

💻 使用示例

演示

📚 详细文档

API 实现

服务器实现了三个主要的 MCP 端点：

1. ListResources - 用于列出仓库中的文件和目录。
2. ReadResource - 用于获取特定文件的内容。

认证

服务器采用 GitHub 个人访问令牌进行认证。请确保您的令牌具备访问仓库内容的适当权限。

错误处理

服务器具备完善的错误处理功能，可处理以下常见错误：

• 环境变量缺失
• GitHub API 错误
• 无效路径（例如尝试将目录读取为文件）
• 认证失败

🔧 技术细节

调试

由于 MCP 服务器通过 stdio 通信，调试可能存在一定挑战。您可以使用 MCP 检查器进行调试：

npm run inspector

运行该命令后，将提供一个可在浏览器中访问调试工具的 URL。

安全注意事项

• 请妥善保管您的 GitHub 个人访问令牌，避免泄露。
• 建议使用权限最小的令牌，以降低安全风险。
• 在访问大型仓库时，需注意仓库大小限制。

📄 许可证

本项目采用 MIT 许可证。