使用说明
项目简介
Plane MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,它允许大型语言模型 (LLM) 通过预定义的工具与 Plane.so 项目管理平台进行交互。通过此服务器,LLM 可以安全地访问和操作 Plane.so 中的项目和 Issue,从而实现更智能的项目管理自动化。
主要功能点
- 项目管理: 列出 Plane.so 工作空间中的所有项目,并获取指定项目的详细信息。
- Issue管理: 创建新的 Issue,支持自定义属性;列出和筛选项目中的 Issue;获取指定 Issue 的详细信息;更新现有 Issue 的信息。
- 工具集成: 提供一系列工具,使 LLM 能够执行如创建、读取、更新项目和 Issue 等操作。
- 易于安装和配置: 支持使用 Smithery 快速安装,也提供手动安装步骤,方便用户集成到不同的 MCP 客户端。
安装步骤
- 环境准备: 确保已安装 Node.js 22.x 或更高版本。
- 克隆仓库: 打开终端,执行命令 'git clone https://github.com/kelvin6365/plane-mcp-server.git' 克隆仓库到本地。
- 进入目录: 执行 'cd plane-mcp-server' 进入项目目录。
- 安装依赖: 执行 'npm install' 安装项目依赖。
- 构建项目: 执行 'npm run build' 构建项目,生成可执行文件。
服务器配置
要将 Plane MCP Server 配置到 MCP 客户端(例如 Claude for Desktop),您需要在客户端的配置文件中添加服务器配置。以下是配置示例,您需要替换 'path/to/plane-mcp-server' 为实际的服务器路径,并设置您的 Plane API 密钥和工作区 Slug。
{ "mcpServers": { "plane": { "command": "node", "args": ["path/to/plane-mcp-server/build/index.js"], "env": { "PLANE_API_KEY": "your_plane_api_key_here", // 替换为您的 Plane.so API 密钥 "PLANE_WORKSPACE_SLUG": "your_workspace_slug_here" // 替换为您的 Plane.so 工作区 Slug } } } }
配置说明:
- '"plane"': 服务器名称,可以自定义,用于在 MCP 客户端中标识该服务器。
- '"command": "node"': 启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件。
- '"args": ["path/to/plane-mcp-server/build/index.js"]': 命令参数,指向编译后的服务器入口文件 'build/index.js',请替换 'path/to/plane-mcp-server' 为 Plane MCP Server 在您本地文件系统中的实际路径。
- '"env"': 环境变量配置,用于传递 Plane.so API 密钥和工作区 Slug。
- '"PLANE_API_KEY"': Plane.so 平台的 API 密钥,用于服务器访问 Plane.so API。请务必替换为您的真实 API 密钥。
- '"PLANE_WORKSPACE_SLUG"': 您的 Plane.so 工作区 Slug,用于指定操作的工作空间。请替换为您的真实工作区 Slug。
基本使用方法
配置完成后,启动 MCP 客户端,客户端将自动连接到 Plane MCP Server。在 MCP 客户端中,您可以指示 LLM 使用 Plane 工具来管理项目和 Issue。例如,您可以向 Claude 提出类似 "列出我的 Plane 工作空间中的所有项目" 或 "在 Marketing 项目中创建一个高优先级的 Issue,标题为 '更新社交媒体策略'" 的指令。LLM 将会调用相应的工具并返回结果。在执行修改操作(如创建或更新 Issue)前,通常会请求用户批准。
信息
分类
生产力应用