Jira tools

Look up the Jira tools, selectors, permissions, inputs, and outputs available to tool steps and agent steps.

This reference lists the shipped Jira tool catalog. See the Jira overview for authentication and setup.

Tool catalog

Jira read tools require the read:jira-work OAuth scope. Jira write tools require write:jira-work.

Tools

readget_issue

Retrieve a Jira issue by its ID or key.

Requiresread

Parameters

idOrKeystringRequired

Jira issue ID or key, such as ENG-123

fieldsarray of string

fieldsByKeysboolean

Interpret fields by their keys instead of IDs

expandstring

Comma-separated Jira issue expansions

propertiesarray of string

updateHistoryboolean

Record this issue as viewed by the authorizing user

readsearch_issues

Search Jira issues with a JQL query.

Requiresread

Parameters

jqlstringRequired

Jira Query Language expression

maxResultsinteger

Maximum number of issues to return

nextPageTokenstring

Pagination token from a previous search

fieldsarray of string

fieldsByKeysboolean

Interpret fields by their keys instead of IDs

expandstring

Comma-separated Jira issue expansions

propertiesarray of string

reconcileIssuesarray of integer

readget_issue_comments

List the comments on a Jira issue.

Requiresread

Parameters

idOrKeystringRequired

Jira issue ID or key, such as ENG-123

startAtinteger

Zero-based comment offset

maxResultsinteger

Maximum number of comments to return

orderBystring

Comment ordering expression

expandstring

Comma-separated Jira comment expansions

readget_issue_transitions

List the workflow transitions available for a Jira issue.

Requiresread

Parameters

idOrKeystringRequired

Jira issue ID or key, such as ENG-123

expandstring

Comma-separated transition expansions, such as transitions.fields

readget_project

Retrieve a Jira project by its ID or key.

Requiresread

Parameters

idOrKeystringRequired

Jira project ID or key, such as ENG

expandstring

Comma-separated Jira project expansions

propertiesarray of string

readget_user

Retrieve a Jira user by Atlassian account ID.

Requiresread

Parameters

accountIdstringRequired

Atlassian account ID

expandstring

Comma-separated Jira user expansions

writecreate_issue

Create a Jira issue using Jira REST issue fields. If both a project key and project ID or both an issue type name and issue type ID are supplied, the ID takes precedence.

Requireswrite

Parameters

projectKeystring

Jira project key; projectId takes precedence if both are supplied

projectIdstring

Jira project ID; takes precedence over projectKey

summarystringRequired

Issue summary

issueTypestring

Issue type name; issueTypeId takes precedence if both are supplied

issueTypeIdstring

Issue type ID; takes precedence over issueType

assigneeAccountIdstring

Atlassian account ID to assign

prioritystring

Jira priority name

labelsarray of string

bodystring

Plain-text issue description

fieldsobject

Jira issue fields keyed by their REST API field name

updateobject

Jira issue field update operations

writeupdate_issue

Update a Jira issue using Jira REST issue fields.

Requireswrite

Parameters

idOrKeystringRequired

Jira issue ID or key, such as ENG-123

summarystring

Replacement issue summary

issueTypestring

Replacement issue type name; issueTypeId takes precedence if both are supplied

issueTypeIdstring

Replacement issue type ID; takes precedence over issueType

assigneeAccountIdstring

Atlassian account ID to assign

prioritystring

Replacement Jira priority name

labelsarray of string

bodystring

Plain-text replacement issue description

fieldsobject

Jira issue fields keyed by their REST API field name

updateobject

Jira issue field update operations

writeadd_comment

Add a plain-text comment to a Jira issue.

Requireswrite

Parameters

idOrKeystringRequired

Jira issue ID or key, such as ENG-123

bodystringRequired

Plain-text comment body

writetransition_issue

Move a Jira issue through a workflow transition.

Requireswrite

Parameters

idOrKeystringRequired

Jira issue ID or key, such as ENG-123

transitionIdstringRequired

Jira workflow transition ID

fieldsobject

Jira issue fields keyed by their REST API field name

updateobject

Jira issue field update operations

- key: transition_issue
  tool: transition_issue
  connection: jira_acme # Replace with the slug of your integration connection.
  with:
    idOrKey: ENG-123
    transitionId: <transitionId>

writeassign_issue

Assign or unassign a Jira issue by Atlassian account ID.

Requireswrite

Parameters

idOrKeystringRequired

Jira issue ID or key, such as ENG-123

accountIdstring | nullRequired

Atlassian account ID, or null to unassign

Was this page helpful?

Edit this page on GitHub

Tool catalog

Tools

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

On this page