Teambition OpenAPI MCP

⚠️ 提示: Beta 版本中工具功能及 API 可能变更，请及时关注更新。

这是 Teambition 官方 MCP（Model Context Protocol）。该工具提供了 Teambition 企业应用开放 API 及用户级别 API 的 MCP 工具。你可以根据使用场景选择对应的 MCP 工具配置到您的 AI 助手或者 Agent 中，实现项目管理、任务拆解、工时管理等多种自动化场景。

以下文档为基于企业应用开发场景 MCP 接入说明，用户 MCP 接入请参考Teambition User MCP 使用指南

适用场景

• 项目管理自动化：通过 AI 助手创建项目、管理任务、分配成员

• 任务处理：批量创建任务、更新任务状态、设置任务依赖关系

• 工时管理：记录和统计工时、生成工时报表

• 团队协作：管理团队成员、分配角色权限

• 数据分析：获取项目数据、生成各类报表

使用准备

创建应用

快速开始

1. 环境准备

创建 Teambition 应用

在使用前，您需要先在 Teambition 开放平台创建应用：

1. 访问 Teambition 开放平台 并登录

2. 点击"立即创建"，创建一个新应用

3. 获取以下关键信息：

   • App ID：应用标识符

   • App Secret：应用密钥

   • 企业 orgId：您的企业标识

更多详细信息请参考 Teambition 开放平台文档。

2. 安装工具

使用 npm 全局安装：

npm install -g @tng/teambition-openapi-mcp

使用方式

在 AI 工具中集成使用

灵码/trae/Cline/Cursor/Claude 集成

在您的 AI 工具配置文件中添加以下配置：

{
  "mcpServers": {
    "teambition-openapi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@tng/teambition-openapi-mcp",
        "mcp",
        "-a",
        "<your_app_id>",
        "-s",
        "<your_app_secret>",
        "-o",
        "<your_org_id>",
        "-b",
        "https://open.teambition.com/api"
      ]
    }
  }
}

参数说明：

• <your_app_id>：替换为您的应用 ID

• <your_app_secret>：替换为您的应用密钥

• <your_org_id>：替换为您的企业 ID

命令行直接使用

teambition-openapi-mcp mcp \
  -a <your_app_id> \
  -s <your_app_secret> \
  -o <your_org_id> \
  -b "https://open.teambition.com/api"

配置详解

命令行参数

teambition-openapi-mcp mcp工具提供了多种命令行参数，以便您灵活配置MCP服务：

| 参数 | 简写 | 描述 | 示例 | 环境变量 | |------|------|------|------|----------| | --app-id | -a | Teambition 应用 ID | -a cli_xxxx | TB_MCP_APP_ID | | --app-secret | -s | Teambition 应用密钥 | -s xxxx | TB_MCP_APP_SECRET | | --org-id | -o | 企业 ID，如果指定 request-source 为 dingtalk， 则为钉钉 corpId | -o 66cd468fff36bd665cc... | TB_MCP_ORG_ID | | --base-url | -b | API 基础地址 | -b https://open.teambition.com/api | TB_MCP_API_BASE_URL | | --tool-name-case | -c | 工具命名格式 | -c camel | TB_MCP_TOOL_NAME_CASE | | --mode | -m | 传输模式 | -m streamable-http | TB_MCP_MODE | | --tool | -t | 指定加载的工具 | -t preset.default,task | TB_MCP_TOOL | | --host | | 监听主机 | --host 0.0.0.0 | TB_MCP_HOST | | --port | -p | 监听端口 | -p 3000 | TB_MCP_PORT | | --request-source | -r | 请求来源，指定后会转换为通讯录来源的 orgId 和 userId | -r dingtalk | TB_MCP_REQUEST_SOURCE | | --config | | 配置文件路径 | --config ./config.json | TB_MCP_CONFIG_PATH |

传输模式

工具支持三种传输模式：

• stdio（默认）：标准输入输出流模式

• sse：服务器发送事件模式，基于 HTTP

• streamable-http：可流式传输的 HTTP 模式

工具过滤配置

通过 --tool 参数可以精确控制加载哪些工具：

预设工具集

# 加载默认工具集
--tool preset.default

按功能分组加载

# 加载任务和项目相关的所有工具
--tool task,project

混合加载

# 加载项目分组下所有工具，并额外加载特定工具
--tool project,assignMemberRoleV3

