GitHub MCP Server 使用说明

项目简介

GitHub MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器，旨在为大型语言模型（LLM）客户端提供操作 GitHub 仓库的能力。通过该服务器提供的工具，LLM 可以创建新的 GitHub 仓库，以及更新现有仓库的描述、标签和网站信息。这使得 LLM 能够自动化 GitHub 仓库管理任务，例如在代码生成后自动创建仓库进行托管。

主要功能点

创建 GitHub 仓库：根据自然语言描述自动生成仓库名称，并支持设置仓库描述、标签 (topics) 和网站 (homepage)。
更新仓库信息：允许更新现有 GitHub 仓库的描述、标签和网站。
自然语言指令：通过简洁的自然语言指令调用工具，无需编写复杂的 API 代码即可完成 GitHub 仓库操作。

安装步骤

克隆仓库

git clone https://github.com/PoliTwit1984/github-meta-mcp-server
cd github-meta-mcp-server

安装依赖
```
npm install
```
构建服务器
```
npm run build
```

服务器配置

为了让 MCP 客户端能够连接并使用 GitHub MCP Server，需要在 MCP 客户端的配置文件中添加以下服务器配置信息。请将以下 JSON 代码添加到你的 MCP 客户端配置文件的 'mcpServers' 字段中。

{
  "mcpServers": {
    "github": {
      "command": "node",
      "args": ["path/to/github-server/build/index.js"], // 将 "path/to/github-server" 替换为你的 github-meta-mcp-server 仓库的实际路径
      "env": {
        "GITHUB_TOKEN": "YOUR_GITHUB_PERSONAL_ACCESS_TOKEN" // 替换为你的 GitHub Personal Access Token，需要 repo 创建权限
      }
    }
  }
}

配置参数说明：

'server name': 'github' (服务器名称，在 MCP 客户端调用工具时需要指定)
'command': 'node' (运行服务器的命令，这里使用 Node.js)
'args': '["path/to/github-server/build/index.js"]' (服务器启动参数，指向构建后的 'index.js' 文件，请务必替换为实际路径)
'env': 环境变量配置
- 'GITHUB_TOKEN': 你的 GitHub Personal Access Token，必须替换为你的实际 Token。该 Token 需要拥有 'repo' 权限才能创建和更新仓库。

基本使用方法

启动 GitHub MCP Server：服务器会在 MCP 客户端连接时自动启动，无需手动运行。

在 MCP 客户端中调用 'create_repo' 工具：

指定 'server_name' 为 '"github"'。
指定 'tool_name' 为 '"create_repo"'。
在 'arguments' 中提供 'command' 参数，使用自然语言描述 GitHub 仓库操作。

示例 (TypeScript 代码，假设你使用 MCP 客户端 SDK):

import { use_mcp_tool } from 'your-mcp-client-sdk'; // 替换为你的 MCP 客户端 SDK

async function createGitHubRepo() {
  const result = await use_mcp_tool({
    server_name: "github",
    tool_name: "create_repo",
    arguments: {
      command: "Create a repository for my machine learning project with tags python tensorflow website https://example.com/ml-docs"
    }
  });

  if (result.isError) {
    console.error("Error creating repository:", result.content[0].text);
  } else {
    console.log("Repository creation result:", result.content[0].text);
  }
}

createGitHubRepo();

上述代码将会指示 GitHub MCP Server 创建一个名为 "my-machine-learning-project" 的仓库，并设置描述、标签和网站。 你可以根据需要修改 'command' 参数来执行不同的仓库操作，例如更新仓库描述、标签或网站等，具体指令格式请参考仓库 README 文档中 "Available Tools" 部分的说明。

关键词