Jira

The Jira toolkit provides a comprehensive set of tools for interacting with Jira, enabling users and AI applications to efficiently manage issues and projects. With this toolkit, you can:

• Create, update, and search for Jira issues using various parameters.
• Retrieve detailed information about issues, projects, users, and issue types.
• Manage issue labels and attachments, including adding and removing them.
• Transition issues between different statuses and manage comments on issues.
• Browse and list available projects, priorities, and users within Jira.

This toolkit streamlines the process of issue management, making it easier to integrate Jira functionalities into applications and workflows.

Available Tools

Jira.ListIssueTypesByProject

Get the list of issue types (e.g. ‘Task’, ‘Epic’, etc.) available to a given project.

Parameters

• project (string, required) The project to get issue types for. Provide a project name, key, or ID. If a project name is provided, the tool will try to find a unique exact match among the available projects.
• limit (integer, optional) The maximum number of issue types to retrieve. Min of 1, max of 200. Defaults to 200.
• offset (integer, optional) The number of issue types to skip. Defaults to 0 (start from the first issue type).

Jira.GetIssueTypeById

Get the details of a Jira issue type by its ID.

Parameters

• issue_type_id (string, required) The ID of the issue type to retrieve

Jira.GetIssueById

Get the details of a Jira issue by its ID.

Parameters

• issue (string, required) The ID or key of the issue to retrieve

Jira.GetIssuesWithoutId

Search for Jira issues when you don’t have the issue ID(s).

Parameters

• keywords (string, optional) Keywords to search for issues. Matches against the issue name, description, comments, and any custom field of type text. Defaults to None (no keywords filtering).
• due_from (string, optional) Match issues due on or after this date. Format: YYYY-MM-DD. Ex: ‘2025-01-01’. Defaults to None (no due date filtering).
• due_until (string, optional) Match issues due on or before this date. Format: YYYY-MM-DD. Ex: ‘2025-01-01’. Defaults to None (no due date filtering).
• status (string, optional) Match issues that are in this status. Provide a status name. Ex: ‘To Do’, ‘In Progress’, ‘Done’. Defaults to None (any status).
• priority (string, optional) Match issues that have this priority. Provide a priority name. E.g. ‘Highest’. Defaults to None (any priority).
• assignee (string, optional) Match issues that are assigned to this user. Provide the user’s name or email address. Ex: ‘John Doe’ or ‘john.doe@example.com’. Defaults to None (any assignee).
• project (string, optional) Match issues that are associated with this project. Provide the project’s name, ID, or key. If a project name is provided, the tool will try to find a unique exact match among the available projects. Defaults to None (search across all projects).
• issue_type (string, optional) Match issues that are of this issue type. Provide an issue type name or ID. E.g. ‘Task’, ‘Epic’, ‘12345’. If a name is provided, the tool will try to find a unique exact match among the available issue types. Defaults to None (any issue type).
• labels (array[string], optional) Match issues that are in these labels. Defaults to None (any label).
• parent_issue (string, optional) Match issues that are a child of this issue. Provide the issue’s ID or key. Defaults to None (no parent issue filtering).
• limit (integer, optional) The maximum number of issues to retrieve. Min 1, max 100, default 50.
• next_page_token (string, optional) The token to use to get the next page of issues. Defaults to None (first page).

Jira.ListIssues

Get the issues for a given project.

Parameters

• project (string, optional) The project to get issues for. Provide a project ID, key or name. If a project is not provided and 1) the user has only one project, the tool will use that; 2) the user has multiple projects, the tool will raise an error listing the available projects to choose from.
• limit (integer, optional) The maximum number of issues to retrieve. Min 1, max 100, default 50.
• next_page_token (string, optional) The token to use to get the next page of issues. Defaults to None (first page).

Jira.SearchIssuesWithoutJql

Parameterized search for Jira issues (without having to provide a JQL query).

Parameters

