Project Hub MCP服务器
MCP服务器提供全面的项目管理、本地Git功能和GitHub集成功能。此服务器支持管理本地项目、跟踪更改、创建本地提交以及与GitHub存储库同步。
特性
项目管理
- 项目创建和管理，具有灵活、不区分大小写、部分名称搜索功能
- 使用可定制的排除模式进行源文件扫描和监控
- 项目元数据跟踪和更新
本地Git功能
- 无需GitHub即可创建和管理本地提交
- 分支管理（创建、切换、列表）
- 带有元数据的文件快照（大小、创建时间、修改时间）
- 恢复功能以还原到以前的提交或分支
- 克隆功能，用于从提交或分支创建新实例
更改跟踪
- 记录和跟踪相关文件的更改
- 按类型（功能、修复、重构等）对更改进行分类
- 将更改链接到提交，以获取全面的历史记录
Notes系统
- 创建和管理具有丰富标记内容的项目笔记
- 对笔记进行分类和标记，以便更好地组织
- 搜索功能以查找相关文档
GitHub集成
- 存储库管理（创建、更新、删除、重命名）
- 通过文件内容跟踪提交管理
- 分支操作（创建、删除、合并）
- 拉取请求创建和管理
- 存储库克隆和本地设置
- 多账户GitHub支持
工具
项目管理
创建项目
使用本地和远程存储库管理创建新项目。
- 名字：项目名称
- 路径：本地项目路径
- 类型：项目类型
- 描述：项目描述
find_项目
按名称查找项目（灵活、不区分大小写、部分匹配）。返回详细的项目信息，包括更改和注释。
- 名字：要搜索的项目名称
list_项目
列出所有具有可选筛选的项目。
- 类型：按项目类型筛选（可选）
- has_repo：按存储库是否存在进行筛选（可选）
- 页：分页页码（可选）
- 页面大小：每页项目数（可选）
update_project_details
更新现有项目的详细信息。
- 项目ID：项目ID
- 名字：新项目名称（可选）
- 路径：新项目路径（可选）
- 类型：新项目类型（可选）
- 描述：新项目描述（可选）
- 状态：新项目状态（可选）
删除项目
删除项目。
- 项目ID：项目ID
扫描项目文件
扫描项目目录中的源文件并更新项目记录。
- 项目ID：项目ID
- 排除模式：用于排除文件的正则表达式模式（可选）
项目_位置
获取项目数据库位置的完整路径。
变更管理
记录_更改
记录项目中的更改。
- 项目ID：项目ID
- 类型：更改类型
- 描述：更改说明
- 文件：受此更改影响的文件路径列表（可选）
get_ending_changes
获取项目的待定更改。
- 项目ID：项目ID
clear_committeed_changes
明确项目的已提交更改。
- 项目ID：项目ID
本地Git功能
init_local_repository
为项目初始化本地Git存储库。
- 项目ID：项目ID
create_local_comit
从挂起的更改创建本地提交。
- 项目ID：项目ID
- 消息：提交消息
- 作者姓名：作者姓名（可选）
- author电子邮件：作者电子邮件（可选）
get_local_commit_history
获取项目的本地提交历史记录。
- 项目ID：项目ID
create_local_branch
创建一个新的本地分支。
- 项目ID：项目ID
- 名字：分行名称
- 开始提交ID：启动提交ID（可选）
switch_local_branch
切换到其他本地分支。
- 项目ID：项目ID
- 分支机构名称：分行名称
list_local_brances
列出项目的所有本地分支。
- 项目ID：项目ID
restore_to_local_comit
将项目文件还原到特定的本地提交。
- 项目ID：项目ID
- 承诺：提交要还原的ID
restore_to_local_branch
将项目文件还原到特定的本地分支。
- 项目ID：项目ID
- 分支机构名称：要还原到的分支名称
restore_local_comit_to_new_location
将特定的本地提交还原到新文件夹位置。
- 项目ID：项目ID
- 承诺：提交要还原的ID
- 新位置：要还原到的新文件夹路径
restore_local_branch_to_new_location
将特定的本地分支还原到新的文件夹位置。
- 项目ID：项目ID
- 分支机构名称：要还原的分支名称
- 新位置：要还原到的新文件夹路径
push_cal_commits
将本地提交推送到GitHub。
- 项目ID：项目ID
- 仓库：存储库名称
- 分支：分行名称（可选）
force_local_comit
强制对项目中的所有文件进行本地提交，而不管待处理的更改如何。
- 项目ID：项目ID
- 消息：提交消息
- 作者姓名：作者姓名（可选）
- author电子邮件：作者电子邮件（可选）
cleanup_项目文件
从项目的Project Hub数据中删除不存在的文件记录。
- 项目ID：项目ID
文件快照管理
获取文件快照
获取提交的文件快照。
- 承诺：提交ID
get_file_snapshots_metadata
获取提交的文件快照元数据（不包括文件内容）。
- 承诺：提交ID
获取_文件_内容
获取快照的文件内容。
- 快照ID：快照ID
笔记管理
create_note
为项目创建新注释。
- 项目名称：项目名称
- 标题：注释标题
- 内容：备注内容
- 类别：注释类别（可选）
- 标签：注释标签（可选）
update_note
更新现有注释。
- 项目名称：项目名称
- note_id：注释ID
- 标题：新注释标题（可选）
- 内容：新注释内容（可选）
- 类别：新注释类别（可选）
- 标签：新注释标签（可选）
delete_note
删除注释。
- 项目名称：项目名称
- note_id：注释ID
search_notes
在项目中搜索笔记。
- 项目名称：项目名称
- 怎么翻译：搜索查询
- 类别：按类别筛选（可选）
库管理
创建存储库
创建一个新的GitHub仓库。
- 名字：存储库名称
- 描述：存储库描述（可选）
- is私人：存储库是否为私有（可选）
get_pository
获取特定存储库的详细信息。
- 名字：存储库名称
update_repository
更新存储库设置。
- 名字：存储库名称
- 描述：新存储库描述（可选）
- 私有的：更改存储库可见性（可选）
- default_branch：更改默认分支（可选）
- has_issues：启用/禁用问题（可选）
- has_wiki：启用/禁用wiki（可选）
删除存储
删除GitHub存储库。
- 名字：存储库名称
重命名存储
重命名GitHub存储库。
- 旧名称：当前存储库名称
- 新名称：新存储库名称
list_repositories
列出已验证用户的所有存储库。
- 可见性：按可见性筛选存储库（可选）
- 排序：按字段对存储库进行排序（可选）
- 每页：每页结果（可选）
fork存储
创建现有存储库的分支。
- 名字：要分叉的存储库名称
- 组织：要分叉的组织（可选）
转移存款
转移存储库所有权。
- 名字：存储库名称
- 新所有者：新所有者用户名或组织名称
- team_ids：要添加到存储库的团队ID（可选）
clone_repository
将存储库克隆到指定文件夹。
- 仓库：存储库名称
- targetFolder：克隆存储库的目标文件夹
- 分支：要克隆的分支（可选）
文件管理
获取文件
从GitHub存储库获取文件内容。
- 仓库：存储库名称
- 路径：存储库中的文件路径
- 参考：Git引用（分支、标记或提交SHA）（可选）
提交管理
创建提交
在GitHub存储库中创建提交。
- 仓库：存储库名称
- 分支：分支名称（可选，默认为main）
- 消息：提交消息
- 变化：文件更改数组（路径、内容、操作）
list_commits
列出GitHub存储库中的提交。
- 仓库：存储库名称
- 分支：分行名称（可选）
get_提交
从GitHub存储库获取提交详细信息。
- 仓库：存储库名称
- 沙：提交SHA
回复提交
在GitHub存储库中还原提交。
- 仓库：存储库名称
- 沙：要求民政事务局局长回复
分行管理
create_branch
在GitHub存储库中创建一个新分支。
- 仓库：存储库名称
- 名字：新分支名称
- 源分支：要从中创建的源分支（可选，默认为main）
delete_branch
从存储库中删除分支。
- 仓库：存储库名称
- 名字：要删除的分支名称
list_brances
列出存储库中的所有分支。
- 仓库：存储库名称
get_branch
获取特定分支的详细信息。
- 仓库：存储库名称
- 名字：分行名称
合并_分支
合并存储库中的两个分支。
- 仓库：存储库名称
- 基础：基本分支名称
- 头部：总行名称
- 消息：合并提交消息（可选）
拉取请求管理
create_pull_request
创建新的pull请求。
- 仓库：存储库名称
- 标题：拉取请求标题
- 头部：总行名称
- 基础：基本分支名称
- 身体：拉取请求描述（可选）
- 草案：创建为PR草稿（可选）
- maintainer_can_modify：允许维护人员修改（可选）
实用工具
list_tools
列出Project Hub MCP中的所有可用工具。
建筑
数据库模式
Project Hub MCP服务器使用SQLite进行数据存储，其中包含以下关键表：
- 项目：存储项目元数据
- 变化：跟踪对项目所做的更改
- 笔记：存储项目文档
- 源文件：编目项目中的文件
- 本地承诺：存储本地提交信息
- 本地_牧场：跟踪分支机构信息
- 文件快照：在提交时存储文件内容和元数据
- commit-changes：地图承诺更改
关键组件
- 项目经理：处理项目CRUD操作和元数据
- 本地GitService：管理本地Git功能
- 文件快照服务：处理文件快照操作
- GitHubService：与GitHub API的接口
- 存储服务：管理数据库操作
- 震源扫描仪：扫描和编目项目文件
安装
- 克隆存储库：
git clone https://github.com/peterparker57/project-hub-mcp-server.git
cd project-hub-mcp-server- 安装依赖项：
npm install- 构建项目：
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"
]
}
}
}环境变量
- NODE_ENV：设置为“开发”或“生产”
- DEFAULT_私有：默认情况下，新存储库是否应该是私有的
- 默认所有者：存储库操作的默认GitHub用户名
- GITHUB令牌：具有适当权限的GitHub个人访问令牌
- GIT_PATH：本地Git操作的Git可执行文件路径
使用示例
项目管理
// Create a new project
await mcp.use("project-hub", "create_project", {
name: "my-project",
path: "./projects/my-project",
type: "typescript",
description: "A new TypeScript project"
});
// Find a project (flexible name search)
await mcp.use("project-hub", "find_project", {
name: "my-project" // Works with "My-Project", "MY-PROJECT", "my project notes", etc.
});
// Record a change
await mcp.use("project-hub", "record_change", {
projectId: "project-id",
description: "Added new feature",
type: "feature",
files: ["src/feature.ts"]
});
// Scan project files
await mcp.use("project-hub", "scan_project_files", {
projectId: "project-id",
excludePatterns: ["node_modules", "\\.git", "dist", "build"]
});本地Git功能
// Initialize local repository
await mcp.use("project-hub", "init_local_repository", {
projectId: "project-id"
});
// Create a local commit
await mcp.use("project-hub", "create_local_commit", {
projectId: "project-id",
message: "Implemented new feature",
authorName: "John Doe",
authorEmail: "john@example.com"
});
// Create a new branch
await mcp.use("project-hub", "create_local_branch", {
projectId: "project-id",
name: "feature/new-feature"
});
// Switch to a branch
await mcp.use("project-hub", "switch_local_branch", {
projectId: "project-id",
branchName: "feature/new-feature"
});
// Restore to a previous commit
await mcp.use("project-hub", "restore_to_local_commit", {
projectId: "project-id",
commitId: "commit-id"
});
// Clone a branch to a new location
await mcp.use("project-hub", "restore_local_branch_to_new_location", {
projectId: "project-id",
branchName: "main",
newLocation: "C:/Projects/new-clone"
});
// Push local commits to GitHub
await mcp.use("project-hub", "push_local_commits", {
projectId: "project-id",
repo: "my-project",
branch: "main"
});笔记管理
// Create a project note
await mcp.use("project-hub", "create_note", {
project_name: "my-project",
title: "Architecture Decision Record",
content: "# ADR-001: Project Structure\n\n...",
category: "documentation",
tags: ["architecture", "decision"]
});
// Search notes
await mcp.use("project-hub", "search_notes", {
project_name: "my-project",
query: "architecture",
category: "documentation"
});GitHub集成
// Create and link repository
await mcp.use("project-hub", "create_repository", {
name: "my-project",
description: "A new TypeScript project",
isPrivate: true
});
// Clone a repository
await mcp.use("project-hub", "clone_repository", {
repo: "my-project",
targetFolder: "./projects/my-project",
branch: "main"
});
// Create a feature branch
await mcp.use("project-hub", "create_branch", {
repo: "my-project",
name: "feature/new-feature",
sourceBranch: "main"
});
// Create a commit on the feature branch
await mcp.use("project-hub", "create_commit", {
repo: "my-project",
changes: [{
path: "src/feature.ts",
content: "// New feature code",
operation: "add"
}],
message: "feat: add new feature",
branch: "feature/new-feature"
});
// Create pull request
await mcp.use("project-hub", "create_pull_request", {
repo: "my-project",
title: "Add new feature",
head: "feature/new-feature",
base: "main",
body: "This PR adds a new feature",
draft: false,
maintainer_can_modify: true
});
// After PR review, merge the branches
await mcp.use("project-hub", "merge_branches", {
repo: "my-project",
base: "main",
head: "feature/new-feature",
message: "Merge feature/new-feature into main"
});发展
- 对源代码进行更改
- 运行测试：
npm test- 构建项目：
npm run build最近的增强功能
本地Git功能（2025年3月）
- 添加了全面的本地Git功能，包括提交、分支和文件快照
- 已实现还原功能，可还原到以前的状态
- 添加了克隆功能，可以从提交或分支创建新实例
- 具有元数据跟踪功能的增强文件快照（大小、创建时间、修改时间）
项目管理改进（2025年2月）
- 添加clone_repository工具，将GitHub存储库克隆到指定文件夹
- 实现了scan_project_files工具来扫描项目目录和目录源文件
- 通过灵活、不区分大小写、部分名称匹配增强项目搜索
- 通过更好的元数据改进文件跟踪
贡献
- 分叉存储库
- 创建功能分支
- 提交您的更改
- 推到分支
- 创建拉取请求
许可证
麻省理工学院