预置 preset.default tools 列表

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | getOrgInfo | 该接口用于获取企业的信息 | org,getOrgInfo,preset.default | | listOrgAdmins | 该接口用于获取企业的管理员，包括拥有者 | contact,listOrgAdmins,preset.default | | batchGetOrgMembers | 该接口用于批量获取企业成员信息 | contact,batchGetOrgMembers,preset.default | | searchOrgMembers | 该接口用于搜索企业成员 | contact,searchOrgMembers,preset.default | | sumTaskWorkTime | 该接口用于根据任务 ID 查询单个任务的实际工时总和 | worktime,sumTaskWorkTime,preset.default | | aggregateUserWorkTime | 该接口用于查询一定时间内指定用户的实际工时聚合数 | worktime,aggregateUserWorkTime,preset.default | | createProjectV3 | 创建项目 | project,createProjectV3,preset.default | | searchProjectCustomFiledsV3 | 搜索项目自定义字段 | project,searchProjectCustomFiledsV3,preset.default | | listProjectMembersV3 | 获取项目成员列表 | project,listProjectMembersV3,preset.default | | getProjectTagsV3 | 查看项目的项目分组 | project,getProjectTagsV3,preset.default | | queryProjectsV3 | 查询项目 | project,queryProjectsV3,preset.default | | getScenarioFieldsV3 | 获取项目任务类型 | project,getScenarioFieldsV3,preset.default | | listProjectStatusesV3 | 查询项目状态和状态历史 | project,listProjectStatusesV3,preset.default | | searchProjectTasksV3 | 查询项目任务 | project,searchProjectTasksV3,preset.default | | searchTaskflowsV3 | 搜索项目工作流 | project,searchTaskflowsV3,preset.default | | searchTaskGroupsV3 | 搜索任务分组 | project,searchTaskGroupsV3,preset.default | | updateProjectV3 | 更新项目 | project,updateProjectV3,preset.default | | updateTaskContentV3 | 更新任务标题 | task,updateTaskContentV3,preset.default | | createTaskV3 | 创建任务 | task,createTaskV3,preset.default | | updateTaskCusomFieldV3 | 更新任务自定义字段值 | task,updateTaskCusomFieldV3,preset.default | | updateTaskDueDateV3 | 更新任务截止时间 | task,updateTaskDueDateV3,preset.default | | updateTaskExecutorV3 | 更新任务执行者 | task,updateTaskExecutorV3,preset.default | | updateTaskMembersV3 | 更新任务参与者 | task,updateTaskMembersV3,preset.default | | updateTaskNoteV3 | 更新任务备注 | task,updateTaskNoteV3,preset.default | | getTaskLinksV3 | 获取任务关联列表 | task,getTaskLinksV3,preset.default | | createTaskLinkV3 | 创建任务关联 | task,createTaskLinkV3,preset.default | | updateTaskPriorityV3 | 更新任务优先级 | task,updateTaskPriorityV3,preset.default | | queryTaskV3 | 查询任务详情 | task,queryTaskV3,preset.default | | updateTaskStartDateV3 | 更新任务开始时间 | task,updateTaskStartDateV3,preset.default | | updateTaskStatusV3 | 更新任务状态 | task,updateTaskStatusV3,preset.default | | listUserProjectsV3 | 获取用户参与项目 | project,listUserProjectsV3,preset.default | | getTaskDependenciesV3 | 获取任务依赖 | task,getTaskDependenciesV3,preset.default | | addProjectMembersV3 | 创建项目成员 v2 | project,addProjectMembersV3,preset.default | | getMemberRolesV3 | 获取项目成员角色（包含权限穿透角色） | project,getMemberRolesV3,preset.default | | updateTaskProgressV3 | 更新任务进度 | task,updateTaskProgressV3,preset.default | | updateTaskParentV3 | 改变任务的父任务 | task,updateTaskParentV3,preset.default | | updateTaskStageV3 | 更新任务列表 | task,updateTaskStageV3,preset.default | | updateTaskStoryPointV3 | 更新任务StoryPoint | task,updateTaskStoryPointV3,preset.default | | updateTaskSprintV3 | 更新任务迭代 | task,updateTaskSprintV3,preset.default | | updateTaskVisibilityV3 | 更新任务可见性 | task,updateTaskVisibilityV3,preset.default |

所有 tools 列表

app

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | checkUserVisibleInApp | 该接口用于批量查询用户在企业应用中可见性 | app,checkUserVisibleInApp | | getAppAccessToken | 获取应用授权Token | app,getAppAccessToken |

org

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | getOrgInfo | 该接口用于获取企业的信息 | org,getOrgInfo,preset.default | | listLicenseAllocations | 获取License名额分配列表 | org,listLicenseAllocations | | getAuditLogs | 获取企业审计日志 | org,getAuditLogs | | getTbUserIdByDingUserId | 该接口用于钉钉 userId 查询 Teambition userId, 如果需要通过 Teambition userId 查询钉钉 userId,查看[Teambition userId 查询钉钉 userId](api.operationId=GetDingUserIdByTbUserId) | org,getTbUserIdByDingUserId | | getDingUserIdByTbUserId | 该接口用于 Teambition userId 查询钉钉 userId, 如果需要通过钉钉 userId 查询 Teambition userId,查看[钉钉 userId 查询 Teambition userId](api.operationId=GetTbUserIdByDingUserId) | org,getDingUserIdByTbUserId | | getDingCorpId | 该接口用于查询企业绑定的钉钉 CorpId | org,getDingCorpId |

contact

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | listOrgAdmins | 该接口用于获取企业的管理员，包括拥有者 | contact,listOrgAdmins,preset.default | | listOrgOwners | 该接口用于获取企业拥有者信息 | contact,listOrgOwners | | listOrgMembers | 该接口用于获取企业的成员列表 | contact,listOrgMembers | | updateOrgMember | 更新企业成员 | contact,updateOrgMember | | enableOrgMember | 该接口用于启用指定企业成员的账号，启用后用户可以访问指定企业 | contact,enableOrgMember | | disableOrgMember | 该接口用于停用指定企业成员的账号，停用后用户将不能访问指定企业 | contact,disableOrgMember | | deleteOrgMember | 该接口用于删除企业的成员 | contact,deleteOrgMember | | countOrgMembers | 该接口用于获取企业成员数量 | contact,countOrgMembers | | batchGetOrgMembers | 该接口用于批量获取企业成员信息 | contact,batchGetOrgMembers,preset.default | | searchOrgMembers | 该接口用于搜索企业成员 | contact,searchOrgMembers,preset.default | | listDepartments | 该接口用于获取企业的部门列表 | contact,listDepartments | | listDepartmentMembers | 该接口用于获取企业部门成员列表 | contact,listDepartmentMembers | | addDepartmentMembers | 该接口用于添加部门成员 | contact,addDepartmentMembers | | removeDepartmentMembers | 该接口用于删除部门成员 | contact,removeDepartmentMembers | | listUserDepartments | 该接口用于获取用户加入的企业部门列表 | contact,listUserDepartments | | getDepartment | 该接口用于获取部门详情 | contact,getDepartment | | createDepartment | 该接口用于创建部门 | contact,createDepartment | | updateDepartment | 该接口用于更新部门信息 | contact,updateDepartment | | deleteDepartment | 该接口用于删除部门 | contact,deleteDepartment | | getRoleInfo | 该接口用于获取角色详情 - 查询角色下成员,详见 [获取企业成员列表](api.operationId=GetOrgMembers) - 更新企业成员角色,详见 [更新企业成员](api.operationId=UpdateOrgMembers) | contact,getRoleInfo | | listOrgRoles | 该接口用于获取角色详情 - 查询角色下成员,详见 [获取企业成员列表](api.operationId=GetOrgMembers) - 更新企业成员角色,详见 [更新企业成员](api.operationId=UpdateOrgMembers) | contact,listOrgRoles | | listSubDepartments | 该接口用于获取子部门列表 | contact,listSubDepartments | | createOrgRole | 创建企业角色 | contact,createOrgRole | | resignOrgMember | 将某个企业成员从企业中离职 | contact,resignOrgMember |

worktime

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | createPlanTime | 本接口可用于创建计划工时 注意： 项目归档或回收站 是不能填报工时的，接口会报 「项目已被归档，无法更新工时」或 「项目已在回收站，无法更新工时」错误。 | worktime,createPlanTime | | getPlanTimeDetail | 该接口用于根据计划工时 ID 查询计划工时详情 | worktime,getPlanTimeDetail | | updatePlanTime | 该接口用于更新指定的单条计划工时记录 | worktime,updatePlanTime | | deletePlanTime | 该接口用于删除指定的单条计划工时记录 | worktime,deletePlanTime | | listTaskPlanTimes | 该接口用于根据任务 ID 查询单个任务的计划工时列表 | worktime,listTaskPlanTimes | | sumTaskPlanTime | 该接口用于根据任务 ID 查询单个任务的计划工时总和 | worktime,sumTaskPlanTime | | aggregateUserPlanTime | 该接口用于查询一定时间内指定用户的计划工时聚合数 | worktime,aggregateUserPlanTime | | createWorkTime | 该接口用于创建实际工时 注意： 项目归档或回收站 是不能填报工时的，接口会报 「项目已被归档，无法更新工时」或 「项目已在回收站，无法更新工时」错误。 | worktime,createWorkTime | | getWorkTimeDetail | 该接口用于根据实际工时 ID 查询实际工时详情 | worktime,getWorkTimeDetail | | updateWorkTime | 该接口用于更新指定的单条实际工时记录 | worktime,updateWorkTime | | deleteWorkTime | 该接口用于删除指定的单条实际工时记录 | worktime,deleteWorkTime | | listTaskWorkTimes | 该接口用于根据任务 ID 查询单个任务的实际工时列表 | worktime,listTaskWorkTimes | | sumTaskWorkTime | 该接口用于根据任务 ID 查询单个任务的实际工时总和 | worktime,sumTaskWorkTime,preset.default | | aggregateUserWorkTime | 该接口用于查询一定时间内指定用户的实际工时聚合数 | worktime,aggregateUserWorkTime,preset.default | | listPlanTimes | 获取用户所有计划工时详情数据 | worktime,listPlanTimes | | listWorkTimes | 获取用户所有实际工时详情数据。（含回收站任务） | worktime,listWorkTimes | | createWorkTimeApproval | 创建实际工时审批对象 | worktime,createWorkTimeApproval | | updateWorkTimeApproval | 更新工时审批对象 | worktime,updateWorkTimeApproval | | updateWorkTimeLimit | 更新工时企业人天的最大填报时间限制 | worktime,updateWorkTimeLimit |

customfield

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | createProjectCustomfieldV3 | 创建项目自定义字段(提交项目ID),创建企业自定义字段 | customfield,createProjectCustomfieldV3 | | deleteCustomfieldV3 | 删除自定义字段，默认删除企业自定义字段，如果传递项目ID，则删除项目下自定义字段 | customfield,deleteCustomfieldV3 | | searchOrgCustomfiledV3 | 搜索企业自定义字段 | customfield,searchOrgCustomfiledV3 | | updateCustomfieldV3 | 更新自定义字段，默认更新企业自定义字段，如果传递项目ID，则更新项目下自定义字段 | customfield,updateCustomfieldV3 | | searchFieldCategoriesV3 | 搜索企业自定义字段分类 | customfield,searchFieldCategoriesV3 | | countByCategoryV3 | 根据自定义字段分类统计自定义字段数 | customfield,countByCategoryV3 | | searchFieldChoicesV3 | 搜索层级字段选项 | customfield,searchFieldChoicesV3 | | updateFieldChoicesV3 | 更新层级字段选项 | customfield,updateFieldChoicesV3 |

