关键词

GitHub上传项目管理仓库创建Cursor IDE集成代码托管

使用说明

项目简介

Project2GitHub 是一个MCP（Model Context Protocol）服务器，旨在简化本地项目上传到 GitHub 的流程。通过与 Cursor IDE 等 MCP 客户端集成，用户可以方便地通过图形界面或命令调用，将本地代码仓库快速上传到 GitHub，并支持创建私有仓库。

主要功能点

  • 一键上传项目到 GitHub: 简化 GitHub 仓库创建和代码推送流程。
  • 支持私有仓库: 可以选择创建公开或私有 GitHub 仓库。
  • 自动 Git 初始化: 自动在本地项目目录初始化 Git 仓库并进行配置。
  • Cursor IDE 集成: 通过 MCP 协议与 Cursor IDE 无缝集成，方便在 IDE 中直接使用。
  • 详细日志记录: 提供详细的日志文件，方便问题排查和监控。

安装步骤

  1. 克隆仓库: 
    git clone https://github.com/Jamesun921/project2github.git
cd project2github
  2. 安装依赖: 确保已安装 Python 3.6+ 和 pip，然后运行： 
    pip install -r requirements.txt
  3. 配置 GitHub 访问令牌: 在项目根目录下创建 '.env' 文件，并添加您的 GitHub Personal Access Token： 
    GITHUB_TOKEN=your_github_personal_access_token
    请确保该 Token 具有 'repo' 权限。

服务器配置

要将此 MCP 服务器集成到 Cursor IDE 或其他 MCP 客户端，您需要配置服务器的启动命令和参数。以下是配置信息示例（JSON 格式）：

{
  "server name": "github-project-manager",
  "command": "python",
  "args": [
    "path/to/project2github.py",
    "--mcp"
  ]
}

参数说明:

  • 'server name': 服务器的名称，在 Cursor IDE 中用于标识。建议设置为 'github-project-manager'。
  • 'command': 启动服务器的命令，这里使用 'python'。
  • 'args': 传递给启动命令的参数列表。
    • '"path/to/project2github.py"': 请替换为 'project2github.py' 脚本的实际路径。
    • '"--mcp"': 指定以 MCP 服务器模式启动。

请注意: 'path/to/project2github.py' 需要根据 'project2github.py' 文件在您本地文件系统中的实际位置进行调整。

基本使用方法

  1. 启动 MCP 服务器: 在终端中运行 'python path/to/project2github.py --mcp' 或使用提供的 'start_mcp_server.bat' 批处理文件。
  2. 在 Cursor IDE 中配置 MCP 服务器: 按照 Cursor IDE 的 MCP 服务器配置指南，添加上面提供的服务器配置信息。
  3. 通过 Cursor IDE 调用工具: 在 Cursor IDE 中，您可以使用 'github-project-manager.upload_to_github' 工具上传项目。需要提供的参数包括： 
    {
    "directory": "/path/to/your/project",  // 本地项目目录的绝对路径，例如 "/Users/yourname/Documents/my_project"
    "name": "optional-repo-name",         // (可选) GitHub 仓库名称，如果为空则默认使用目录名
    "private": true                         // (可选) 是否创建私有仓库，默认为 true
}
    将上述 JSON 参数提供给 'upload_to_github' 工具，即可触发项目上传流程。服务器会在日志 'github_mcp.log' 中记录详细的操作信息。

信息

分类

开发者工具

访问项目