Github Repository Manager

🚀 GitHub MCP 服务器

GitHub MCP 服务器是一个基于模型上下文协议（MCP）的工具，它能与 GitHub API 进行交互。目前，该服务器支持根据描述、主题和网址来创建仓库，为开发者提供了便捷的仓库管理方式。

🚀 快速开始

GitHub MCP 服务器允许你通过自然语言命令与 GitHub API 交互，轻松创建和管理仓库。下面将为你详细介绍使用前的安装和配置步骤。

✨ 主要特性

• 自动命名创建仓库：根据输入的描述自动生成合适的名称，快速创建 GitHub 仓库。
• 主题/标签添加：为创建的仓库添加主题或标签，方便对仓库进行分类和检索。
• 主页设置：可自定义仓库的主页，展示仓库的相关信息。
• 自动初始化：创建仓库时，自动初始化带有 README 文件的仓库，为项目提供基础说明。

📦 安装指南

1. 克隆仓库：将项目仓库克隆到本地。
2. 安装依赖项：在项目根目录下，执行以下命令安装所需依赖：

npm install

3. 构建服务器：安装完依赖后，构建服务器：

npm run build

📚 详细文档

配置说明

该服务器需要一个具有仓库创建权限的 GitHub 个人访问令牌。你需要将以下内容添加到 MCP 设置文件中：

{
  "mcpServers": {
    "github": {
      "command": "node",
      "args": ["path/to/github-server/build/index.js"],
      "env": {
        "GITHUB_TOKEN": "your-github-token"
      }
    }
  }
}

可用工具

create_repo

此工具可使用自然语言命令创建或更新 GitHub 仓库。

命令格式

该工具支持多种自然语言命令来执行不同操作：

• 创建仓库：

为 [描述] 创建一个仓库，带有标签 [tag1 tag2 tag3] 网站 [url]

或者

新建一个名为 [描述] 的仓库，并添加标签 [tag1, tag2, tag3]

• 更新仓库描述：

将 [owner/repo] 描述更改为 [新描述]

或者

将 [repo-name] 的描述设置为 [新描述]

• 更新仓库标签：

将 [owner/repo] 标签更改为 [tag1 tag2 tag3]

或者

将 [repo-name] 的主题设置为 [tag1, tag2, tag3]

• 更新仓库网站：

将 [owner/repo] 网站更改为 [url]

或者

将 [repo-name] 的主页设置为 [url]

示例用法

• 创建新仓库：

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

这将完成以下操作：

1. 创建名为 "my-machine-learning-image-classifier" 的仓库。
2. 设置描述为 "my machine learning image classifier"。
3. 添加 "python", "tensorflow" 和 "computer-vision" 作为仓库主题。
4. 设置网站为 "https://example.com/docs"。
5. 初始化带 README 文件的仓库。

• 更新仓库描述：

const result = await use_mcp_tool({
  server_name: "github",
  tool_name: "create_repo",
  arguments: {
    command: "Update username/existing-repo description to Updated ML project for image classification"
  }
});

• 更新仓库标签：

const result = await use_mcp_tool({
  server_name: "github",
  tool_name: "create_repo",
  arguments: {
    command: "Update username/existing-repo tags to machine-learning python updated"
  }
});

• 更新仓库网站：

const result = await use_mcp_tool({
  server_name: "github",
  tool_name: "create_repo",
  arguments: {
    command: "Update username/existing-repo website to https://example.com/new-docs"
  }
});

该工具能够理解多种自然语言模式和关键词：

• 创建仓库：Create/make/new
• 更新仓库：Update/change/set/modify
• 更新描述：description to/as
• 更新主题：tags/topics to/as
• 更新网站：website/url

开发说明

若要修改或扩展服务器代码，请按以下步骤操作：

1. 修改 src 文件夹中的文件。
2. 在终端运行以下命令进行构建：

npm run build

📄 许可证

本项目采用 MIT 许可证。