Productivity

Jira

Learn how to use Jira with Composio

Overview

SLUG: JIRA

Description

A tool for bug tracking, issue tracking, and agile project management.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to read:jira-work,write:jira-work,manage:jira-project,manage:jira-configuration,read:jira-user,manage:jira-webhook,manage:jira-data-provider,read:servicedesk-request,manage:servicedesk-customer,write:servicedesk-request,read:servicemanagement-insight-objects,offline_access,read:sprint:jira-software,write:sprint:jira-software,read:board-scope:jira-software,write:board-scope:jira-software,read:project:jira,read:issue-type-scheme:jira
subdomain
stringRequired
subdomain
stringRequired
basic_encoded
string
generic_api_key
string
generic_id
string

Connecting to Jira

Create an auth config

Use the dashboard to create an auth config for the Jira toolkit. This allows you to connect multiple Jira accounts to Composio for agents to use.

1

Select App

Navigate to Jira.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Jira Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4jira_auth_config_id = "ac_YOUR_JIRA_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11    connection_request = composio.connected_accounts.initiate(
12        user_id=user_id,
13        auth_config_id=auth_config_id,
14    )
15
16    print(
17        f"Visit this URL to authenticate Jira: {connection_request.redirect_url}"
18    )
19
20    # This will wait for the auth flow to be completed
21    connection_request.wait_for_connection(timeout=15)
22    return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, jira_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4jira_auth_config_id = "ac_YOUR_JIRA_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Jira for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, jira_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Jira toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Add Attachment

Description

Uploads and attaches a file to a Jira issue.

Action Parameters

file_to_upload
objectRequired
issue_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Comment

Description

Adds a comment using Atlassian Document Format (ADF) for rich text to an existing Jira issue.

Action Parameters

comment
stringRequired
issue_id_or_key
stringRequired
visibility_type
visibility_value

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Users to Project Role

Description

Adds users and optionally groups to a project role.

Action Parameters

group_names
project_id_or_key
stringRequired
role_id
integerRequired
user_account_ids
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add User to Group

Description

Adds a user to a Jira group.

Action Parameters

account_id
stringRequired
group_id
group_name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Watcher to Issue

Description

Adds a user to an issue's watcher list by account ID.

Action Parameters

account_id
stringRequired
issue_id_or_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Assign Issue

Description

Assigns a Jira issue to a user, default assignee, or unassigns; supports email/name lookup.

Action Parameters

account_id
assignee_name
issue_id_or_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Bulk Create Issues

Description

Creates multiple Jira issues (up to 50 per call) with full feature support including markdown, assignee resolution, and priority handling.

Action Parameters

issues
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Group

Description

Creates a new group in Jira with the specified name.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Issue

Description

Creates a new Jira issue (e.g., bug, task, story) in a specified project.

Action Parameters

assignee
assignee_name
components
description
due_date
environment
fix_versions
issue_type
stringDefaults to Task
labels
priority
project_key
stringRequired
reporter
sprint_id
summary
stringRequired
versions

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Project

Description

Creates a new Jira project with required lead, template, and type configuration.

Action Parameters

assignee_type
avatar_id
category_id
description
issue_security_scheme
key
stringRequired
lead_account_id
stringRequired
name
stringRequired
notification_scheme
permission_scheme
project_template_key
stringRequired
project_type_key
stringRequired
url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Sprint

Description

Creates a new sprint on a Jira board with optional start/end dates and goal.

Action Parameters

end_date
goal
name
stringRequired
origin_board_id
integerRequired
start_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Version

Description

Creates a new version for releases or milestones in a Jira project.

Action Parameters

archived
description
name
stringRequired
projectId
integerRequired
releaseDate
released
startDate

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Comment

Description

Deletes a specific comment from a Jira issue using its ID and the issue's ID/key; requires user permission to delete comments on the issue.

Action Parameters

id
stringRequired
issueIdOrKey
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Issue

Description

Deletes a Jira issue by its ID or key.

Action Parameters

delete_subtasks
issue_id_or_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Version

Description

Deletes a Jira version and optionally reassigns its issues.

Action Parameters

move_affected_issues_to
move_fix_issues_to
version_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Worklog

Description

Deletes a worklog from a Jira issue with estimate adjustment options.

Action Parameters

