Project Hub MCP Server

Project Hub MCP Server

site icon
2025.03.13 2
TypeScript项目管理Git 管理GitHub 集成开发效率
Project Hub MCP Server 是一个全面的项目管理工具,提供本地 Git 功能和 GitHub 集成能力。它支持管理本地项目、跟踪变更、创建本地提交以及与 GitHub 仓库同步。该服务适用于开发团队和个人开发者,帮助他们高效管理项目生命周期。
View on GitHub

Overview

基本能力

产品定位

Project Hub MCP Server 是一个集成了本地 Git 功能和 GitHub 集成的项目管理工具,旨在帮助开发者和团队高效管理项目生命周期。

核心功能

  1. 项目管理
  2. 项目创建和管理,支持灵活、不区分大小写的部分名称搜索
  3. 源文件扫描和监控,可自定义排除模式
  4. 项目元数据跟踪和更新

  5. 本地 Git 功能

  6. 本地提交创建和管理,无需 GitHub
  7. 分支管理(创建、切换、列表)
  8. 文件快照,包含元数据(大小、创建时间、修改时间)
  9. 恢复功能,可回滚到之前的提交或分支
  10. 克隆功能,从提交或分支创建新实例

  11. 变更跟踪

  12. 记录和跟踪变更及相关文件
  13. 按类型分类变更(功能、修复、重构等)
  14. 将变更链接到提交以获取完整历史记录

  15. 笔记系统

  16. 创建和管理项目笔记,支持丰富的 Markdown 内容
  17. 分类和标记笔记以便更好地组织
  18. 搜索功能,查找相关文档

  19. GitHub 集成

  20. 仓库管理(创建、更新、删除、重命名)
  21. 提交管理,跟踪文件内容
  22. 分支操作(创建、删除、合并)
  23. 拉取请求创建和管理
  24. 仓库克隆和本地设置
  25. 多账户 GitHub 支持

适用场景

  1. 个人开发者:管理本地项目,跟踪变更,创建本地提交。
  2. 开发团队:集成 GitHub,管理仓库、分支和拉取请求。
  3. 项目管理:使用笔记系统记录项目文档和决策。
  4. 代码审查:通过变更跟踪和提交管理进行代码审查。

工具列表

  1. 项目管理工具
  2. create_project:创建新项目,管理本地和远程仓库。
  3. find_project:通过名称查找项目(灵活、不区分大小写、部分匹配)。
  4. list_projects:列出所有项目,可选过滤。
  5. update_project_details:更新现有项目的详细信息。
  6. delete_project:删除项目。
  7. scan_project_files:扫描项目目录中的源文件并更新项目记录。
  8. projectdb_location:获取项目数据库位置的完整路径。

  9. 变更管理工具

  10. record_change:记录项目中的变更。
  11. get_pending_changes:获取项目的待处理变更。
  12. clear_committed_changes:清除项目的已提交变更。

  13. 本地 Git 功能工具

  14. init_local_repository:为项目初始化本地 Git 仓库。
  15. create_local_commit:从待处理变更创建本地提交。
  16. get_local_commit_history:获取项目的本地提交历史。
  17. create_local_branch:创建新的本地分支。
  18. switch_local_branch:切换到不同的本地分支。
  19. list_local_branches:列出项目的所有本地分支。
  20. restore_to_local_commit:将项目文件恢复到特定的本地提交。
  21. restore_to_local_branch:将项目文件恢复到特定的本地分支。
  22. restore_local_commit_to_new_location:将特定的本地提交恢复到新的文件夹位置。
  23. restore_local_branch_to_new_location:将特定的本地分支恢复到新的文件夹位置。
  24. push_local_commits:将本地提交推送到 GitHub。
  25. force_local_commit:强制提交项目中的所有文件,无论是否有待处理变更。
  26. cleanup_project_files:从 Project Hub 数据中删除不存在的文件记录。

  27. 文件快照管理工具

  28. get_file_snapshots:获取提交的文件快照。
  29. get_file_snapshots_metadata:获取提交的文件快照元数据(不含文件内容)。
  30. get_file_content:获取快照的文件内容。

  31. 笔记管理工具

  32. create_note:为项目创建新笔记。
  33. update_note:更新现有笔记。
  34. delete_note:删除笔记。
  35. search_notes:在项目中搜索笔记。

  36. 仓库管理工具

  37. create_repository:创建新的 GitHub 仓库。
  38. get_repository:获取特定仓库的详细信息。
  39. update_repository:更新仓库设置。
  40. delete_repository:删除 GitHub 仓库。
  41. rename_repository:重命名 GitHub 仓库。
  42. list_repositories:列出认证用户的所有仓库。
  43. fork_repository:创建现有仓库的分支。
  44. transfer_repository:转移仓库所有权。
  45. clone_repository:将仓库克隆到指定文件夹。

  46. 文件管理工具

  47. get_file:从 GitHub 仓库获取文件内容。

  48. 提交管理工具

  49. create_commit:在 GitHub 仓库中创建提交。
  50. list_commits:列出 GitHub 仓库中的提交。
  51. get_commit:从 GitHub 仓库获取提交详细信息。
  52. revert_commit:在 GitHub 仓库中恢复提交。

  53. 分支管理工具

  54. create_branch:在 GitHub 仓库中创建新分支。
  55. delete_branch:从仓库中删除分支。
  56. list_branches:列出仓库中的所有分支。
  57. get_branch:获取特定分支的详细信息。
  58. merge_branches:合并仓库中的两个分支。

  59. 拉取请求管理工具

    • create_pull_request:创建新的拉取请求。
  60. 实用工具

    • list_tools:列出 Project Hub MCP 中所有可用的工具。

常见问题解答

  1. 如何安装 Project Hub MCP Server?
  2. 克隆仓库:git clone https://github.com/peterparker57/project-hub-mcp-server.git
  3. 安装依赖:npm install
  4. 构建项目:npm run build

  5. 如何配置 GitHub 集成?

  6. 在配置文件中设置 GITHUB_TOKEN 环境变量,提供 GitHub 个人访问令牌。

  7. 如何管理本地 Git 仓库?

  8. 使用 init_local_repository 初始化本地仓库,然后使用 create_local_commitcreate_local_branch 进行管理。

  9. 如何恢复项目到之前的提交?

  10. 使用 restore_to_local_commitrestore_to_local_branch 工具。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 确保已安装 Git。

安装教程

  1. 克隆仓库:
git clone https://github.com/peterparker57/project-hub-mcp-server.git
cd project-hub-mcp-server
  1. 安装依赖:
npm install
  1. 构建项目:
npm run build

配置

将服务器添加到 MCP 设置文件中:

{
  "mcpServers": {
    "project-hub": {
      "command": "node",
      "args": ["path/to/project-hub-mcp-server/dist/index.js"],
      "env": {
        "NODE_ENV": "development",
        "DEFAULT_PRIVATE": "true",
        "DEFAULT_OWNER": "your-github-username",
        "GITHUB_TOKEN": "your-github-token",
        "GIT_PATH": "C:\\Program Files\\Git\\bin\\git.exe"
      },
      "alwaysAllow": [
        "list_projects",
        "find_project",
        "get_pending_changes",
        "get_local_commit_history",
        "list_local_branches"
      ]
    }
  }
}

调试方式

  1. 运行测试:
npm test
  1. 构建项目:
npm run build
  1. 检查日志文件以获取错误信息。

许可证

该项目遵循 MIT 开源许可条款。