jira-automation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Jira Automation via Rube MCP

通过Rube MCP实现Jira自动化

Automate Jira operations through Composio's Jira toolkit via Rube MCP.

通过Composio的Jira工具集，借助Rube MCP自动化Jira操作。

Prerequisites

前置条件

Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
Active Jira connection via
```
RUBE_MANAGE_CONNECTIONS
```
with toolkit
```
jira
```
Always call
```
RUBE_SEARCH_TOOLS
```
first to get current tool schemas

必须已连接Rube MCP（需具备RUBE_SEARCH_TOOLS权限）
通过
```
RUBE_MANAGE_CONNECTIONS
```
激活Jira连接，工具集选择
```
jira
```
请始终先调用
```
RUBE_SEARCH_TOOLS
```
以获取最新的工具架构

Setup

设置步骤

Get Rube MCP: Add

https://rube.app/mcp

as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.

Verify Rube MCP is available by confirming
```
RUBE_SEARCH_TOOLS
```
responds
Call
```
RUBE_MANAGE_CONNECTIONS
```
with toolkit
```
jira
```
If connection is not ACTIVE, follow the returned auth link to complete Jira OAuth
Confirm connection status shows ACTIVE before running any workflows

获取Rube MCP：在客户端配置中添加

https://rube.app/mcp

作为MCP服务器。无需API密钥——只需添加端点即可使用。

确认
```
RUBE_SEARCH_TOOLS
```
可响应，以此验证Rube MCP是否可用
调用
```
RUBE_MANAGE_CONNECTIONS
```
并指定工具集为
```
jira
```
如果连接状态未显示为ACTIVE，请按照返回的授权链接完成Jira OAuth认证
在运行任何工作流之前，确认连接状态为ACTIVE

Core Workflows

核心工作流

1. Search and Filter Issues

1. 搜索与筛选问题

When to use: User wants to find issues using JQL or browse project issues

Tool sequence:

```
JIRA_SEARCH_FOR_ISSUES_USING_JQL_POST
```
- Search with JQL query [Required]
```
JIRA_GET_ISSUE
```
- Get full details of a specific issue [Optional]

Key parameters:

jql

: JQL query string (e.g.,

project = PROJ AND status = "In Progress"

)

```
maxResults
```
: Max results per page (default 50, max 100)
```
startAt
```
: Pagination offset
```
fields
```
: Array of field names to return
```
issueIdOrKey
```
: Issue key like 'PROJ-123' for GET_ISSUE

Pitfalls:

JQL field names are case-sensitive and must match Jira configuration
Custom fields use IDs like
```
customfield_10001
```
, not display names
Results are paginated; check
```
total
```
vs
```
startAt + maxResults
```
to continue

适用场景：用户希望通过JQL查找问题或浏览项目中的问题

工具调用流程:

```
JIRA_SEARCH_FOR_ISSUES_USING_JQL_POST
```
- 使用JQL查询进行搜索【必填】
```
JIRA_GET_ISSUE
```
- 获取特定问题的完整详情【可选】

关键参数:

jql

: JQL查询字符串（例如：

project = PROJ AND status = "In Progress"

）

```
maxResults
```
: 每页最大结果数（默认50，上限100）
```
startAt
```
: 分页偏移量
```
fields
```
: 需返回的字段名称数组
```
issueIdOrKey
```
: 用于GET_ISSUE的问题键，如'PROJ-123'

注意事项:

JQL字段名称区分大小写，必须与Jira配置一致
自定义字段使用ID（如
```
customfield_10001
```
），而非显示名称
结果支持分页；需对比
```
total
```
与
```
startAt + maxResults
```
的值来判断是否需要继续获取后续页面

2. Create and Edit Issues

2. 创建与编辑问题

When to use: User wants to create new issues or update existing ones

Tool sequence:

```
JIRA_GET_ALL_PROJECTS
```
- List projects to find project key [Prerequisite]
```
JIRA_GET_FIELDS
```
- Get available fields and their IDs [Prerequisite]
```
JIRA_CREATE_ISSUE
```
- Create a new issue [Required]
```
JIRA_EDIT_ISSUE
```
- Update fields on an existing issue [Optional]
```
JIRA_ASSIGN_ISSUE
```
- Assign issue to a user [Optional]

Key parameters:

```
project
```
: Project key (e.g., 'PROJ')
```
issuetype
```
: Issue type name (e.g., 'Bug', 'Story', 'Task')
```
summary
```
: Issue title
```
description
```
: Issue description (Atlassian Document Format or plain text)
```
issueIdOrKey
```
: Issue key for edits

Pitfalls:

Issue types and required fields vary by project; use GET_FIELDS to check
Custom fields require exact field IDs, not display names
Description may need Atlassian Document Format (ADF) for rich content

适用场景：用户希望创建新问题或更新现有问题

工具调用流程:

```
JIRA_GET_ALL_PROJECTS
```
- 列出所有项目以获取项目键【前置步骤】
```
JIRA_GET_FIELDS
```
- 获取可用字段及其ID【前置步骤】
```
JIRA_CREATE_ISSUE
```
- 创建新问题【必填】
```
JIRA_EDIT_ISSUE
```
- 更新现有问题的字段【可选】
```
JIRA_ASSIGN_ISSUE
```
- 将问题分配给指定用户【可选】