project

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | listPrioritiesV3 | 查询企业优先级 | project,listPrioritiesV3 | | installProjectAppV3 | 安装项目应用 | project,installProjectAppV3 | | uninstallProjectAppV3 | 删除项目应用 | project,uninstallProjectAppV3 | | listProjectAppsV3 | 查询项目应用列表 | project,listProjectAppsV3 | | archiveProjectV3 | 项目放入回收站 | project,archiveProjectV3 | | copyProjectV3 | 复制项目 | project,copyProjectV3 | | createProjectFromTemplateV3 | 从模板创建项目 | project,createProjectFromTemplateV3 | | createProjectV3 | 创建项目 | project,createProjectV3,preset.default | | batchGetProjectCustomFiledByInstanceIdsV3 | 批量根据instanceId查询字段 | project,batchGetProjectCustomFiledByInstanceIdsV3 | | searchProjectCustomFiledsV3 | 搜索项目自定义字段 | project,searchProjectCustomFiledsV3,preset.default | | createProjectMemberV3 | 创建项目成员(弃用) | project,createProjectMemberV3 | | listProjectMembersV3 | 获取项目成员列表 | project,listProjectMembersV3,preset.default | | assignMemberRoleV3 | 修改项目成员的角色 | project,assignMemberRoleV3 | | getProjectLinksV3 | 获取项目关联列表 | project,getProjectLinksV3 | | createProjectLinkV3 | 创建项目关联 | project,createProjectLinkV3 | | deleteProjectLinkV3 | 删除项目关联 | project,deleteProjectLinkV3 | | getProjectTagsV3 | 查看项目的项目分组 | project,getProjectTagsV3,preset.default | | updateProjectTagsV3 | 更新项目的项目分组 | project,updateProjectTagsV3 | | queryProjectsV3 | 查询项目 | project,queryProjectsV3,preset.default | | createRoleFromTemplateV3 | 引入企业后台项目角色到项目 | project,createRoleFromTemplateV3 | | createProjectRoleV3 | 创建项目角色 | project,createProjectRoleV3 | | deleteProjectRoleV3 | 移除项目角色 | project,deleteProjectRoleV3 | | listProjectRolesV3 | 获取项目角色列表 | project,listProjectRolesV3 | | updateRolePermissionsV3 | 修改项目角色的权限项 | project,updateRolePermissionsV3 | | getScenarioFieldsV3 | 获取项目任务类型 | project,getScenarioFieldsV3,preset.default | | createStatusCustomFieldV3 | 更新项目概览自定义字段值 | project,createStatusCustomFieldV3 | | deleteStatusCustomFieldV3 | 删除项目概览自定义字段(弃用) | project,deleteStatusCustomFieldV3 | | listStatusCustomFieldsV3 | 查询项目概览自定义字段列表 | project,listStatusCustomFieldsV3 | | listProjectStatusesV3 | 查询项目状态和状态历史 | project,listProjectStatusesV3,preset.default | | restoreProjectV3 | 恢复归档项目 | project,restoreProjectV3 | | suspendProjectV3 | 归档项目 | project,suspendProjectV3 | | searchProjectTagsV3 | 搜索项目标签 | project,searchProjectTagsV3 | | searchProjectTasksV3 | 查询项目任务 | project,searchProjectTasksV3,preset.default | | createTaskflowV3 | 创建项目工作流 | project,createTaskflowV3 | | deleteTaskflowV3 | 删除项目工作流 | project,deleteTaskflowV3 | | updateTaskflowNameV3 | 更新项目工作流 | project,updateTaskflowNameV3 | | searchTaskflowsV3 | 搜索项目工作流 | project,searchTaskflowsV3,preset.default | | createTaskflowStatusV3 | 创建项目工作流状态 | project,createTaskflowStatusV3 | | searchTaskflowStatusesV3 | 搜索项目工作流状态 | project,searchTaskflowStatusesV3 | | searchTaskGroupsV3 | 搜索任务分组 | project,searchTaskGroupsV3,preset.default | | getTestCaseGroupMappings | 批量获取测试用例与归属分组的对应关系 | project,getTestCaseGroupMappings | | updateTestCaseGroup | 更新项目级测试用例分组 | project,updateTestCaseGroup | | updateProjectV3 | 更新项目 | project,updateProjectV3,preset.default | | queryProjectGroupsV3 | 查询项目分组 | project,queryProjectGroupsV3 | | searchProjectTemplatesV3 | 搜索企业项目模板 | project,searchProjectTemplatesV3 | | createOrgProjectRoleV3 | 创建企业后台项目角色 | project,createOrgProjectRoleV3 | | deleteOrgProjectRoleV3 | 删除企业后台项目角色 | project,deleteOrgProjectRoleV3 | | listOrgProjectRolesV3 | 获取企业后台项目角色 | project,listOrgProjectRolesV3 | | updateOrgProjectRoleV3 | 更新企业后台项目角色 | project,updateOrgProjectRoleV3 | | createTestPlanGroup | 创建测试计划分组 | project,createTestPlanGroup | | queryTestPlanGroups | 查询测试计划分组 | project,queryTestPlanGroups | | listTestPlanGroups | 获取测试计划分组列表 | project,listTestPlanGroups | | createTestPlan | 创建测试计划 | project,createTestPlan | | queryTestPlans | 查询测试计划 | project,queryTestPlans | | listTestPlans | 获取测试计划 | project,listTestPlans | | listUserProjectsV3 | 获取用户参与项目 | project,listUserProjectsV3,preset.default | | listProjectRemindersV3 | 获取项目「默认任务提醒」列表 | project,listProjectRemindersV3 | | listStoryGroupsV3 | 获取需求分类列表 | project,listStoryGroupsV3 | | createProjectGroupV3 | 创建项目分组 | project,createProjectGroupV3 | | addProjectMembersV3 | 创建项目成员 v2 | project,addProjectMembersV3,preset.default | | getMemberRolesV3 | 获取项目成员角色（包含权限穿透角色） | project,getMemberRolesV3,preset.default | | searchStagesV3 | 搜索任务列表 | project,searchStagesV3 | | listStatusExecutorsV3 | 列出项目工作流状态流转执行角色列表 | project,listStatusExecutorsV3 | | updateStatusExecutorsV3 | 更新项目工作流状态流转角色列表 | project,updateStatusExecutorsV3 | | listStatusValidatorsV3 | 列出项目工作流状态流转校验列表 | project,listStatusValidatorsV3 | | updateStatusValidatorsV3 | 更新项目工作流状态流转校验列表 | project,updateStatusValidatorsV3 | | updateProjectGroupV3 | 修改项目分组 | project,updateProjectGroupV3 | | deleteProjectGroupV3 | 删除项目分组 | project,deleteProjectGroupV3 | | removeStatusCustomFieldV3 | 删除项目概览自定义字段 | project,removeStatusCustomFieldV3 | | searchSprintsV3 | 迭代搜索 | project,searchSprintsV3 | | completeSprintV3 | 完成迭代 | project,completeSprintV3 | | createSprintV3 | 创建迭代 | project,createSprintV3 | | deleteSprintV3 | 删除迭代 | project,deleteSprintV3 | | updateSprintLabelV3 | 迭代标签更新 | project,updateSprintLabelV3 | | updateSprintLockV3 | 迭代锁定 | project,updateSprintLockV3 | | updateSprintPayloadV3 | 迭代操作限制更新 | project,updateSprintPayloadV3 | | restartSprintV3 | 重新开始迭代 | project,restartSprintV3 | | startSprintV3 | 开始迭代 | project,startSprintV3 | | updateSprintV3 | 迭代更新 | project,updateSprintV3 | | createProjectTagV3 | 创建项目标签 | project,createProjectTagV3 | | createProjectStatusV3 | 创建项目状态 | project,createProjectStatusV3 | | deleteProjectMemberV3 | 删除项目成员 | project,deleteProjectMemberV3 | | createTaskStageV3 | 创建任务列表 | project,createTaskStageV3 | | createTaskGroupV3 | 创建任务分组 | project,createTaskGroupV3 | | updateTaskStageNameV3 | 更新任务列表名称 | project,updateTaskStageNameV3 | | updateTaskGroupTitleV3 | 更新任务分组名称 | project,updateTaskGroupTitleV3 | | deleteTaskFlowStatusV3 | 删除项目工作流状态 | project,deleteTaskFlowStatusV3 | | updateTaskFlowStatusTypeV3 | 更新项目工作流状态 | project,updateTaskFlowStatusTypeV3 | | moveTaskFlowStatusV3 | 更新项目工作流状态位置 | project,moveTaskFlowStatusV3 | | updateTaskFlowStatusNameV3 | 更新项目工作流状态名字 | project,updateTaskFlowStatusNameV3 | | updateTaskFlowRejectStatusV3 | 更新项目工作流状态流转列表 | project,updateTaskFlowRejectStatusV3 | | copyProjectAsyncV3 | 异步复制项目, 不等待复制项目完成，需要轮询获取状态 | project,copyProjectAsyncV3 | | getAsyncJobResultV3 | 获取异步 job 执行结果，执行完毕则返回结果，否则继续用 readyKey 轮询 | project,getAsyncJobResultV3 | | searchOrgTaskFlowStatusesV3 | 搜索企业工作流状态 | project,searchOrgTaskFlowStatusesV3 | | createProjectTemplateV3 | 创建项目模版 | project,createProjectTemplateV3 | | deleteProjectTemplateV3 | 删除项目模版 | project,deleteProjectTemplateV3 | | countProjectTasksV3 | 计数项目任务 | project,countProjectTasksV3 | | addProjectGroupMemberV3 | 创建项目分组成员 | project,addProjectGroupMemberV3 | | listProjectGroupMembersV3 | 获取项目分组成员列表 | project,listProjectGroupMembersV3 | | removeProjectGroupMemberV3 | 删除项目分组成员 | project,removeProjectGroupMemberV3 | | updateProjectGroupMemberPermissionV3 | 更新项目分组成员权限 | project,updateProjectGroupMemberPermissionV3 | | queryGroupProjects | 根据项目分组 ID 查询项目 | project,queryGroupProjects | | updateProjectTemplateInfoV3 | 修改项目模板基本信息 | project,updateProjectTemplateInfoV3 | | listBugGroups | 获取缺陷分类列表 | project,listBugGroups | | deleteProjectV3 | 删除项目 | project,deleteProjectV3 | | starProject | 创建用户星标项目 | project,starProject | | listStarredProjects | 查询用户星标项目 | project,listStarredProjects | | listStatusFieldGroupsV3 | 查询项目概览字段分组列表 | project,listStatusFieldGroupsV3 | | updateStatusFieldGroupsV3 | 更新项目概览字段分组列表，覆盖式全量更新 | project,updateStatusFieldGroupsV3 | | updateProjectCustomFieldPosition | 更新项目概览自定义字段位置 | project,updateProjectCustomFieldPosition | | searchProjectsTQL | 通过TQL搜索项目 | project,searchProjectsTQL | | updateStatusCustomFieldV3 | 更新项目概览自定义字段 | project,updateStatusCustomFieldV3 | | getProjectProgram | 查询项目所属项目集id | project,getProjectProgram | | getProjectOrgChart | 获取项目组织架构图 | project,getProjectOrgChart | | updateProjectCode | 更新项目编号 | project,updateProjectCode | | getProjectTableCustomField | 获取项目的表格自定义字段 | project,getProjectTableCustomField | | updateProjectTableCustomField | 更新项目的表格自定义字段 | project,updateProjectTableCustomField | | searchTaskflowNodes | 搜索项目工作流节点 | project,searchTaskflowNodes | | createBugGroup | 创建缺陷分类 | project,createBugGroup | | createStoryGroup | 创建需求分类 | project,createStoryGroup |

sfc

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | createSfcV3 | 创建项目任务类型(提交项目ID)，创建企业任务类型 | sfc,createSfcV3 | | updateSfcV3 | 修改项目任务类型(提交项目ID)，修改企业任务类型 | sfc,updateSfcV3 | | updateSfcTaskflowV3 | 修改项目下任务类型绑定工作流 | sfc,updateSfcTaskflowV3 | | deleteSfcV3 | 删除项目任务类型(提交项目ID)，删除企业任务类型 | sfc,deleteSfcV3 | | deleteSfcFieldV3 | 删除项目/企业的任务类型的字段 | sfc,deleteSfcFieldV3 | | updateSfcFieldV3 | 创建/修改 项目/企业的任务类型的字段 | sfc,updateSfcFieldV3 | | searchOrgSfcV3 | 搜索企业任务类型 | sfc,searchOrgSfcV3 |

task

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | archiveTaskV3 | 归档任务(移入回收站) | task,archiveTaskV3 | | createTaskCommentV3 | 评论任务 | task,createTaskCommentV3 | | updateTaskContentV3 | 更新任务标题 | task,updateTaskContentV3,preset.default | | createTaskV3 | 创建任务 | task,createTaskV3,preset.default | | updateTaskCusomFieldByInstanceV3 | 根据字段InstanceId更新任务自定义字段值(弃用) | task,updateTaskCusomFieldByInstanceV3 | | updateTaskCusomFieldV3 | 更新任务自定义字段值 | task,updateTaskCusomFieldV3,preset.default | | updateTaskCustomFieldV2 | 更新任务自定义字段值(弃用) | task,updateTaskCustomFieldV2 | | deleteTaskV3 | 删除任务 | task,deleteTaskV3 | | updateTaskDueDateV3 | 更新任务截止时间 | task,updateTaskDueDateV3,preset.default | | updateTaskExecutorV3 | 更新任务执行者 | task,updateTaskExecutorV3,preset.default | | updateTaskMembersV3 | 更新任务参与者 | task,updateTaskMembersV3,preset.default | | moveTaskV3 | 跨项目移动任务 | task,moveTaskV3 | | updateTaskNoteV3 | 更新任务备注 | task,updateTaskNoteV3,preset.default | | getTaskLinksV3 | 获取任务关联列表 | task,getTaskLinksV3,preset.default | | createTaskLinkV3 | 创建任务关联 | task,createTaskLinkV3,preset.default | | deleteTaskLinkV3 | 删除任务关联 | task,deleteTaskLinkV3 | | updateTaskPriorityV3 | 更新任务优先级 | task,updateTaskPriorityV3,preset.default | | queryTaskV3 | 查询任务详情 | task,queryTaskV3,preset.default | | updateTaskStartDateV3 | 更新任务开始时间 | task,updateTaskStartDateV3,preset.default | | updateTaskTagsV3 | 更新任务标签 | task,updateTaskTagsV3 | | updateTaskStatusV3 | 更新任务状态 | task,updateTaskStatusV3,preset.default | | getTemplateV2 | 根据ID获取任务类型信息V2 | task,getTemplateV2 | | updateTaskCustomField | 更新任务字段信息 | task,updateTaskCustomField | | getTaskDependenciesV3 | 获取任务依赖 | task,getTaskDependenciesV3,preset.default | | getTaskTracesV3 | 获取任务进展 | task,getTaskTracesV3 | | listTaskActivitiesV3 | 列出任务动态 | task,listTaskActivitiesV3 | | updateTaskProgressV3 | 更新任务进度 | task,updateTaskProgressV3,preset.default | | updateTaskParentV3 | 改变任务的父任务 | task,updateTaskParentV3,preset.default | | updateTaskStageV3 | 更新任务列表 | task,updateTaskStageV3,preset.default | | updateTaskStoryPointV3 | 更新任务StoryPoint | task,updateTaskStoryPointV3,preset.default | | updateTaskSprintV3 | 更新任务迭代 | task,updateTaskSprintV3,preset.default | | createTaskTraceV3 | 创建任务进展 | task,createTaskTraceV3 | | searchUserTasksV3 | 搜索用户的任务，用户参与的/用户执行的/用户创建的 | task,searchUserTasksV3 | | updateTaskSfcV3 | 更新任务的任务类型 | task,updateTaskSfcV3 | | renderTaskRtfV3 | 任务富文本内容渲染为 html | task,renderTaskRtfV3 | | createTaskDependencyV3 | 创建任务依赖 | task,createTaskDependencyV3 | | deleteTaskDependencyV3 | 删除任务依赖 | task,deleteTaskDependencyV3 | | updateTaskLockV3 | 更新任务加锁/解锁动作 | task,updateTaskLockV3 | | updateTaskVisibilityV3 | 更新任务可见性 | task,updateTaskVisibilityV3,preset.default | | restoreTaskV3 | 恢复任务(移出回收站) | task,restoreTaskV3 | | moveOrgTaskToProject | 轻任务移动到项目中 | task,moveOrgTaskToProject | | getTaskTableCustomFieldV3 | 获取任务的表格自定义字段 | task,getTaskTableCustomFieldV3 | | updateTaskTableCustomFieldV3 | 更新任务的表格自定义字段 | task,updateTaskTableCustomFieldV3 | | searchTasksByTQLV2 | 通过TQL搜索自由任务和项目任务ID | task,searchTasksByTQLV2 |

