Skip to main content

Jira agent connector

Connector for Jira API

Example questions

The Jira connector is optimized to handle prompts like these.

  • Show me all open issues in the {project_key} project
  • What issues are assigned to {team_member} this week?
  • Find all high priority bugs in our current sprint
  • Get the details of issue {issue_key}
  • List all issues created in the last 7 days
  • Show me overdue issues across all projects
  • List all projects in my Jira instance
  • Get details of the {project_key} project
  • What projects have the most issues?
  • Who are all the users in my Jira instance?
  • Search for users named {user_name}
  • Get details of user {team_member}
  • Show me all comments on issue {issue_key}
  • How much time has been logged on issue {issue_key}?
  • List all worklogs for {issue_key} this month
  • Assign {issue_key} to {team_member}
  • Unassign {issue_key}
  • Create a new task in the {project_key} project called '{issue_title}'
  • Create a bug in {project_key} with high priority
  • Update the summary of {issue_key} to '{new_summary}'
  • Change the priority of {issue_key} to high
  • Add a comment to {issue_key} saying '{comment_text}'
  • Update my comment on {issue_key}
  • Delete the test issue {issue_key}
  • Remove my comment from {issue_key}

Unsupported questions

The Jira connector isn't currently able to handle prompts like these.

  • Log time on {issue_key}
  • Transition {issue_key} to Done

Installation

uv pip install airbyte-agent-jira

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_jira import JiraConnector
from airbyte_agent_jira.models import JiraAuthConfig

connector = JiraConnector(
auth_config=JiraAuthConfig(
username="<Your Atlassian account email address>",
password="<Your Jira API token from https://id.atlassian.com/manage-profile/security/api-tokens>"
)
)

@agent.tool_plain # assumes you're using Pydantic AI
@JiraConnector.tool_utils
async def jira_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_jira import JiraConnector

connector = JiraConnector(
external_user_id="<your-scoped-token>",
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)

@agent.tool_plain # assumes you're using Pydantic AI
@JiraConnector.tool_utils
async def jira_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

Full documentation

This connector supports the following entities and actions.

EntityActions
IssuesApi_search, Create, Get, Update, Delete
ProjectsApi_search, Get
UsersGet, List, Api_search
Issue FieldsList, Api_search
Issue CommentsList, Create, Get, Update, Delete
Issue WorklogsList, Get
Issues AssigneeUpdate

For all authentication options, see the connector's authentication documentation.

For detailed documentation on available actions and parameters, see this connector's full reference documentation.

For the service's official API docs, see the Jira API reference.

Version information

  • Package version: 0.1.52
  • Connector version: 1.1.2
  • Generated with Connector SDK commit SHA: 609c1d86c76b36ff699b57123a5a8c2050d958c3