关键参数:

```
project
```
: 项目键（例如：'PROJ'）
```
issuetype
```
: 问题类型名称（例如：'Bug'、'Story'、'Task'）
```
summary
```
: 问题标题
```
description
```
: 问题描述（支持Atlassian文档格式或纯文本）
```
issueIdOrKey
```
: 用于编辑操作的问题键

注意事项:

问题类型和必填字段因项目而异；请使用GET_FIELDS进行检查
自定义字段需要精确的字段ID，而非显示名称
若需富文本内容，描述需使用Atlassian文档格式（ADF）

3. Manage Sprints and Boards

3. 管理迭代与看板

When to use: User wants to work with agile boards, sprints, and backlogs

Tool sequence:

```
JIRA_LIST_BOARDS
```
- List all boards [Prerequisite]
```
JIRA_LIST_SPRINTS
```
- List sprints for a board [Required]
```
JIRA_MOVE_ISSUE_TO_SPRINT
```
- Move issue to a sprint [Optional]
```
JIRA_CREATE_SPRINT
```
- Create a new sprint [Optional]

Key parameters:

```
boardId
```
: Board ID from LIST_BOARDS
```
sprintId
```
: Sprint ID for move operations
```
name
```
: Sprint name for creation
```
startDate
```
/
```
endDate
```
: Sprint dates in ISO format

Pitfalls:

Boards and sprints are specific to Jira Software (not Jira Core)
Only one sprint can be active at a time per board

适用场景：用户希望操作敏捷看板、迭代与待办事项

工具调用流程:

```
JIRA_LIST_BOARDS
```
- 列出所有看板【前置步骤】
```
JIRA_LIST_SPRINTS
```
- 列出指定看板下的迭代【必填】
```
JIRA_MOVE_ISSUE_TO_SPRINT
```
- 将问题移至指定迭代【可选】
```
JIRA_CREATE_SPRINT
```
- 创建新迭代【可选】

关键参数:

```
boardId
```
: 来自LIST_BOARDS的看板ID
```
sprintId
```
: 用于移动操作的迭代ID
```
name
```
: 待创建的迭代名称
```
startDate
```
/
```
endDate
```
: ISO格式的迭代起止日期

注意事项:

看板和迭代是Jira Software（而非Jira Core）的专属功能
每个看板同一时间仅能有一个活跃迭代

4. Manage Comments

4. 管理评论

When to use: User wants to add or view comments on issues

Tool sequence:

```
JIRA_LIST_ISSUE_COMMENTS
```
- List existing comments [Optional]
```
JIRA_ADD_COMMENT
```
- Add a comment to an issue [Required]

Key parameters:

```
issueIdOrKey
```
: Issue key like 'PROJ-123'
```
body
```
: Comment body (supports ADF for rich text)

Pitfalls:

Comments support ADF (Atlassian Document Format) for formatting
Mentions use account IDs, not usernames

适用场景：用户希望在问题上添加或查看评论

工具调用流程:

```
JIRA_LIST_ISSUE_COMMENTS
```
- 列出现有评论【可选】
```
JIRA_ADD_COMMENT
```
- 为问题添加评论【必填】

关键参数:

```
issueIdOrKey
```
: 问题键，如'PROJ-123'
```
body
```
: 评论内容（支持ADF富文本格式）

注意事项:

评论支持使用Atlassian文档格式（ADF）进行格式化
提及用户需使用账户ID，而非用户名

5. Manage Projects and Users

5. 管理项目与用户

When to use: User wants to list projects, find users, or manage project roles

Tool sequence:

```
JIRA_GET_ALL_PROJECTS
```
- List all projects [Optional]
```
JIRA_GET_PROJECT
```
- Get project details [Optional]
```
JIRA_FIND_USERS
```
/
```
JIRA_GET_ALL_USERS
```
- Search for users [Optional]
```
JIRA_GET_PROJECT_ROLES
```
- List project roles [Optional]
```
JIRA_ADD_USERS_TO_PROJECT_ROLE
```
- Add user to role [Optional]

Key parameters:

```
projectIdOrKey
```
: Project key
```
query
```
: Search text for FIND_USERS
```
roleId
```
: Role ID for role operations

Pitfalls:

User operations use account IDs (not email or display name)
Project roles differ from global permissions

适用场景：用户希望列出项目、查找用户或管理项目角色

工具调用流程:

```
JIRA_GET_ALL_PROJECTS
```
- 列出所有项目【可选】
```
JIRA_GET_PROJECT
```
- 获取项目详情【可选】
```
JIRA_FIND_USERS
```
/
```
JIRA_GET_ALL_USERS
```
- 搜索用户【可选】
```
JIRA_GET_PROJECT_ROLES
```
- 列出项目角色【可选】
```
JIRA_ADD_USERS_TO_PROJECT_ROLE
```
- 将用户添加至指定角色【可选】

关键参数:

```
projectIdOrKey
```
: 项目键
```
query
```
: FIND_USERS的搜索文本
```
roleId
```
: 角色操作对应的角色ID

