Usage Instructions
Integrate Jira into the workflow. Can read, write, and update issues. Can also trigger workflows based on Jira webhook events.
Tools
jira_retrieve
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
includeAttachments | boolean | No | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
id | string | Issue ID |
key | string | Issue key (e.g., PROJ-123) |
self | string | REST API URL for this issue |
summary | string | Issue summary |
description | string | Issue description text (extracted from ADF) |
status | object | Issue status |
↳ id | string | Status ID |
↳ name | string | Status name (e.g., Open, In Progress, Done) |
↳ description | string | Status description |
↳ statusCategory | object | Status category grouping |
↳ id | number | Status category ID |
↳ key | string | Status category key (e.g., new, indeterminate, done) |
↳ name | string | Status category name (e.g., To Do, In Progress, Done) |
↳ colorName | string | Status category color (e.g., blue-gray, yellow, green) |
statusName | string | Issue status name (e.g., Open, In Progress, Done) |
issuetype | object | Issue type |
↳ id | string | Issue type ID |
↳ name | string | Issue type name (e.g., Task, Bug, Story, Epic) |
↳ description | string | Issue type description |
↳ subtask | boolean | Whether this is a subtask type |
↳ iconUrl | string | URL to the issue type icon |
project | object | Project the issue belongs to |
↳ id | string | Project ID |
↳ key | string | Project key (e.g., PROJ) |
↳ name | string | Project name |
↳ projectTypeKey | string | Project type key (e.g., software, business) |
priority | object | Issue priority |
↳ id | string | Priority ID |
↳ name | string | Priority name (e.g., Highest, High, Medium, Low, Lowest) |
↳ iconUrl | string | URL to the priority icon |
assignee | object | Assigned user |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
assigneeName | string | Assignee display name or account ID |
reporter | object | Reporter user |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
creator | object | Issue creator |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
labels | array | Issue labels |
components | array | Issue components |
↳ id | string | Component ID |
↳ name | string | Component name |
↳ description | string | Component description |
fixVersions | array | Fix versions |
↳ id | string | Version ID |
↳ name | string | Version name |
↳ released | boolean | Whether the version is released |
↳ releaseDate | string | Release date (YYYY-MM-DD) |
resolution | object | Issue resolution |
↳ id | string | Resolution ID |
↳ name | string | Resolution name (e.g., Fixed, Duplicate, Won't Fix) |
↳ description | string | Resolution description |
duedate | string | Due date (YYYY-MM-DD) |
created | string | ISO 8601 timestamp when the issue was created |
updated | string | ISO 8601 timestamp when the issue was last updated |
resolutiondate | string | ISO 8601 timestamp when the issue was resolved |
timetracking | object | Time tracking information |
↳ originalEstimate | string | Original estimate in human-readable format (e.g., 1w 2d) |
↳ remainingEstimate | string | Remaining estimate in human-readable format |
↳ timeSpent | string | Time spent in human-readable format |
↳ originalEstimateSeconds | number | Original estimate in seconds |
↳ remainingEstimateSeconds | number | Remaining estimate in seconds |
↳ timeSpentSeconds | number | Time spent in seconds |
parent | object | Parent issue (for subtasks) |
↳ id | string | Parent issue ID |
↳ key | string | Parent issue key |
↳ summary | string | Parent issue summary |
issuelinks | array | Linked issues |
↳ id | string | Issue link ID |
↳ type | object | Link type information |
↳ id | string | Link type ID |
↳ name | string | Link type name (e.g., Blocks, Relates) |
↳ inward | string | Inward description (e.g., is blocked by) |
↳ outward | string | Outward description (e.g., blocks) |
↳ inwardIssue | object | Inward linked issue |
↳ id | string | Issue ID |
↳ key | string | Issue key |
↳ statusName | string | Issue status name |
↳ summary | string | Issue summary |
↳ outwardIssue | object | Outward linked issue |
↳ id | string | Issue ID |
↳ key | string | Issue key |
↳ statusName | string | Issue status name |
↳ summary | string | Issue summary |
subtasks | array | Subtask issues |
↳ id | string | Subtask issue ID |
↳ key | string | Subtask issue key |
↳ summary | string | Subtask summary |
↳ statusName | string | Subtask status name |
↳ issueTypeName | string | Subtask issue type name |
votes | object | Vote information |
↳ votes | number | Number of votes |
↳ hasVoted | boolean | Whether the current user has voted |
watches | object | Watch information |
↳ watchCount | number | Number of watchers |
↳ isWatching | boolean | Whether the current user is watching |
comments | array | Issue comments (fetched separately) |
↳ id | string | Comment ID |
↳ body | string | Comment body text (extracted from ADF) |
↳ author | object | Comment author |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ authorName | string | Comment author display name |
↳ updateAuthor | object | User who last updated the comment |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ created | string | ISO 8601 timestamp when the comment was created |
↳ updated | string | ISO 8601 timestamp when the comment was last updated |
↳ visibility | object | Comment visibility restriction |
↳ type | string | Restriction type (e.g., role, group) |
↳ value | string | Restriction value (e.g., Administrators) |
worklogs | array | Issue worklogs (fetched separately) |
↳ id | string | Worklog ID |
↳ author | object | Worklog author |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ authorName | string | Worklog author display name |
↳ updateAuthor | object | User who last updated the worklog |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ comment | string | Worklog comment text |
↳ started | string | ISO 8601 timestamp when the work started |
↳ timeSpent | string | Time spent in human-readable format (e.g., 3h 20m) |
↳ timeSpentSeconds | number | Time spent in seconds |
↳ created | string | ISO 8601 timestamp when the worklog was created |
↳ updated | string | ISO 8601 timestamp when the worklog was last updated |
attachments | array | Issue attachments |
↳ id | string | Attachment ID |
↳ filename | string | Attachment file name |
↳ mimeType | string | MIME type of the attachment |
↳ size | number | File size in bytes |
↳ content | string | URL to download the attachment content |
↳ thumbnail | string | URL to the attachment thumbnail |
↳ author | object | Attachment author |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ authorName | string | Attachment author display name |
↳ created | string | ISO 8601 timestamp when the attachment was created |
issueKey | string | Issue key (e.g., PROJ-123) |
issue | json | Complete raw Jira issue object from the API |
files | file[] | Downloaded attachment files (only when includeAttachments is true) |
jira_update
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
summary | string | No | No description |
description | string | No | No description |
priority | string | No | New priority ID or name for the issue (e.g., "High") |
assignee | string | No | No description |
labels | json | No | No description |
components | json | No | No description |
duedate | string | No | No description |
fixVersions | json | No | No description |
environment | string | No | No description |
customFieldId | string | No | No description |
customFieldValue | string | No | No description |
notifyUsers | boolean | No | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Updated issue key (e.g., PROJ-123) |
summary | string | Issue summary after update |
jira_write
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
projectId | string | Yes | No description |
summary | string | Yes | No description |
description | string | No | No description |
priority | string | No | Priority ID or name for the issue (e.g., "10000" or "High") |
assignee | string | No | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
issueType | string | Yes | No description |
parent | json | No | Parent issue key for creating subtasks (e.g., { "key": "PROJ-123" }) |
labels | array | No | No description |
components | array | No | No description |
duedate | string | No | No description |
fixVersions | array | No | No description |
reporter | string | No | No description |
environment | string | No | No description |
customFieldId | string | No | No description |
customFieldValue | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
id | string | Created issue ID |
issueKey | string | Created issue key (e.g., PROJ-123) |
self | string | REST API URL for the created issue |
summary | string | Issue summary |
success | boolean | Whether the issue was created successfully |
url | string | URL to the created issue in Jira |
assigneeId | string | Account ID of the assigned user (null if no assignee was set) |
jira_bulk_read
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
projectId | string | Yes | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
total | number | Total number of issues in the project (may not always be available) |
issues | array | Array of Jira issues |
↳ id | string | Issue ID |
↳ key | string | Issue key (e.g., PROJ-123) |
↳ self | string | REST API URL for this issue |
↳ summary | string | Issue summary |
↳ description | string | Issue description text |
↳ status | object | Issue status |
↳ id | string | Status ID |
↳ name | string | Status name |
↳ issuetype | object | Issue type |
↳ id | string | Issue type ID |
↳ name | string | Issue type name |
↳ priority | object | Issue priority |
↳ id | string | Priority ID |
↳ name | string | Priority name |
↳ assignee | object | Assigned user |
↳ accountId | string | Atlassian account ID |
↳ displayName | string | Display name |
↳ created | string | ISO 8601 creation timestamp |
↳ updated | string | ISO 8601 last updated timestamp |
nextPageToken | string | Cursor token for the next page. Null when no more results. |
isLast | boolean | Whether this is the last page of results |
jira_delete_issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
deleteSubtasks | boolean | No | Whether to delete subtasks. If false, parent issues with subtasks cannot be deleted. |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Deleted issue key |
jira_assign_issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
accountId | string | Yes | Account ID of the user to assign the issue to. Use "-1" for automatic assignment or null to unassign. |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Issue key that was assigned |
assigneeId | string | Account ID of the assignee (use "-1" for auto-assign, null to unassign) |
jira_transition_issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
transitionId | string | Yes | ID of the transition to execute (e.g., "11" for "To Do", "21" for "In Progress") |
comment | string | No | No description |
resolution | string | No | Resolution name to set during transition (e.g., "Fixed", "Won't Fix") |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Issue key that was transitioned |
transitionId | string | Applied transition ID |
transitionName | string | Applied transition name |
toStatus | object | Target status after transition |
↳ id | string | Status ID |
↳ name | string | Status name |
jira_search_issues
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
jql | string | Yes | JQL query string to search for issues (e.g., "project = PROJ AND status = Open") |
nextPageToken | string | No | No description |
maxResults | number | No | No description |
fields | array | No | Array of field names to return (default: all navigable). Use "*all" for every field. |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
issues | array | Array of matching issues |
↳ id | string | Issue ID |
↳ key | string | Issue key (e.g., PROJ-123) |
↳ self | string | REST API URL for this issue |
↳ summary | string | Issue summary |
↳ description | string | Issue description text (extracted from ADF) |
↳ status | object | Issue status |
↳ id | string | Status ID |
↳ name | string | Status name (e.g., Open, In Progress, Done) |
↳ description | string | Status description |
↳ statusCategory | object | Status category grouping |
↳ id | number | Status category ID |
↳ key | string | Status category key (e.g., new, indeterminate, done) |
↳ name | string | Status category name (e.g., To Do, In Progress, Done) |
↳ colorName | string | Status category color (e.g., blue-gray, yellow, green) |
↳ statusName | string | Issue status name (e.g., Open, In Progress, Done) |
↳ issuetype | object | Issue type |
↳ id | string | Issue type ID |
↳ name | string | Issue type name (e.g., Task, Bug, Story, Epic) |
↳ description | string | Issue type description |
↳ subtask | boolean | Whether this is a subtask type |
↳ iconUrl | string | URL to the issue type icon |
↳ project | object | Project the issue belongs to |
↳ id | string | Project ID |
↳ key | string | Project key (e.g., PROJ) |
↳ name | string | Project name |
↳ projectTypeKey | string | Project type key (e.g., software, business) |
↳ priority | object | Issue priority |
↳ id | string | Priority ID |
↳ name | string | Priority name (e.g., Highest, High, Medium, Low, Lowest) |
↳ iconUrl | string | URL to the priority icon |
↳ assignee | object | Assigned user |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ assigneeName | string | Assignee display name or account ID |
↳ reporter | object | Reporter user |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ labels | array | Issue labels |
↳ components | array | Issue components |
↳ id | string | Component ID |
↳ name | string | Component name |
↳ description | string | Component description |
↳ resolution | object | Issue resolution |
↳ id | string | Resolution ID |
↳ name | string | Resolution name (e.g., Fixed, Duplicate, Won't Fix) |
↳ description | string | Resolution description |
↳ duedate | string | Due date (YYYY-MM-DD) |
↳ created | string | ISO 8601 timestamp when the issue was created |
↳ updated | string | ISO 8601 timestamp when the issue was last updated |
nextPageToken | string | Cursor token for the next page. Null when no more results. |
isLast | boolean | Whether this is the last page of results |
total | number | Total number of matching issues (may not always be available) |
jira_add_comment
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
body | string | Yes | No description |
visibility | json | No | Restrict comment visibility. Object with "type" ("role" or "group") and "value" (role/group name). |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Issue key the comment was added to |
commentId | string | Created comment ID |
body | string | Comment text content |
author | object | Comment author |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
created | string | ISO 8601 timestamp when the comment was created |
updated | string | ISO 8601 timestamp when the comment was last updated |
jira_get_comments
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
startAt | number | No | No description |
maxResults | number | No | No description |
orderBy | string | No | Sort order for comments: "-created" for newest first, "created" for oldest first |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
issueKey | string | Issue key |
total | number | Total number of comments |
startAt | number | Pagination start index |
maxResults | number | Maximum results per page |
comments | array | Array of comments |
↳ id | string | Comment ID |
↳ body | string | Comment body text (extracted from ADF) |
↳ author | object | Comment author |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ authorName | string | Comment author display name |
↳ updateAuthor | object | User who last updated the comment |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ created | string | ISO 8601 timestamp when the comment was created |
↳ updated | string | ISO 8601 timestamp when the comment was last updated |
↳ visibility | object | Comment visibility restriction |
↳ type | string | Restriction type (e.g., role, group) |
↳ value | string | Restriction value (e.g., Administrators) |
jira_update_comment
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
commentId | string | Yes | No description |
body | string | Yes | No description |
visibility | json | No | Restrict comment visibility. Object with "type" ("role" or "group") and "value" (role/group name). |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Issue key |
commentId | string | Updated comment ID |
body | string | body output from the tool |
author | object | Comment author |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
created | string | ISO 8601 timestamp when the comment was created |
updated | string | ISO 8601 timestamp when the comment was last updated |
jira_delete_comment
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
commentId | string | Yes | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Issue key |
commentId | string | Deleted comment ID |
jira_get_attachments
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
includeAttachments | boolean | No | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
issueKey | string | Issue key |
attachments | array | Array of attachments |
↳ id | string | Attachment ID |
↳ filename | string | Attachment file name |
↳ mimeType | string | MIME type of the attachment |
↳ size | number | File size in bytes |
↳ content | string | URL to download the attachment content |
↳ thumbnail | string | URL to the attachment thumbnail |
↳ author | object | Attachment author |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ authorName | string | Attachment author display name |
↳ created | string | ISO 8601 timestamp when the attachment was created |
files | file[] | Downloaded attachment files (only when includeAttachments is true) |
jira_add_attachment
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
files | file[] | Yes | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
issueKey | string | Issue key |
attachments | array | Uploaded attachments |
↳ id | string | Attachment ID |
↳ filename | string | Attachment file name |
↳ mimeType | string | MIME type |
↳ size | number | File size in bytes |
↳ content | string | URL to download the attachment |
attachmentIds | array | Array of attachment IDs |
files | file[] | Uploaded attachment files |
jira_delete_attachment
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
attachmentId | string | Yes | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
attachmentId | string | Deleted attachment ID |
jira_add_worklog
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
timeSpentSeconds | number | Yes | No description |
comment | string | No | No description |
started | string | No | No description |
visibility | json | No | Restrict worklog visibility. Object with "type" ("role" or "group") and "value" (role/group name). |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Issue key the worklog was added to |
worklogId | string | Created worklog ID |
timeSpent | string | Time spent in human-readable format (e.g., 3h 20m) |
timeSpentSeconds | number | timeSpentSeconds output from the tool |
author | object | Worklog author |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
started | string | ISO 8601 timestamp when the work started |
created | string | ISO 8601 timestamp when the worklog was created |
jira_get_worklogs
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
startAt | number | No | No description |
maxResults | number | No | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
issueKey | string | Issue key |
total | number | Total number of worklogs |
startAt | number | Pagination start index |
maxResults | number | Maximum results per page |
worklogs | array | Array of worklogs |
↳ id | string | Worklog ID |
↳ author | object | Worklog author |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ authorName | string | Worklog author display name |
↳ updateAuthor | object | User who last updated the worklog |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ comment | string | Worklog comment text |
↳ started | string | ISO 8601 timestamp when the work started |
↳ timeSpent | string | Time spent in human-readable format (e.g., 3h 20m) |
↳ timeSpentSeconds | number | Time spent in seconds |
↳ created | string | ISO 8601 timestamp when the worklog was created |
↳ updated | string | ISO 8601 timestamp when the worklog was last updated |
jira_update_worklog
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
worklogId | string | Yes | No description |
timeSpentSeconds | number | No | No description |
comment | string | No | No description |
started | string | No | No description |
visibility | json | No | Restrict worklog visibility. Object with "type" ("role" or "group") and "value" (role/group name). |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Issue key |
worklogId | string | Updated worklog ID |
timeSpent | string | Human-readable time spent (e.g., "3h 20m") |
timeSpentSeconds | number | timeSpentSeconds output from the tool |
comment | string | Worklog comment text |
author | object | Worklog author |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
updateAuthor | object | User who last updated the worklog |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
started | string | Worklog start time in ISO format |
created | string | Worklog creation time |
updated | string | Worklog last update time |
jira_delete_worklog
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
worklogId | string | Yes | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Issue key |
worklogId | string | Deleted worklog ID |
jira_create_issue_link
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
inwardIssueKey | string | Yes | No description |
outwardIssueKey | string | Yes | No description |
linkType | string | Yes | The type of link relationship (e.g., "Blocks", "Relates to", "Duplicates") |
comment | string | No | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
inwardIssue | string | Inward issue key |
outwardIssue | string | Outward issue key |
linkType | string | Type of issue link |
linkId | string | Created link ID |
jira_delete_issue_link
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
linkId | string | Yes | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
linkId | string | Deleted link ID |
jira_add_watcher
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
accountId | string | Yes | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Issue key |
watcherAccountId | string | Added watcher account ID |
jira_remove_watcher
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
issueKey | string | Yes | No description |
accountId | string | Yes | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
success | boolean | Operation success status |
issueKey | string | Issue key |
watcherAccountId | string | Removed watcher account ID |
jira_get_users
Get Jira users. If an account ID is provided, returns a single user. Otherwise, returns a list of all users.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
accountId | string | No | Optional account ID to get a specific user. If not provided, returns all users. |
startAt | number | No | No description |
maxResults | number | No | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
users | array | Array of Jira users |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ avatarUrls | json | User avatar URLs in multiple sizes (16x16, 24x24, 32x32, 48x48) |
↳ self | string | REST API URL for this user |
total | number | Total number of users returned |
startAt | number | Pagination start index |
maxResults | number | Maximum results per page |
jira_search_users
Search for Jira users by email address or display name. Returns matching users with their accountId, displayName, and emailAddress.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | No description |
query | string | Yes | A query string to search for users. Can be an email address, display name, or partial match. |
maxResults | number | No | No description |
startAt | number | No | No description |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
Output
| Parameter | Type | Description |
|---|---|---|
ts | string | ISO 8601 timestamp of the operation |
users | array | Array of matching Jira users |
↳ accountId | string | Atlassian account ID of the user |
↳ displayName | string | Display name of the user |
↳ active | boolean | Whether the user account is active |
↳ emailAddress | string | Email address of the user |
↳ accountType | string | Type of account (e.g., atlassian, app, customer) |
↳ avatarUrl | string | URL to the user avatar (48x48) |
↳ timeZone | string | User timezone |
↳ self | string | REST API URL for this user |
total | number | Number of users returned in this page (may be less than total matches) |
startAt | number | Pagination start index |
maxResults | number | Maximum results per page |
jira_dc_retrieve
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
baseUrl | string | Yes | No description |
authType | string | Yes | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
issueKey | string | Yes | No description |
Output
| Parameter | Type | Description |
|---|---|---|
id | string | id output from the tool |
key | string | key output from the tool |
self | string | self output from the tool |
summary | string | summary output from the tool |
description | string | description output from the tool |
status | string | status output from the tool |
issuetype | string | issuetype output from the tool |
project | string | project output from the tool |
priority | string | priority output from the tool |
assignee | string | assignee output from the tool |
reporter | string | reporter output from the tool |
created | string | created output from the tool |
updated | string | updated output from the tool |
labels | array | labels output from the tool |
raw | json | raw output from the tool |
jira_dc_search_issues
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
baseUrl | string | Yes | No description |
authType | string | Yes | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
jql | string | Yes | No description |
startAt | number | No | No description |
maxResults | number | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
issues | array | issues output from the tool |
total | number | total output from the tool |
startAt | number | startAt output from the tool |
maxResults | number | maxResults output from the tool |
jira_dc_write
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
baseUrl | string | Yes | No description |
authType | string | Yes | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
projectKey | string | Yes | No description |
summary | string | Yes | No description |
description | string | No | No description |
issueType | string | No | No description |
assignee | string | No | No description |
priority | string | No | No description |
labels | string | No | No description |
duedate | string | No | No description |
components | string | No | No description |
fixVersions | string | No | No description |
parentIssue | string | No | No description |
customFieldId | string | No | No description |
customFieldValue | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
id | string | id output from the tool |
key | string | key output from the tool |
self | string | self output from the tool |
jira_dc_update
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
baseUrl | string | Yes | No description |
authType | string | Yes | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
issueKey | string | Yes | No description |
summary | string | No | No description |
description | string | No | No description |
assignee | string | No | No description |
priority | string | No | No description |
labels | string | No | No description |
duedate | string | No | No description |
components | string | No | No description |
fixVersions | string | No | No description |
customFieldId | string | No | No description |
customFieldValue | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | message output from the tool |
jira_dc_delete
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
baseUrl | string | Yes | No description |
authType | string | Yes | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
issueKey | string | Yes | No description |
deleteSubtasks | boolean | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | message output from the tool |
jira_dc_transition_issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
baseUrl | string | Yes | No description |
authType | string | Yes | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
issueKey | string | Yes | No description |
transitionId | string | Yes | No description |
resolution | string | No | Resolution name (e.g. Fixed, Won't Fix) |
comment | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | message output from the tool |
jira_dc_add_comment
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
baseUrl | string | Yes | No description |
authType | string | Yes | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
issueKey | string | Yes | No description |
comment | string | Yes | No description |
Output
| Parameter | Type | Description |
|---|---|---|
id | string | id output from the tool |
message | string | message output from the tool |
jira_dc_assign_issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
baseUrl | string | Yes | No description |
authType | string | Yes | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
issueKey | string | Yes | No description |
accountId | string | Yes | No description |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | message output from the tool |
jira_list_boards
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | No | No description |
domain | string | No | No description |
deployment | string | No | No description |
baseUrl | string | No | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
boards | json | boards output from the tool |
total | number | total output from the tool |
jira_create_sprint
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | No | No description |
domain | string | No | No description |
deployment | string | No | No description |
baseUrl | string | No | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
boardId | number | Yes | No description |
name | string | Yes | No description |
startDate | string | No | No description |
endDate | string | No | No description |
goal | string | No | No description |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | id output from the tool |
name | string | name output from the tool |
state | string | state output from the tool |
boardId | number | boardId output from the tool |
goal | string | goal output from the tool |
startDate | string | startDate output from the tool |
endDate | string | endDate output from the tool |
self | string | self output from the tool |
jira_add_issue_to_sprint
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
oauthCredential | string | No | No description |
domain | string | No | No description |
deployment | string | No | No description |
baseUrl | string | No | No description |
patToken | string | No | No description |
username | string | No | No description |
password | string | No | No description |
sprintId | number | Yes | No description |
issueKeys | string | Yes | No description |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | message output from the tool |
sprintId | number | sprintId output from the tool |
issueKeys | array | issueKeys output from the tool |