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
bearer_token
string
subdomain
stringRequired
basic_encoded
stringRequired

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 the Jira toolkit page and click “Setup Integration”.

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

Using API Key

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

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["JIRA"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add Attachment

Description

Uploads and attaches a file to a jira issue.

Action Parameters

file_content
stringRequired
file_name
stringRequired
issue_key
stringRequired

Action Response

data
objectRequired
error
string
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
string
visibility_value
string

Action Response

data
objectRequired
error
string
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
string
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
string
assignee_name
string
issue_id_or_key
stringRequired

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Create Issue

Description

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

Action Parameters

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

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Project

Description

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

Action Parameters

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

Action Response

data
objectRequired
error
string
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
string
goal
string
name
stringRequired
origin_board_id
integerRequired
start_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Version

Description

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

Action Parameters

archived
boolean
description
string
name
stringRequired
projectId
integerRequired
releaseDate
string
released
boolean
startDate
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Issue

Description

Deletes a jira issue by its id or key.

Action Parameters

delete_subtasks
boolean
issue_id_or_key
stringRequired

Action Response

data
objectRequired
error
string
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
string
description
string
due_date
string
fields
object
issue_id_or_key
stringRequired
labels
array
notify_users
booleanDefaults to True
override_editable_flag
boolean
override_screen_security
boolean
priority_id_or_name
string
return_issue
boolean
sprint_id_or_name
string
summary
string
update
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Find Users

Description

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

Action Parameters

account_id
string
include_active
booleanDefaults to True
include_inactive
boolean
max_results
integer
query
string
start_at
integer
username
string

Action Response

data
objectRequired
error
string
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
stringDefaults to view
categoryId
integer
expand
string
maxResults
integerDefaults to 50
name
string
orderBy
stringDefaults to name
properties
array
query
string
startAt
integer
status
array

Action Response

data
objectRequired
error
string
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
integer
start_at
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Current User

Description

Retrieves detailed information about the currently authenticated jira user.

Action Parameters

expand
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Issue

Description

Retrieves a jira issue by id or key with customizable fields and expansions.

Action Parameters

expand
string
fields
array
fields_by_keys
boolean
issue_id_or_key
stringRequired
properties
array
update_history
boolean

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Get Transitions

Description

Retrieves available workflow transitions for a jira issue.

Action Parameters

expand
string
include_unavailable_transitions
boolean
issue_id_or_key
stringRequired
skip_remote_only_condition
boolean
sort_by_ops_bar_and_status
boolean
transition_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Boards

Description

Retrieves paginated jira boards with filtering and sorting options.

Action Parameters

includePrivate
boolean
max_results
integer
name
string
orderBy
string
projectKeyOrId
string
start_at
integer
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Issue Comments

Description

Retrieves paginated comments from a jira issue with optional ordering.

Action Parameters

expand
string
issue_id_or_key
stringRequired
max_results
integerDefaults to 50
order_by
string
start_at
integer

Action Response

data
objectRequired
error
string
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
string

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Search Issues Using JQL (GET)

Description

Searches for jira issues using jql with pagination and field selection.

Action Parameters

expand
string
fields
array
fields_by_keys
boolean
jql
stringRequired
max_results
integerDefaults to 50
properties
array
start_at
integer
validate_query
stringDefaults to strict

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search Issues Using JQL (POST)

Description

Searches for jira issues using jql via post request for complex queries; ideal for lengthy jql queries that might exceed url character limits

Action Parameters

expand
string
fields
array
fields_by_keys
boolean
jql
stringRequired
max_results
integerDefaults to 50
properties
array
start_at
integer
validate_query
stringDefaults to strict

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search issues

Description

Advanced jira issue search supporting structured filters and raw jql.

Action Parameters

assignee
string
created_after
string
created_before
string
issue_type_id_or_name
string
jql
string
labels
array
max_results
integerDefaults to 20
priority_id_or_name
string
project_key
string
sprint_id_or_name
string
start_at
integer
status_id_or_name
string
text_search
string
updated_after
string
updated_before
string

Action Response

data
objectRequired
error
string
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

assignee
string
assignee_name
string
comment
string
issue_id_or_key
stringRequired
resolution
string
transition_id_or_name
stringRequired

Action Response

data
objectRequired
error
string
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
booleanDefaults to True
visibility_type
string
visibility_value
string

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Delete Version

Description

Deletes a jira version and optionally reassigns its issues.

Action Parameters

move_affected_issues_to
string
move_fix_issues_to
string
version_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Worklog

Description

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

Action Parameters

adjust_estimate
stringDefaults to auto
increase_by
string
issue_id_or_key
stringRequired
new_estimate
string
notify_users
booleanDefaults to True
override_editable_flag
boolean
worklog_id
stringRequired

Action Response

data
objectRequired
error
string
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
string
issue_id_or_key
stringRequired

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Get Issue Resolutions

Description

Retrieves all available issue resolution types from jira.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Issue Statuses

Description

Retrieves all available issue statuses from jira with details.

Action Parameters

Action Response

data
objectRequired
error
string
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
string
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
string
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
integer
start_at
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Issue Worklogs

Description

Retrieves worklogs for a jira issue with user permission checks.

Action Parameters

issue_id_or_key
stringRequired
max_results
integer
start_at
integer
started_after
integer
started_before
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project Versions

Description

Retrieves all versions for a jira project with optional expansion.

Action Parameters

expand
string
project_id_or_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Worklogs

Description

Retrieves worklogs for a specified jira issue.

Action Parameters

expand
string
issue_id_or_key
stringRequired
max_results
integer
start_at
integer
started_after
integer
started_before
integer

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Send Notification for Issue

Description

Sends a customized email notification for a jira issue.

Action Parameters

html_body
string
issue_id_or_key
stringRequired
restrict
object
subject
stringRequired
text_body
stringRequired
to
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired