项目简介

TOD MCP 服务器是 OneDev 开发平台的官方工具,通过 Model Context Protocol (MCP) 为 AI 助手提供完整的开发工作流支持,包括运行 CI/CD 作业、管理拉取请求、查询问题等核心功能。

主要功能

  • 项目管理:查询当前项目信息、远程仓库配置
  • 问题跟踪:创建、编辑、查询问题,添加评论,记录工作时间
  • CI/CD 集成:运行针对本地变更的作业,无需提交推送
  • 代码审查:获取拉取请求详情、文件变更、代码评论
  • 构建分析:查询构建信息、获取构建日志、检查文件内容
  • 工作目录管理:获取和设置服务器工作目录
  • 构建规范检查:验证和迁移 .onedev-buildspec.yml 文件
  • 拉取请求操作:创建、编辑、审查、签出拉取请求
  • 时间工具:获取Unix时间戳,支持自然语言时间描述

安装步骤

  1. 下载预编译二进制文件

    • 访问发布页面:https://code.onedev.io/onedev/tod/~builds?query=%22Job%22+is+%22Release%22
    • 将下载的 tod 二进制文件放置到系统 PATH 环境变量中的任意目录
  2. 从源码构建(可选):

    • 确保 Go 1.22.1 或更高版本
    • 克隆仓库:'git clone https://code.onedev.io/onedev/tod.git'
    • 进入目录:'cd tod'
    • 构建:'go build'

服务器配置

在 MCP 客户端中配置服务器连接信息:

{
  "mcpServers": {
    "onedev": {
      "command": "tod",
      "args": ["mcp"]
    }
  }

参数说明

  • 'command':tod 可执行文件的完整路径
  • 'args':固定为 ["mcp"] 启动 MCP 服务器

基本使用方法

  1. 配置 OneDev 连接

    • 创建配置文件:'~/.todconfig'
    • 内容格式:
      server-url=https://onedev.example.com
      access-token=你的个人访问令牌
      
  2. 启动 MCP 服务器

    • 基本启动:'tod mcp'
    • 调试模式:'tod mcp --log-file /tmp/tod-mcp.log'
    • 服务器通过 stdio 与客户端通信
  3. 常用操作示例

    • 查询当前项目问题:'queryIssues' 工具
    • 运行 CI/CD 作业:'runJob' 或 'runLocalJob' 工具
    • 签出拉取请求:'checkoutPullRequest' 工具
    • 检查构建规范:'checkBuildSpec' 工具

重要提示:确保 OneDev 服务器版本与 TOD 工具兼容,配置文件中需正确设置服务器URL和个人访问令牌。

信息

分类

开发者工具