adjust_estimate
Defaults to auto
increase_by
issue_id_or_key
stringRequired
new_estimate
notify_users
Defaults to True
override_editable_flag
worklog_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Edit Issue

Description

Updates an existing Jira issue with field values and operations. Supports direct field parameters (summary, description, assignee, priority, etc.) that are merged with the fields parameter. Direct parameters take precedence.

Action Parameters

assignee
description
due_date
fields
issue_id_or_key
stringRequired
labels
notify_users
booleanDefaults to True
override_editable_flag
boolean
override_screen_security
boolean
priority_id_or_name
return_issue
boolean
sprint_id_or_name
summary
update

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Find Users

Description

Searches for Jira users by email or display name to find account IDs; essential for assigning issues, adding watchers, and other user-related operations.

Action Parameters

account_id
active
max_results
query
start_at

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Groups

Description

Retrieves all groups from the Jira instance with pagination support.

Action Parameters

max_results
start_at

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Issue Type Schemes

Description

Retrieves all Jira issue type schemes with optional filtering and pagination.

Action Parameters

id
max_results
start_at

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all projects

Description

Retrieves all visible projects using the modern paginated Jira API with server-side filtering and pagination support.

Action Parameters

action
Defaults to view
categoryId
expand
maxResults
Defaults to 50
name
orderBy
Defaults to name
properties
query
startAt
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Issue Statuses

Description

Retrieves all available issue statuses from Jira with details.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Users

Description

Retrieves all users from the Jira instance including active, inactive, and other user states with pagination support.

Action Parameters

max_results
start_at

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Attachment

Description

Retrieves the binary content of a Jira attachment by ID. Use when you need to download a specific file attached to an issue.

Action Parameters

attachment_id
stringRequired
file_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Comment

Description

Retrieves a specific comment by ID from a Jira issue with optional expansions.

Action Parameters

comment_id
stringRequired
expand
issue_id_or_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Current User

Description

Retrieves detailed information about the currently authenticated Jira user.

Action Parameters

expand

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get custom fields paginated

Description

Tool to retrieve Jira fields in pages. Use when you need to filter or page through custom and system fields.

Action Parameters

expand
id
maxResults
integerDefaults to 50
orderBy
projectIds
query
startAt
integer
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get fields

Description

Tool to retrieve Jira issue fields metadata. Use before editing an issue to discover custom field IDs and names.

Action Parameters

custom_only
boolean
issue_type
projectId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Filter

Description

Retrieves a specific Jira saved filter by ID, including its JQL and sharing metadata, to reuse in subsequent searches. Use when you need to fetch filter details or extract the JQL query to run searches.

Action Parameters

expand
id
stringRequired
overrideSharePermissions

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Group

Description

Retrieves details of a specific Jira group by name or ID.

Action Parameters

expand
group_id
group_name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Issue

Description

Retrieves a Jira issue by ID or key with customizable fields and expansions.

Action Parameters

expand
fields
fields_by_keys
issue_key
stringRequired
properties
update_history

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Issue Edit Meta

Description

Tool to retrieve editable fields for a Jira issue. Use before running an edit action to fetch custom field metadata and required fields.

Action Parameters

issue_id_or_key
stringRequired
override_editable_flag
override_screen_security

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Issue Property

Description

Retrieves a custom property from a Jira issue by key.

Action Parameters

issue_id_or_key
stringRequired
property_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Issue Resolutions

Description

Retrieves all available issue resolution types from Jira.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get issue types

Description

Retrieves all Jira issue types available to the user using the modern API v3 endpoint; results vary based on 'Administer Jira' global or 'Browse projects' project permissions.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Issue Type Scheme

Description

Gets a Jira issue type scheme by ID with all associated issue types.

Action Parameters

issue_type_scheme_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Issue Watchers

Description

Retrieves users watching a Jira issue for update notifications.

Action Parameters

issue_id_or_key
stringRequired
max_results
start_at

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Issue Worklogs

Description

DEPRECATED: Use 'Get Worklogs' action instead. This action is deprecated because it lacks the expand parameter for worklog properties. Use JIRA_GET_WORKLOG which provides the same functionality plus the ability to expand worklog properties using the 'expand' parameter. Legacy description: Retrieves worklogs for a Jira issue with user permission checks.

Action Parameters

issue_id_or_key
stringRequired
max_results
start_at
started_after
started_before

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Project