dingGroup

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | getBindingCidsByProjectId | 通过projectid查询关联的全员可见的群聊ids | dingGroup,getBindingCidsByProjectId | | getBindingProjectIdsByCid | 根据群聊cid获取绑定的项目projectid | dingGroup,getBindingProjectIdsByCid | | getBindingCidByTaskId | 通过taskId查询该任务关联的任务群Id | dingGroup,getBindingCidByTaskId |

report

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | sumWorkTimeByUser | 按人维度汇总工时 | report,sumWorkTimeByUser | | sumProjectWorkTime | 不计算回收站任务，并且过滤掉了不是入参项目的任务 | report,sumProjectWorkTime |

webhook

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | getEgressIps | 如果ISV和应用接入方基于安全等考虑，需要获取Teambition webhook 服务器的 IP 地址列表，以便进行相关限制，可以通过该接口获得Webhook服务器 IP 地址列表或者 IP 网段信息。 由于出口 IP 及入口 IP 可能存在变动，建议用户每天请求接口1次，以便于及时更新 IP 列表。为了避免造成单点故障，强烈建议用户不要长期使用旧的 IP 列表作为Teambition webhook 回调请求的白名单。 | webhook,getEgressIps | | restartWebhookListen | 消费者服务启动并开始监听上报 | webhook,restartWebhookListen |