• keywords (string, optional) Keywords to search for issues. Matches against the issue name, description, comments, and any custom field of type text. Defaults to None (no keywords filtering).
• due_from (string, optional) Match issues due on or after this date. Format: YYYY-MM-DD. Ex: ‘2025-01-01’. Defaults to None (no due date filtering).
• due_until (string, optional) Match issues due on or before this date. Format: YYYY-MM-DD. Ex: ‘2025-01-01’. Defaults to None (no due date filtering).
• status (string, optional) Match issues that are in this status. Provide a status name. Ex: ‘To Do’, ‘In Progress’, ‘Done’. Defaults to None (any status).
• priority (string, optional) Match issues that have this priority. Provide a priority name. E.g. ‘Highest’. Defaults to None (any priority).
• assignee (string, optional) Match issues that are assigned to this user. Provide the user’s name or email address. Ex: ‘John Doe’ or ‘john.doe@example.com’. Defaults to None (any assignee).
• project (string, optional) Match issues that are associated with this project. Provide the project’s name, ID, or key. If a project name is provided, the tool will try to find a unique exact match among the available projects. Defaults to None (search across all projects).
• issue_type (string, optional) Match issues that are of this issue type. Provide an issue type name or ID. E.g. ‘Task’, ‘Epic’, ‘12345’. If a name is provided, the tool will try to find a unique exact match among the available issue types. Defaults to None (any issue type).
• labels (array[string], optional) Match issues that are in these labels. Defaults to None (any label).
• parent_issue (string, optional) Match issues that are a child of this issue. Provide the issue’s ID or key. Defaults to None (no parent issue filtering).
• limit (integer, optional) The maximum number of issues to retrieve. Min 1, max 100, default 50.
• next_page_token (string, optional) The token to use to get the next page of issues. Defaults to None (first page).

Jira.SearchIssuesWithJql

Search for Jira issues using a JQL (Jira Query Language) query.

Parameters

• jql (string, required) The JQL (Jira Query Language) query to search for issues
• limit (integer, optional) The maximum number of issues to retrieve. Min of 1, max of 100. Defaults to 50.
• next_page_token (string, optional) The token to use to get the next page of issues. Defaults to None (first page).

Jira.CreateIssue

Create a new Jira issue.

Parameters

• title (string, required) The title of the issue.
• issue_type (string, required) The name or ID of the issue type. If a name is provided, the tool will try to find a unique exact match among the available issue types.
• project (string, optional) The ID, key or name of the project to associate the issue with. If a name is provided, the tool will try to find a unique exact match among the available projects. Defaults to None (no project). If project and parent_issue are not provided, the tool will select the single project available. If the user has multiple, an error will be returned with the available projects to choose from.
• due_date (string, optional) The due date of the issue. Format: YYYY-MM-DD. Ex: ‘2025-01-01’. Defaults to None (no due date).
• description (string, optional) The description of the issue. Defaults to None (no description).
• environment (string, optional) The environment of the issue. Defaults to None (no environment).
• labels (array[string], optional) The labels of the issue. Defaults to None (no labels). A label cannot contain spaces. If a label is provided with spaces, they will be trimmed and replaced by underscores.
• parent_issue (string, optional) The ID or key of the parent issue. Defaults to None (no parent issue). Must provide at least one of parent_issue or project arguments.
• priority (string, optional) The ID or name of the priority to use for the issue. If a name is provided, the tool will try to find a unique exact match among the available priorities. Defaults to None (the issue is created with Jira’s default priority for the specified project).
• assignee (string, optional) The name, email or ID of the user to assign the issue to. If a name or email is provided, the tool will try to find a unique exact match among the available users. Defaults to None (no assignee).
• reporter (string, optional) The name, email or ID of the user who is the reporter of the issue. If a name or email is provided, the tool will try to find a unique exact match among the available users. Defaults to None (no reporter).

Jira.AddLabelsToIssue

Add labels to an existing Jira issue.

Parameters

• issue (string, required) The ID or key of the issue to update
• labels (array[string], required) The labels to add to the issue. A label cannot contain spaces. If a label is provided with spaces, they will be trimmed and replaced by underscores.
• notify_watchers (boolean, optional) Whether to notify the issue’s watchers. Defaults to True (notifies watchers).

Jira.RemoveLabelsFromIssue

Remove labels from an existing Jira issue.

Parameters

• issue (string, required) The ID or key of the issue to update
• labels (array[string], required) The labels to remove from the issue (case-insensitive)
• notify_watchers (boolean, optional) Whether to notify the issue’s watchers. Defaults to True (notifies watchers).

Jira.UpdateIssue

Update an existing Jira issue.

Parameters