Description

Retrieves details of a Jira project by its ID or key.

Action Parameters

expand
project_id_or_key
stringRequired
properties

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Project Roles

Description

Retrieves all available roles for a Jira project.

Action Parameters

project_id_or_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Project Versions

Description

Retrieves all versions for a Jira project with optional expansion.

Action Parameters

expand
project_id_or_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Service Desk Request Type Fields

Description

Tool to retrieve JSM request type field metadata for filling out portal requests. Use when you need to know which fields are required and their valid values.

Action Parameters

requestTypeId
stringRequired
serviceDeskId
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Transitions

Description

Retrieves available workflow transitions for a Jira issue.

Action Parameters

expand
include_unavailable_transitions
issue_id_or_key
stringRequired
skip_remote_only_condition
sort_by_ops_bar_and_status
transition_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Issue Votes

Description

Fetches voting details for a Jira issue; requires voting to be enabled in Jira's general settings.

Action Parameters

issue_id_or_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Worklogs

Description

Retrieves worklogs for a specified Jira issue.

Action Parameters

expand
issue_id_or_key
stringRequired
max_results
start_at
started_after
started_before

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Boards

Description

Retrieves paginated Jira boards with filtering and sorting options.

Action Parameters

includePrivate
max_results
name
orderBy
projectKeyOrId
start_at
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Jira Filters

Description

Tool to search and list Jira saved filters (saved searches) visible to the current user. Use when you need to discover existing filters, find filters by name or owner, or get filter details including JQL queries and sharing permissions.

Action Parameters

accountId
expand
filterName
groupId
groupname
id
maxResults
Defaults to 50
orderBy
owner
projectId
startAt

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Issue Comments

Description

Retrieves paginated comments from a Jira issue with optional ordering.

Action Parameters

expand
issue_id_or_key
stringRequired
max_results
Defaults to 50
order_by
start_at

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Sprints

Description

Retrieves paginated sprints from a Jira board with optional state filtering.

Action Parameters

board_id
integerRequired
max_results
integerDefaults to 50
start_at
integer
state

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Move Issues to Sprint

Description

Moves one or more Jira issues to a specified active sprint.

Action Parameters

issues
arrayRequired
sprint_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove User from Group

Description

Removes a user from a Jira group.

Action Parameters

account_id
stringRequired
group_id
group_name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove User from Project Role

Description

Removes a user or group from a project role.

Action Parameters

group_name
project_id_or_key
stringRequired
role_id
integerRequired
user_account_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Remove Watcher from Issue

Description

Removes a user from an issue's watcher list by account ID.

Action Parameters

account_id
stringRequired
issue_id_or_key
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Issues Using JQL (GET)

Description

Searches for Jira issues using JQL with pagination and field selection.

Action Parameters

expand
fail_fast
fields
fields_by_keys
jql
max_results
Defaults to 50
next_page_token
properties
reconcile_issues

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Issues Using JQL Enhanced (POST)

Description

Searches for Jira issues using Enhanced JQL via POST request; supports eventual consistency and token-based pagination.

Action Parameters

expand
fields
fields_by_keys
jql
max_results
nextPageToken
properties
reconcileIssues

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search issues

Description

Advanced Jira issue search supporting structured filters and raw JQL.

Action Parameters

assignee
created_after
created_before
fields
issue_type_id_or_name
jql
labels
max_results
Defaults to 20
next_page_token
preserved_order_by
priority_id_or_name
project_key
sprint_id_or_name
status_id_or_name
text_search
updated_after
updated_before

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Send Notification for Issue

Description

Sends a customized email notification for a Jira issue.

Action Parameters

html_body
issue_id_or_key
stringRequired
restrict
subject
stringRequired
text_body
stringRequired
to
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Transition Issue

Description

Transitions a Jira issue to a different workflow state, with support for transition name lookup and user assignment by email.

Action Parameters

additional_fields
assignee
assignee_name
comment
duedate
issue_id_or_key
stringRequired
resolution
transition_id_or_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Comment

Description

Updates text content or visibility of an existing Jira comment.

Action Parameters

comment_id
stringRequired
comment_text
stringRequired
issue_id_or_key
stringRequired
notify_users
Defaults to True
visibility_type
visibility_value

Action Response

data
objectRequired
error
successful
booleanRequired