tag

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | createOrgTagV3 | 创建企业标签 | tag,createOrgTagV3 | | searchOrgTagsV3 | 搜索企业标签 | tag,searchOrgTagsV3 |

code

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | updatePipelinePlatform | 更新流水线源平台 | code,updatePipelinePlatform | | getPipelinePlatform | 根据名称查询流水线源平台 | code,getPipelinePlatform | | updatePipelineParams | 更新参数 | code,updatePipelineParams | | getPipeline | 根据code查询流水线 | code,getPipeline | | getPlatforms | 查询流水线源平台 | code,getPlatforms | | createPlatform | 创建流水线源平台 | code,createPlatform | | syncPipelines | 同步流水线信息 | code,syncPipelines | | syncBuilds | 同步构建信息 | code,syncBuilds |

file

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | createUploadTokenV3 | 创建文件上传凭证 | file,createUploadTokenV3 | | createFileV3 | 创建文件库文件 | file,createFileV3 | | listFilesV3 | 获取文件列表 | file,listFilesV3 | | createFolderV3 | 创建文件夹 | file,createFolderV3 | | moveFolderV3 | 移动文件夹 | file,moveFolderV3 | | updateFolderTitleV3 | 更新文件夹标题 | file,updateFolderTitleV3 | | getFolderDetailV3 | 获取文件夹详情 | file,getFolderDetailV3 | | getFileDetailV3 | 获取项目文件详情 | file,getFileDetailV3 | | updateFileNameV3 | 更新文件标题 | file,updateFileNameV3 | | moveFileV3 | 项目内移动文件 | file,moveFileV3 | | updateFileVersionV3 | 更新文件版本 | file,updateFileVersionV3 | | getFileToken | 从现有文件资源创建 fileToken，可用于创建其他文件资源 | file,getFileToken | | batchGetFileDetails | 根据 resourceId 批量获取文件详情 | file,batchGetFileDetails | | updateFolderVisibility | 更新文件夹可见性 | file,updateFolderVisibility | | searchFilesV3 | 搜索文件列表 | file,searchFilesV3 |

gantt

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | getBaselineTasksV3 | 获取甘特图基线下的任务，只有传统快照型基线才有数据 | gantt,getBaselineTasksV3 | | getBaselinesV3 | 获取项目下甘特图基线 | gantt,getBaselinesV3 | | updateBaseline | 更新项目下甘特图基线 | gantt,updateBaseline | | createBaseline | 项目下创建甘特图基线 | gantt,createBaseline |

seat

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | createQuotaRule | 把企业成员加入到坐席分配规则中 | seat,createQuotaRule |

group

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | searchGroups | 该接口用于搜索群组 | group,searchGroups | | createGroup | 该接口用于创建群组 | group,createGroup | | updateGroup | 该接口用于更新群组 | group,updateGroup | | deleteGroup | 该接口用于删除群组 | group,deleteGroup | | listGroupMembers | 该接口用于获取群组成员列表 | group,listGroupMembers | | batchGetGroupMembers | 批量获取群组成员 | group,batchGetGroupMembers | | addGroupMember | 该接口用于添加群组成员 | group,addGroupMember | | removeGroupMember | 删除群组成员 | group,removeGroupMember | | batchGetGroups | 该接口用于根据群组 ID 批量获取群组信息 | group,batchGetGroups |