• issue (string, required) The key or ID of the issue to update
• title (string, optional) The new issue title. Provide an empty string to clear the title. Defaults to None (does not change the title).
• description (string, optional) The new issue description. Provide an empty string to clear the description. Defaults to None (does not change the description).
• environment (string, optional) The new issue environment. Provide an empty string to clear the environment. Defaults to None (does not change the environment).
• due_date (string, optional) The new issue due date. Format: YYYY-MM-DD. Ex: ‘2025-01-01’. Provide an empty string to clear the due date. Defaults to None (does not change the due date).
• issue_type (string, optional) The new issue type name or ID. If a name is provided, the tool will try to find a unique exact match among the available issue types. Defaults to None (does not change the issue type).
• priority (string, optional) The name or ID of the new issue priority. If a name is provided, the tool will try to find a unique exact match among the available priorities. Defaults to None (does not change the priority).
• parent_issue (string, optional) The ID or key of the parent issue. A parent cannot be removed by providing an empty string. It is possible to change the parent issue by providing a new issue ID or key, or to leave it unchanged. Defaults to None (does not change the parent issue).
• assignee (string, optional) The new issue assignee name, email, or ID. If a name or email is provided, the tool will try to find a unique exact match among the available users. Provide an empty string to remove the assignee. Defaults to None (does not change the assignee).
• reporter (string, optional) The new issue reporter name, email, or ID. If a name or email is provided, the tool will try to find a unique exact match among the available users. Provide an empty string to remove the reporter. Defaults to None (does not change the reporter).
• labels (array[string], optional) The new issue labels. This argument will replace all labels with the new list. Providing an empty list will remove all labels. To add or remove a subset of labels, use the Jira.AddLabelsToIssue or the Jira.RemoveLabelsFromIssue tools. Defaults to None (does not change the labels). A label cannot contain spaces. If a label is provided with spaces, they will be trimmed and replaced by underscores.
• notify_watchers (boolean, optional) Whether to notify the issue’s watchers. Defaults to True (notifies watchers).

Jira.ListLabels

Get the existing labels (tags) in the user’s Jira instance.

Parameters

• limit (integer, optional) The maximum number of labels to return. Min of 1, Max of 200. Defaults to 200.
• offset (integer, optional) The number of labels to skip. Defaults to 0 (starts from the first label)

Jira.ListUsers

Browse users in Jira.

Parameters

• account_type (string, optional) The account type of the users to return. Defaults to ‘atlassian’. Provide None to disable filtering by account type. The account type filter will be applied after retrieving users from Jira API, thus the tool may return less users than the limit and still have more users to paginate. Check the pagination key in the response dictionary.
• limit (integer, optional) The maximum number of users to return. Min of 1, max of 50. Defaults to 50.
• offset (integer, optional) The number of users to skip before starting to return users. Defaults to 0 (start from the first user).

Jira.GetUserById

Get user information by their ID.

Parameters

• user_id (string, required) The the user’s ID.

Jira.GetUsersWithoutId

Get users without their account ID, searching by display name and email address.

Parameters

• name_or_email (string, required) The user’s display name or email address to search for (case-insensitive). The string can match the prefix of the user’s attribute. For example, a string of ‘john’ will match users with a display name or email address that starts with ‘john’, such as ‘John Doe’, ‘Johnson’, ‘john@example.com’, etc.
• enforce_exact_match (boolean, optional) Whether to enforce an exact match of the name_or_email against users’ display name and email attributes. Defaults to False (return all users that match the prefix). If set to True, before returning results, the tool will filter users with a display name OR email address that match exactly the value of the name_or_email argument.
• limit (integer, optional) The maximum number of users to return. Min of 1, max of 50. Defaults to 50.
• offset (integer, optional) The number of users to skip before starting to return users. Defaults to 0 (start from the first user).

Jira.AttachFileToIssue

Add an attachment to an issue.

Parameters

• issue (string, required) The issue ID or key to add the attachment to
• filename (string, required) The name of the file to add as an attachment. The filename should contain the file extension (e.g. ‘test.txt’, ‘report.pdf’), but it is not mandatory.
• file_content_str (string, optional) The string content of the file to attach. Use this if the file is a text file. Defaults to None.
• file_content_base64 (string, optional) The base64-encoded binary contents of the file. Use this for binary files like images or PDFs. Defaults to None.
• file_encoding (string, optional) The encoding of the file to attach. Only used with file_content_str. Defaults to ‘utf-8’.
• file_type (string, optional) The type of the file to attach. E.g. ‘application/pdf’, ‘text’, ‘image/png’. If not provided, the tool will try to infer the type from the filename. If the filename is not recognized, it will attach the file without specifying a type. Defaults to None (infer from filename or attach without type).

Jira.ListIssueAttachmentsMetadata

Get the metadata about the files attached to an issue.

Parameters

• issue (string, required) The ID or key of the issue to retrieve

Jira.GetAttachmentMetadata

Get the metadata of an attachment.

Parameters

• attachment_id (string, required) The ID of the attachment to retrieve

Jira.DownloadAttachment

Download the contents of an attachment associated with an issue.

Parameters

• attachment_id (string, required) The ID of the attachment to download

Jira.GetTransitionById

Get a transition by its ID.

Parameters

• issue (string, required) The ID or key of the issue
• transition_id (string, required) The ID of the transition

Jira.GetTransitionsAvailableForIssue

Get the transitions available for an existing Jira issue.

Parameters

• issue (string, required) The ID or key of the issue

Jira.GetTransitionByStatusName

Get a transition available for an issue by the transition name.

Parameters

• issue (string, required) The ID or key of the issue
• transition (string, required) The name of the transition status

