article
README
🚀 项目中心 MCP 服务器
项目中心 MCP 服务器是一款强大的工具,它提供了项目管理和 GitHub 集成功能。借助该服务器,你能够轻松管理本地项目、跟踪项目变更,并将其同步到 GitHub 仓库。
🚀 快速开始
若要使用项目中心 MCP 服务器,可按以下步骤进行操作:
- 克隆项目仓库:
git clone https://github.com/yourusername/project-hub-mcp-server.git
- 配置环境变量:
export DEFAULT_OWNER=your-github-username
export GITHUB_TOKEN_your-github-username=your-github-token
- 启动服务器:
node dist/index.js
✨ 主要特性
- 项目创建与管理:轻松创建和管理各类项目。
- 变更跟踪与版本控制:精准跟踪项目变更,实现版本有效管理。
- GitHub 仓库集成:无缝集成 GitHub 仓库,方便项目同步。
- 源文件扫描与监控:实时扫描和监控源文件。
- 自动提交管理:自动化管理项目提交。
- 多账户 GitHub 支持:支持使用多个 GitHub 账户。
📚 详细文档
工具
项目管理
- create_project:创建具备本地和远程仓库管理功能的新项目。
- name:项目名称
- path:本地项目路径
- type:项目类型
- description:项目描述
- get_project:获取项目详细信息,包含仓库信息。
- name:项目名称
- list_projects:列出所有项目,支持可选过滤功能。
- name:项目名称
- delete_project:删除指定项目。
- name:项目名称
GitHub 账户管理
- create_repository:创建新的 GitHub 仓库。
- name:仓库名称
- description:仓库描述
- private:是否为私有仓库(可选)
- link_repository:将本地项目与 GitHub 仓库关联。
- project_name:项目名称
- repo_owner:GitHub 账户名
- repo_name:仓库名称
提交管理
- create_commit:向指定仓库创建提交。
- repo:仓库名称
- changes:变更列表,包含路径、操作和源路径
- message:提交信息
💻 使用示例
基础用法
项目管理
// 创建新项目
await mcp.use("project-hub", "create_project", {
name: "my-project",
path: "./projects/my-project",
type: "typescript",
description: "一个全新的 TypeScript 项目"
});
// 记录变更
await mcp.use("project-hub", "record_change", {
project_name: "my-project",
description: "添加新功能",
type: "feature",
files: ["src/feature.ts"]
});
GitHub 集成
// 创建并关联仓库
await mcp.use("project-hub", "create_repository", {
name: "my-project",
description: "一个全新的 TypeScript 项目",
private: true
});
await mcp.use("project-hub", "link_repository", {
project_name: "my-project",
repo_owner: "your-username",
repo_name: "my-project"
});
// 创建提交
await mcp.use("project-hub", "create_commit", {
repo: "my-project",
changes: [{
path: "src/feature.ts",
operation: "add",
sourcePath: "./projects/my-project/src/feature.ts"
}],
message: "feat: 添加新功能"
});
🔧 技术细节
开发
若你想对项目进行开发,可按以下步骤操作:
- 修改源代码
- 运行测试:
npm test
- 构建项目:
npm run build
贡献指南
欢迎你为项目贡献代码,贡献步骤如下:
- Fork 仓库
- 创建功能分支
- 提交更改
- 推送到分支
- 创建 Pull Request
📄 许可证
本项目采用 MIT 许可证。
Scan to join WeChat group