program

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | createProgramV3 | 创建项目集 | program,createProgramV3 | | deleteProgramV3 | 删除项目集 | program,deleteProgramV3 | | addProgramProjectsV3 | 批量添加项目到项目集 | program,addProgramProjectsV3 | | removeProgramProjectV3 | 删除项目集内的项目 | program,removeProgramProjectV3 | | listProgramProjectsV3 | 查询项目集内项目 | program,listProgramProjectsV3 | | getProgramsV3 | 查询项目集 | program,getProgramsV3 | | addProgramMembersV3 | 批量添加成员到项目集 | program,addProgramMembersV3 | | removeProgramMembersV3 | 批量删除项目集内的成员 | program,removeProgramMembersV3 | | listProgramMembersV3 | 查询项目集内成员 | program,listProgramMembersV3 | | createProgramStatusV3 | 创建项目集状态 | program,createProgramStatusV3 | | createProgramStatusCustomFieldV3 | 更新项目集概览自定义字段值 | program,createProgramStatusCustomFieldV3 | | deleteProgramStatusCustomFieldV3 | 删除项目集概览自定义字段 | program,deleteProgramStatusCustomFieldV3 | | listProgramStatusCustomFieldsV3 | 查询项目集概览自定义字段列表 | program,listProgramStatusCustomFieldsV3 | | deleteProgramStatusV3 | 删除项目集状态 | program,deleteProgramStatusV3 | | listProgramStatusesV3 | 查询项目集状态和状态历史 | program,listProgramStatusesV3 |

dingtalk

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | getTaskIdsByApproveId | 通过钉钉审批实例ID反查对应任务IDs | dingtalk,getTaskIdsByApproveId | | bindProjectWorkspace | 绑定已有知识库 | dingtalk,bindProjectWorkspace | | getWorkspaceInfo | 获取绑定知识库信息 | dingtalk,getWorkspaceInfo |

autoflow

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | triggerCustomEvent | 触发自动化自定义事件 | autoflow,triggerCustomEvent |

taskflow

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | searchOrgTaskFlowsV3 | 搜索企业工作流 | taskflow,searchOrgTaskFlowsV3 |

testcase

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | createTestCaseV3 | 创建测试用例 | testcase,createTestCaseV3 | | queryTestCasesV3 | 查询测试用例列表 | testcase,queryTestCasesV3 | | getProjectTestHubV3 | 查询项目用例库 | testcase,getProjectTestHubV3 | | queryProjectTestHubCasesV3 | 查询项目用例库用例列表 | testcase,queryProjectTestHubCasesV3 | | planTestCaseV3 | 将用例库的基础用例规划至测试计划中，异步接口直接返回。 | testcase,planTestCaseV3 | | updateTestCaseFlowStatusV3 | 更新测试用例状态 | testcase,updateTestCaseFlowStatusV3 | | queryOrgTestHubsV3 | 查询企业用例库列表 | testcase,queryOrgTestHubsV3 | | queryOrgUserCasesV3 | 查询企业用例库用例列表V2 | testcase,queryOrgUserCasesV3 | | queryTestGroupsV3 | 批量查询用例分组 | testcase,queryTestGroupsV3 |

projectplan

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | getPlanV3 | 查询计划 | projectplan,getPlanV3 | | getPlanStatusV3 | 查询计划状态信息 | projectplan,getPlanStatusV3 | | getProjectPlanStatusSettingV3 | 获取项目级计划自定义状态配置 | projectplan,getProjectPlanStatusSettingV3 | | createProjectPlanStatusSettingV3 | 配置项目级计划自定义状态信息 | projectplan,createProjectPlanStatusSettingV3 | | updatePlanCustomStatusV3 | 配置计划自定义状态 | projectplan,updatePlanCustomStatusV3 | | updatePlanMemberRoleV3 | 修改计划成员角色 | projectplan,updatePlanMemberRoleV3 | | executePlanEventV3 | 更改计划状态 | projectplan,executePlanEventV3 | | updatePlanApprovalV3 | 更新计划审批信息 | projectplan,updatePlanApprovalV3 | | createPlanApprovalV3 | 创建计划审批信息 | projectplan,createPlanApprovalV3 | | searchProjectPlanTasksV3 | 通过TQL搜索项目计划任务 | projectplan,searchProjectPlanTasksV3 | | listVisiblePlansV3 | 查询用户可见的计划列表 | projectplan,listVisiblePlansV3 | | listProjectPlanTasksLegacyV3 | 获取计划任务列表 | projectplan,listProjectPlanTasksLegacyV3 | | updateProjectPlanTaskV3 | 更新计划任务（标题、开始时间、截止时间） | projectplan,updateProjectPlanTaskV3 | | listPlanVersionsV3 | 查询用户计划版本列表 | projectplan,listPlanVersionsV3 | | listPlanMemberRolesV3 | 查询计划成员角色 | projectplan,listPlanMemberRolesV3 |

form

| Tool Name | Description | FilterKey | |-----------|-------------|--------| | searchFormRecordProcessNodesV3 | 获取表单记录流程节点信息 | form,searchFormRecordProcessNodesV3 | | createFormRecordV3 | 创建表单记录 | form,createFormRecordV3 | | updateFormRecordFieldV3 | 更新表单字段值 | form,updateFormRecordFieldV3 | | getFormProjectSpaceLinkV3 | 根据项目ID获取表单空间ID或根据表单空间ID获取项目ID | form,getFormProjectSpaceLinkV3 | | listAllFormSpaceNodesV3 | 获取表单空间节点列表，返回该表单空间下的所有节点，如果带有节点id作为查询，则返回某节点下的所有节点 | form,listAllFormSpaceNodesV3 |