使用说明
Tempo MCP服务器
模型上下文协议(MCP)服务器,用于将工作时间直接记录到Jira票证中。该服务器通过MCP界面提供创建和管理工作日志的工具,实现了与AI助手和开发工具的无缝时间跟踪集成。
概述
Tempo MCP服务器旨在与人工智能助手和开发工具集成,以便直接向Jira提供工作时间记录功能。它允许用户创建带有票证ID、所花费的时间和描述的工作日志,这些日志将通过Tempo API自动记录到相应的Jira票证中。
备注:这目前是一个演示版本,以JSON格式在本地存储工作日志。生产版本将与Jira的Tempo API集成,以在Jira票证中创建实际工作日志。
特性
- 工作日志创建:使用工单ID、花费的时间和描述创建新的工作日志
- Jira集成:与Jira的Tempo API直接集成,用于自动创建工作日志
- MCP集成:完全符合模型上下文协议,实现无缝的AI助手集成
- TypeScript支持:使用TypeScript构建,实现类型安全和更好的开发体验
- 演示模式:用于测试和开发的本地JSON存储(当前实施)
安装
- 克隆存储库:
git clone <repository-url>
cd tempo-mcp
- 安装依赖项:
npm install
用法
发展模式
在开发模式下运行服务器:
npm run server:dev
构建并运行
构建TypeScript代码:
npm run server:build
检查器模式
使用MCP检查器进行调试:
npm run server:inspect
API 参考
工具
create-work-log
创建新的工作日志条目。
参数:
ticketId(string):票证或问题IDtime(数字):花费的时间(小时/分钟)description(string):所执行工作的描述
例子:
{
"ticketId": "PROJ-123",
"time": 2.5,
"description": "Implemented user authentication feature"
}
数据结构
演示模式(当前)
工作日志存储在本地 src/data/workLog.json 具有以下结构:
[
{
"id": 1,
"ticketId": "1234567890",
"time": 10,
"description": "Work log description"
}
]
生产模式(计划)
工作日志将使用Tempo API直接在Jira中创建。数据结构将映射到Tempo的工作日志格式:
{
"issueId": "1234567890",
"timeSpentSeconds": 36000,
"comment": "Work log description",
"started": "2024-01-01T09:00:00.000+0000"
}
配置
服务器配置了以下功能:
- 名字:Tempo MCP服务器
- 版本: 1.0.0
- 运输:标准服务器传输
- 能力:工具、资源、提示
发展
项目结构
src/
├── server.ts # Main server implementation
└── data/
└── workLog.json # Demo work log storage (local JSON)
依赖项
@modelcontextprotocol/sdk:用于服务器实现的MCP SDKzod:架构验证tsx:用于开发的TypeScript执行typescript:TypeScript编译器
未来依赖性(生产)
@atlassian/tempo-api-client:Tempo API官方客户axios或fetch:API调用的HTTP客户端dotenv:环境变量管理
脚本
server:dev:以开发模式运行服务器server:build:构建TypeScript代码server:build:watch:使用手表模式构建server:inspect:与MCP检查员一起运行
路线图
- []与Jira Tempo API集成
- []添加身份验证和配置管理
- []实施工作日志检索和管理
- []添加对不同时间格式的支持
- []添加错误处理和验证
- []执行工作日志更新和删除
贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 测试您的更改
- 提交拉取请求
许可证
ISC许可证-详见package.json
作者
Kiet Huynh
支持
对于问题和疑问,请在存储库中创建问题或联系维护人员。
