README
🚀 MCP 开发工具
MCP(Model Context Protocol)开发工具是一个强大的开发平台,可用于集成和管理各种服务。它支持多种常见的项目管理、协作和沟通工具,能有效简化开发流程,提升工作效率。
🚀 快速开始
启动开发环境
pnpm dev
打包构建
pnpm build
✨ 主要特性
- 支持多种服务集成,包括 Jira、禅道、Trello 和 Slack。
- 提供共享 TypeScript 配置文件和 HTTP 通信工具。
- 允许直接在工具中创建、更新和查询任务,与外部服务进行交互。
📦 安装指南
克隆仓库
git clone git@github.com:modelcontextprotocol/mcp-devtools.git
cd mcp-devtools
依赖管理
本项目使用 pnpm 进行依赖管理:
- 安装 pnpm(如果尚未安装):
npm install -g pnpm
- 安装项目依赖:
pnpm install
💻 使用示例
基础用法
Jira 集成
import { JiraClient } from '@mcp-devtools/jira';
const jira = new JiraClient({
host: 'https://your-domain.atlassian.net',
token: 'your-api-token'
});
// 创建新任务
await jira.createIssue({
projectKey: 'YOUR_PROJECT_KEY',
summary: '完成用户故事开发',
description: '需要实现用户故事功能模块',
priority: '高'
});
禅道 集成
import { ZentaoClient } from '@mcp-devtools/zentao';
const zentao = new ZentaoClient({
host: 'http://zentao.example.com',
username: 'your-username',
password: 'your-password'
});
// 获取所有项目
const projects = await zentao.getProjectList();
Trello 集成
import { TrelloClient } from '@mcp-devtools/trello';
const trello = new TrelloClient({
apiKey: 'your-trello-api-key',
secretKey: 'your-trello-secret-key'
});
// 创建新看板
await trello.createBoard('开发计划');
Slack 集成
import { SlackClient } from '@mcp-devtools/slack';
const slack = new SlackClient({
token: 'your-slack-token'
});
// 发送消息到 #开发频道
await slack.postMessage('开发频道', '新任务已创建,请注意查收。');
📚 详细文档
核心组件
- typescript-config:共享 TypeScript 配置文件,方便项目统一代码规范。
- http-client:用于与外部服务进行 HTTP 通信的工具,简化与外部服务的交互过程。
贡献指南
提交问题
在 GitHub 上报告错误或功能请求,帮助项目不断完善。
参与讨论
加入社区讨论,提出您的想法和建议,共同推动项目发展。
代码贡献流程
- Fork 仓库:
git clone https://github.com/your-username/mcp-devtools.git
cd mcp-devtools
- 创建功能分支:
git checkout -b feature/amazing-feature
- 提交代码变更:
git add . && git commit -m '添加令人惊叹的功能'
- 推送到远程仓库:
git push origin feature/amazing-feature
- 创建 Pull Request。
遵循 Conventional Commits
请按照以下格式提交 commits:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
类型包括:
feat:新功能fix:修复错误docs:文档变更style:代码风格调整refactor:代码重构perf:性能优化test:测试相关变更chore:构建或其他辅助工具的变更
问题排查
常见问题
- 连接问题:
- 确保 API 凭据正确无误。
- 检查网络连通性。
- 核对服务地址是否正确。
- 权限问题:
- 确认 API 令牌拥有足够的权限。
- 查看文档确认所需权限范围。
- 依赖冲突:
- 使用
pnpm install重新安装依赖。 - 检查 package.json 文件,确保依赖版本兼容。
- 使用
调试工具
- 使用
console.log输出调试信息。 - 在 Chrome 开发者工具中使用网络监视器跟踪 API 请求。
📄 许可证
本项目遵循 MIT 许可证,具体内容请参考 LICENSE 文件。
MCP 开发工具旨在为您提供一个强大而灵活的平台,简化与各种服务的集成与管理。欢迎加入我们的社区,共同推动项目的发展!
Scan to join WeChat group