Plane MCP Server

🚀 平台 MCP 服务器端

平台 MCP 服务器端是一个用于与 Plane 协作的服务器端协议实现。借助此工具，AI 模型能够通过 Model Context Protocol（MCP）与 Plane 进行交互，实现创建、更新和查询项目中的问题等操作，为项目管理提供了高效的解决方案。

🚀 快速开始

平台 MCP 是遵循 Model Context Protocol（MCP）的实现，可让 AI 模型与 Plane 平台交互，实现创建、更新和查询问题等功能。你可以按照以下步骤进行安装和使用。

📦 安装指南

快速安装

在生产环境中，你可以使用以下命令快速安装：

npm install plane-mcp-server

开发环境安装

若你处于开发环境，可使用以下命令安装：

npm install --save-dev plane-mcp-server

✨ 主要特性

核心功能

1. 创建问题
   • 支持指定问题标题和描述，让问题信息更清晰。
   • 可灵活配置优先级、状态和分配人，满足不同场景需求。
2. 更新问题
   • 支持部分字段更新，避免覆盖无关数据，保护已有信息。
   • 提供批量操作选项，提高处理效率。
3. 查询问题
   • 支持按项目 ID 筛选，精准定位所需问题。
   • 可指定排序方式（如按时间或优先级），方便查看。
   • 限制返回结果数量，默认为 50，避免数据过多。
4. 列出项目
   • 获取所有关联项目的详细信息，包括项目名称、ID 和其他元数据。

其他特性

• 遵循 RESTful API 设计原则，保证接口的规范性和可扩展性。
• 支持中间件扩展，方便根据需求定制功能。
• 提供详细的错误处理机制，及时反馈问题。
• 内置日志记录功能，便于排查和分析。

💻 使用示例

基础用法

创建问题

const { PlaneMCP } = require('plane-mcp-server');

async function main() {
    const mcp = new PlaneMCP({
        projectId: 'your-project-id',
        planeApiKey: 'your-plane-api-key'
    });

    const issue = await mcp.createIssue({
        title: '新功能开发',
        description: '我们需要实现新的用户认证模块',
        priority: 'high',
        assignees: ['user-id-1', 'user-id-2']
    });

    console.log('新建问题:', issue);
}

main().catch(console.error);

查询项目

const { PlaneMCP } = require('plane-mcp-server');

async function main() {
    const mcp = new PlaneMCP({
        projectId: 'your-project-id',
        planeApiKey: 'your-plane-api-key'
    });

    const projects = await mcp.listProjects();
    console.log('所有项目:', projects);
}

main().catch(console.error);

📚 详细文档

开发指南

安装开发依赖

npm install --save-dev typescript @types/node

启动开发服务器

npm run dev

测试方法

使用 MCP 检查器进行测试：

npx @modelcontextprotocol/inspector dist/index.js

示例用法

以下是与 Claude 配合使用的一些示例场景：

1. "请列出我所有的项目"
2. "在 '新功能开发' 项目中创建一个问题，描述为 '我们需要实现新的用户认证模块'"
3. "更新问题 ID 123 的优先级为 'urgent'"

贡献指南

提交代码规范

1. 每个提交必须包含详细的提交信息，方便后续查看和理解。
2. 新功能需配套单元测试，确保代码质量。
3. 保持代码风格一致，提高代码可读性。

提交流程

git add .
git commit -m "添加新功能：支持问题优先级设置"
git push origin main

📄 许可证

本项目遵循 MIT 许可证，具体内容如下：

MIT License

版权 (c) 年份 作者姓名 <邮件地址>

允许自由使用、复制、修改和分发此软件及其中的源代码，前提是保留上述版权声明和本许可声明。

DISCLAIMER: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

📞 联系方式

有问题或建议，请联系：

• 邮件：contact@example.com
• GitHub：你的 GitHub 链接

感谢使用 Plane MCP 服务器端！如需更多帮助，请随时查看我们的文档。