内容
# 平面 MCP 服务器 + GitHub 同步
MCP（模型上下文协议）服务器，用于平面项目管理和 GitHub↔平面双向同步。是 ClaudePlane 生态系统的一部分。
## 组件
### 1. MCP 服务器 (`index.mjs`)
为 Claude Code 提供 16 种工具，以与平面交互：
| 工具 | 描述 |
|------|-------------|
| `list_workspaces` | 列出所有工作区 |
| `list_projects` | 列出工作区中的项目 |
| `create_project` | 创建新项目 |
| `get_project` | 获取项目详情 |
| `list_issues` | 列出问题（带过滤器） |
| `create_issue` | 创建问题 |
| `update_issue` | 更新问题 |
| `get_issue` | 获取问题详情 |
| `delete_issue` | 删除问题 |
| `add_comment` | 评论问题 |
| `list_states` | 列出工作流状态 |
| `list_labels` | 列出标签 |
| `create_label` | 创建标签 |
| `list_cycles` | 列出周期（冲刺） |
| `create_cycle` | 创建周期 |
| `list_modules` | 列出模块 |
| `list_members` | 列出工作区成员 |
### 2. GitHub Webhook 同步 (`github-plane-webhook.mjs`)
监听 GitHub Webhook 并将事件镜像到平面：
- **问题打开** → 创建相应的平面问题
- **拉取请求打开/准备好** → 创建跟踪拉取请求的平面问题
- **推送事件** → 记录提交（可扩展到链接问题）
## 设置
### 环境变量
```bash
export PLANE_API_URL=https://plane.oogley.net
export PLANE_API_TOKEN=<您的平面API令牌>
export WORKSPACE_SLUG=<您的工作区>
export WEBHOOK_PORT=9600 # 用于Webhook服务
export WEBHOOK_SECRET=<密钥> # GitHub Webhook密钥
```
### 运行 MCP 服务器
```bash
# 通过Claude Code MCP配置
node /home/ubuntu/plane-mcp-server/index.mjs
# 或添加到MCPJungle
```
### 运行 Webhook 同步
```bash
node /home/ubuntu/plane-mcp-server/github-plane-webhook.mjs
```
## 与 ClaudePlane 集成
该服务器旨在与 [ClaudePlane](https://github.com/oogleyskr/ClaudePlane) 配合使用，ClaudePlane 是平面的一个分支，具有：
- Claude Max OAuth 集成（无需 API 密钥）
- 自定义 LLM 端点支持（vLLM，SGLang，Ollama）
- 更新的 Claude 模型列表（4.5/4.6 系列）
- GitHub 仓库同步管理命令
## 许可证
MIT