注意事项:

用户操作使用账户ID（而非邮箱或显示名称）
项目角色与全局权限不同

Common Patterns

通用模式

JQL Syntax

JQL语法

Common operators:

```
project = "PROJ"
```
- Filter by project
```
status = "In Progress"
```
- Filter by status
```
assignee = currentUser()
```
- Current user's issues
```
created >= -7d
```
- Created in last 7 days
```
labels = "bug"
```
- Filter by label
```
priority = High
```
- Filter by priority
```
ORDER BY created DESC
```
- Sort results

Combinators:

```
AND
```
- Both conditions
```
OR
```
- Either condition
```
NOT
```
- Negate condition

常用运算符:

```
project = "PROJ"
```
- 按项目筛选
```
status = "In Progress"
```
- 按状态筛选
```
assignee = currentUser()
```
- 当前用户的问题
```
created >= -7d
```
- 过去7天创建的问题
```
labels = "bug"
```
- 按标签筛选
```
priority = High
```
- 按优先级筛选
```
ORDER BY created DESC
```
- 按创建时间倒序排序

组合符:

```
AND
```
- 同时满足两个条件
```
OR
```
- 满足任一条件
```
NOT
```
- 否定条件

Pagination

分页处理

Use
```
startAt
```
and
```
maxResults
```
parameters
Check
```
total
```
in response to determine remaining pages
Continue until
```
startAt + maxResults >= total
```

使用
```
startAt
```
和
```
maxResults
```
参数
检查响应中的
```
total
```
值以确定是否还有剩余页面
持续调用直到
```
startAt + maxResults >= total
```

Known Pitfalls

常见注意事项

Field Names:

Custom fields use IDs like
```
customfield_10001
```
Use JIRA_GET_FIELDS to discover field IDs and names
Field names in JQL may differ from API field names

Authentication:

Jira Cloud uses account IDs, not usernames
Site URL must be configured correctly in the connection

字段名称:

自定义字段使用ID（如
```
customfield_10001
```
）
使用JIRA_GET_FIELDS发现字段ID和名称
JQL中的字段名称可能与API字段名称不同

认证:

Jira Cloud使用账户ID，而非用户名
连接时必须正确配置站点URL

Quick Reference

快速参考

Task	Tool Slug	Key Params
Search issues (JQL)	JIRA_SEARCH_FOR_ISSUES_USING_JQL_POST	jql, maxResults
Get issue	JIRA_GET_ISSUE	issueIdOrKey
Create issue	JIRA_CREATE_ISSUE	project, issuetype, summary
Edit issue	JIRA_EDIT_ISSUE	issueIdOrKey, fields
Assign issue	JIRA_ASSIGN_ISSUE	issueIdOrKey, accountId
Add comment	JIRA_ADD_COMMENT	issueIdOrKey, body
List comments	JIRA_LIST_ISSUE_COMMENTS	issueIdOrKey
List projects	JIRA_GET_ALL_PROJECTS	(none)
Get project	JIRA_GET_PROJECT	projectIdOrKey
List boards	JIRA_LIST_BOARDS	(none)
List sprints	JIRA_LIST_SPRINTS	boardId
Move to sprint	JIRA_MOVE_ISSUE_TO_SPRINT	sprintId, issues
Create sprint	JIRA_CREATE_SPRINT	name, boardId
Find users	JIRA_FIND_USERS	query
Get fields	JIRA_GET_FIELDS	(none)
List filters	JIRA_LIST_FILTERS	(none)
Project roles	JIRA_GET_PROJECT_ROLES	projectIdOrKey
Project versions	JIRA_GET_PROJECT_VERSIONS	projectIdOrKey

任务	工具标识	关键参数
搜索问题（JQL）	JIRA_SEARCH_FOR_ISSUES_USING_JQL_POST	jql, maxResults
获取问题详情	JIRA_GET_ISSUE	issueIdOrKey
创建问题	JIRA_CREATE_ISSUE	project, issuetype, summary
编辑问题	JIRA_EDIT_ISSUE	issueIdOrKey, fields
分配问题	JIRA_ASSIGN_ISSUE	issueIdOrKey, accountId
添加评论	JIRA_ADD_COMMENT	issueIdOrKey, body
列出评论	JIRA_LIST_ISSUE_COMMENTS	issueIdOrKey
列出项目	JIRA_GET_ALL_PROJECTS	无
获取项目详情	JIRA_GET_PROJECT	projectIdOrKey
列出看板	JIRA_LIST_BOARDS	无
列出迭代	JIRA_LIST_SPRINTS	boardId
移至迭代	JIRA_MOVE_ISSUE_TO_SPRINT	sprintId, issues
创建迭代	JIRA_CREATE_SPRINT	name, boardId
查找用户	JIRA_FIND_USERS	query
获取字段列表	JIRA_GET_FIELDS	无
列出筛选器	JIRA_LIST_FILTERS	无
项目角色	JIRA_GET_PROJECT_ROLES	projectIdOrKey
项目版本	JIRA_GET_PROJECT_VERSIONS	projectIdOrKey