Jira.TransitionIssueToNewStatus

Transition a Jira issue to a new status.

Parameters

• issue (string, required) The ID or key of the issue
• transition (string, required) The transition to perform. Provide the transition ID or its name (case insensitive).

Jira.ListProjects

Browse projects available in Jira.

Parameters

• limit (integer, optional) The maximum number of projects to return. Min of 1, Max of 50. Defaults to 50.
• offset (integer, optional) The number of projects to skip. Defaults to 0 (starts from the first project)

Jira.SearchProjects

Get the details of all Jira projects.

Parameters

• keywords (string, optional) The keywords to search for projects. Matches against project name and key (case insensitive). Defaults to None (no keywords filter).
• limit (integer, optional) The maximum number of projects to return. Min of 1, Max of 50. Defaults to 50.
• offset (integer, optional) The number of projects to skip. Defaults to 0 (starts from the first project)

Jira.GetProjectById

Get the details of a Jira project by its ID or key.

Parameters

• project (string, required) The ID or key of the project to retrieve

Jira.GetPriorityById

Get the details of a priority by its ID.

Parameters

• priority_id (string, required) The ID of the priority to retrieve.

Jira.ListPrioritySchemes

Browse the priority schemes available in Jira.

Parameters

• scheme_name (string, optional) Filter by scheme name. Defaults to None (returns all scheme names).
• limit (integer, optional) The maximum number of priority schemes to return. Min of 1, max of 50. Defaults to 50.
• offset (integer, optional) The number of priority schemes to skip. Defaults to 0 (start from the first scheme).
• order_by (Enum PrioritySchemeOrderBy, optional) The order in which to return the priority schemes. Defaults to name ascending.

Jira.ListPrioritiesAssociatedWithAPriorityScheme

Browse the priorities associated with a priority scheme.

Parameters

• scheme_id (string, required) The ID of the priority scheme to retrieve priorities for.
• limit (integer, optional) The maximum number of priority schemes to return. Min of 1, max of 50. Defaults to 50.
• offset (integer, optional) The number of priority schemes to skip. Defaults to 0 (start from the first scheme).

Jira.ListProjectsAssociatedWithAPriorityScheme

Browse the projects associated with a priority scheme.

Parameters

• scheme_id (string, required) The ID of the priority scheme to retrieve projects for.
• project (string, optional) Filter by project ID, key or name. Defaults to None (returns all projects).
• limit (integer, optional) The maximum number of projects to return. Min of 1, max of 50. Defaults to 50.
• offset (integer, optional) The number of projects to skip. Defaults to 0 (start from the first project).

Jira.ListPrioritiesAvailableToAProject

Browse the priorities available to be used in issues in the specified Jira project.

Parameters

• project (string, required) The ID, key or name of the project to retrieve priorities for.

Jira.ListPrioritiesAvailableToAnIssue

Browse the priorities available to be used in the specified Jira issue.

Parameters

• issue (string, required) The ID or key of the issue to retrieve priorities for.

Jira.GetCommentById

Get a comment by its ID.

Parameters

• issue_id (string, required) The ID or key of the issue to retrieve the comment from.
• comment_id (string, required) The ID of the comment to retrieve
• include_adf_content (boolean, optional) Whether to include the ADF (Atlassian Document Format) content of the comment in the response. Defaults to False (return only the HTML rendered content).

Jira.GetIssueComments

Get the comments of a Jira issue by its ID.

Parameters

• issue (string, required) The ID or key of the issue to retrieve
• limit (integer, optional) The maximum number of comments to retrieve. Min 1, max 100, default 100.
• offset (integer, optional) The number of comments to skip. Defaults to 0 (start from the first comment).
• order_by (Enum IssueCommentOrderBy, optional) The order in which to return the comments. Defaults to ‘created_date_descending’ (most recent first).
• include_adf_content (boolean, optional) Whether to include the ADF (Atlassian Document Format) content of the comment in the response. Defaults to False (return only the HTML rendered content).

Jira.AddCommentToIssue

Add a comment to a Jira issue.

Parameters

• issue (string, required) The ID or key of the issue to comment on.
• body (string, required) The body of the comment to add to the issue.
• reply_to_comment (string, optional) Quote a previous comment as a reply to it. Provide the comment’s ID. Must be a comment from the same issue. Defaults to None (no quoted comment).
• mention_users (array[string], optional) The users to mention in the comment. Provide the user display name, email address, or ID. Ex: ‘John Doe’ or ‘john.doe@example.com’. Defaults to None (no user mentions).

Auth

The Arcade Jira toolkit uses the Atlassian auth provider to connect to users’ Jira accounts. Please refer to the Atlassian auth provider documentation to learn how to configure auth.

pip install arcade_jira