Jira is a leading project management and issue tracking platform that helps teams plan, track, and manage agile software development projects effectively. As part of the Atlassian suite, Jira has become the industry standard for software development teams and project management professionals worldwide.
Jira provides a comprehensive set of tools for managing complex projects through its flexible and customizable workflow system. With its robust API and integration capabilities, Jira enables teams to streamline their development processes and maintain clear visibility of project progress.
Key features of Jira include:
- Agile Project Management: Support for Scrum and Kanban methodologies with customizable boards and workflows
- Issue Tracking: Sophisticated tracking system for bugs, stories, epics, and tasks with detailed reporting
- Workflow Automation: Powerful automation rules to streamline repetitive tasks and processes
- Advanced Search: JQL (Jira Query Language) for complex issue filtering and reporting
In Sim, the Jira integration allows your agents to seamlessly interact with your project management workflow. This creates opportunities for automated issue creation, updates, and tracking as part of your AI workflows. The integration enables agents to create, retrieve, and update Jira issues programmatically, facilitating automated project management tasks and ensuring that important information is properly tracked and documented. By connecting Sim with Jira, you can build intelligent agents that maintain project visibility while automating routine project management tasks, enhancing team productivity and ensuring consistent project tracking.
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
Retrieve detailed information about a specific Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to retrieve (e.g., PROJ-123) |
includeAttachments | boolean | No | Download attachment file contents and include them as files in the output |
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
Update a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to update (e.g., PROJ-123) |
summary | string | No | New summary for the issue |
description | string | No | New description for the issue |
priority | string | No | New priority ID or name for the issue (e.g., "High") |
assignee | string | No | New assignee account ID for the issue |
labels | json | No | Labels to set on the issue (array of label name strings) |
components | json | No | Components to set on the issue (array of component name strings) |
duedate | string | No | Due date for the issue (format: YYYY-MM-DD) |
fixVersions | json | No | Fix versions to set (array of version name strings) |
environment | string | No | Environment information for the issue |
customFieldId | string | No | Custom field ID to update (e.g., customfield_10001) |
customFieldValue | string | No | Value for the custom field |
notifyUsers | boolean | No | Whether to send email notifications about this update (default: true) |
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
Create a new Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
projectId | string | Yes | Jira project key (e.g., PROJ) |
summary | string | Yes | Summary for the issue |
description | string | No | Description for the issue |
priority | string | No | Priority ID or name for the issue (e.g., "10000" or "High") |
assignee | string | No | Assignee account ID for the issue |
cloudId | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
issueType | string | Yes | Type of issue to create (e.g., Task, Story, Bug, Epic, Sub-task) |
parent | json | No | Parent issue key for creating subtasks (e.g., { "key": "PROJ-123" }) |
labels | array | No | Labels for the issue (array of label names) |
components | array | No | Components for the issue (array of component names) |
duedate | string | No | Due date for the issue (format: YYYY-MM-DD) |
fixVersions | array | No | Fix versions for the issue (array of version names) |
reporter | string | No | Reporter account ID for the issue |
environment | string | No | Environment information for the issue |
customFieldId | string | No | Custom field ID (e.g., customfield_10001) |
customFieldValue | string | No | Value for the custom field |
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
Retrieve multiple Jira issues from a project in bulk
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
projectId | string | Yes | Jira project key (e.g., PROJ) |
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
Delete a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to delete (e.g., PROJ-123) |
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
Assign a Jira issue to a user
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to assign (e.g., PROJ-123) |
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
Move a Jira issue between workflow statuses (e.g., To Do -> In Progress)
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to transition (e.g., PROJ-123) |
transitionId | string | Yes | ID of the transition to execute (e.g., "11" for "To Do", "21" for "In Progress") |
comment | string | No | Optional comment to add when transitioning the issue |
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
Search for Jira issues using JQL (Jira Query Language)
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
jql | string | Yes | JQL query string to search for issues (e.g., "project = PROJ AND status = Open") |
nextPageToken | string | No | Cursor token for the next page of results. Omit for the first page. |
maxResults | number | No | Maximum number of results to return per page (default: 50) |
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
Add a comment to a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to add comment to (e.g., PROJ-123) |
body | string | Yes | Comment body text |
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
Get all comments from a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to get comments from (e.g., PROJ-123) |
startAt | number | No | Index of the first comment to return (default: 0) |
maxResults | number | No | Maximum number of comments to return (default: 50) |
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
Update an existing comment on a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key containing the comment (e.g., PROJ-123) |
commentId | string | Yes | ID of the comment to update |
body | string | Yes | Updated comment text |
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 | Updated comment text |
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
Delete a comment from a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key containing the comment (e.g., PROJ-123) |
commentId | string | Yes | ID of the comment to delete |
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
Get all attachments from a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to get attachments from (e.g., PROJ-123) |
includeAttachments | boolean | No | Download attachment file contents and include them as files in the output |
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
Add attachments to a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to add attachments to (e.g., PROJ-123) |
files | file[] | Yes | Files to attach to the Jira issue |
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
Delete an attachment from a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
attachmentId | string | Yes | ID of the attachment to delete |
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
Add a time tracking worklog entry to a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to add worklog to (e.g., PROJ-123) |
timeSpentSeconds | number | Yes | Time spent in seconds |
comment | string | No | Optional comment for the worklog entry |
started | string | No | Optional start time in ISO format (defaults to current time) |
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 | Time spent in seconds |
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
Get all worklog entries from a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to get worklogs from (e.g., PROJ-123) |
startAt | number | No | Index of the first worklog to return (default: 0) |
maxResults | number | No | Maximum number of worklogs to return (default: 50) |
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
Update an existing worklog entry on a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key containing the worklog (e.g., PROJ-123) |
worklogId | string | Yes | ID of the worklog entry to update |
timeSpentSeconds | number | No | Time spent in seconds |
comment | string | No | Optional comment for the worklog entry |
started | string | No | Optional start time in ISO format |
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 | Time spent in seconds |
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
Delete a worklog entry from a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key containing the worklog (e.g., PROJ-123) |
worklogId | string | Yes | ID of the worklog entry to delete |
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
Create a link relationship between two Jira issues
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
inwardIssueKey | string | Yes | Jira issue key for the inward issue (e.g., PROJ-123) |
outwardIssueKey | string | Yes | Jira issue key for the outward issue (e.g., PROJ-456) |
linkType | string | Yes | The type of link relationship (e.g., "Blocks", "Relates to", "Duplicates") |
comment | string | No | Optional comment to add to the issue link |
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
Delete a link between two Jira issues
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
linkId | string | Yes | ID of the issue link to delete |
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
Add a watcher to a Jira issue to receive notifications about updates
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to add watcher to (e.g., PROJ-123) |
accountId | string | Yes | Account ID of the user to add as watcher |
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
Remove a watcher from a Jira issue
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
domain | string | Yes | Your Jira domain (e.g., yourcompany.atlassian.net) |
issueKey | string | Yes | Jira issue key to remove watcher from (e.g., PROJ-123) |
accountId | string | Yes | Account ID of the user to remove as watcher |
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 | Your Jira domain (e.g., yourcompany.atlassian.net) |
accountId | string | No | Optional account ID to get a specific user. If not provided, returns all users. |
startAt | number | No | The index of the first user to return (for pagination, default: 0) |
maxResults | number | No | Maximum number of users to return (default: 50) |
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 |