关键词

GitHub仓库内容文件访问代码浏览上下文信息

使用说明

项目简介

该MCP服务器名为“MCP GitHub Repository Server”，旨在为AI助手（如 Claude）提供访问GitHub仓库内容的能力。通过此服务器，AI助手可以浏览、读取指定GitHub仓库的文件，从而获取代码、文档或其他文本信息作为上下文，提升对话和处理任务的智能化水平。

主要功能点

  • 资源访问: 允许AI助手通过资源URI访问GitHub仓库中的任何文件。
  • 目录浏览: 支持列出仓库内容和导航到不同的目录。
  • 分支支持: 可以访问特定分支的文件内容。
  • 纯文本内容: 文件内容以纯文本格式提供给AI助手。

安装步骤

  1. 安装依赖: 确保已安装 Node.js 和 npm。在项目根目录下运行以下命令安装项目依赖： 
    npm install
  2. 构建服务器: 运行以下命令构建服务器： 
    npm run build
    构建成功后，会在 'build' 目录下生成服务器程序 'index.js'。

服务器配置

MCP服务器需要配置以下环境变量才能正常运行。请在部署服务器的环境中设置这些环境变量。

  • 'GITHUB_PERSONAL_ACCESS_TOKEN': 必需。您的 GitHub 个人访问令牌，用于服务器认证 GitHub API。请确保此令牌具有访问目标仓库内容的权限。
  • 'GITHUB_OWNER': 必需。GitHub 仓库的拥有者用户名或组织名。
  • 'GITHUB_REPO': 必需。GitHub 仓库的名称。
  • 'GITHUB_BRANCH': 可选。要访问的 GitHub 仓库分支名称。如果未设置，则默认访问主分支。

MCP客户端配置

要将此MCP服务器与MCP客户端（例如 Claude Desktop）配合使用，您需要在MCP客户端的配置文件中添加服务器配置信息。以 Claude Desktop 为例，您需要在配置文件 'claude_desktop_config.json' 中 'mcpServers' 字段下添加以下配置：

{
  "mcpServers": {
    "github-repo-server": {  // 服务器名称，可以自定义，用于在客户端中标识
      "command": "/path/to/mcp-server-github-repo/build/index.js" //  指向服务器构建后的入口文件路径。请替换为实际路径
    }
  }
}

注意:

  • '/path/to/mcp-server-github-repo/build/index.js' 需要替换为服务器程序 'index.js' 在您文件系统中的实际绝对路径。
  • 'github-repo-server' 是您为该服务器自定义的名称，在客户端中通过此名称引用该服务器。

基本使用方法

  1. 启动配置好的MCP服务器。服务器程序将在后台运行，并通过stdio与MCP客户端通信。

  2. 在MCP客户端中，配置并连接到已启动的“GitHub Repository Server”。

  3. 在支持资源访问的AI应用中，可以使用符合该服务器定义的资源URI来访问GitHub仓库中的文件。例如，要访问仓库根目录下的 'README.md' 文件，可以使用类似以下的URI（具体格式取决于客户端如何解析和发送资源请求，以下仅为示例）：

    https://api.github.com/repos/{GITHUB_OWNER}/{GITHUB_REPO}/contents/README.md

    服务器会将 'README.md' 文件的内容以纯文本形式返回给客户端，供AI应用使用。

调试说明 如果遇到问题，可以使用仓库 'README.md' 中提到的 MCP Inspector 工具进行调试。

信息

分类

开发者工具

访问项目