Jira

JiraTools enable an Agent to perform Jira tasks.

Prerequisites

The following example requires the jira library and auth credentials.

pip install -U jira

export JIRA_SERVER_URL="YOUR_JIRA_SERVER_URL"
export JIRA_USERNAME="YOUR_USERNAME"
export JIRA_API_TOKEN="YOUR_API_TOKEN"

Example

The following agent will use Jira API to search for issues in a project.

cookbook/tools/jira_tools.py

from phi.agent import Agent
from phi.tools.jira_tools import JiraTools

agent = Agent(tools=[JiraTools()])
agent.print_response("Find all issues in project PROJ", markdown=True)

Toolkit Params

Parameter	Type	Default	Description
`server_url`	`str`	`""`	The URL of the JIRA server, retrieved from the environment variable `JIRA_SERVER_URL`. Default is an empty string if not set.
`username`	`str`	`None`	The JIRA username for authentication, retrieved from the environment variable `JIRA_USERNAME`. Default is None if not set.
`password`	`str`	`None`	The JIRA password for authentication, retrieved from the environment variable `JIRA_PASSWORD`. Default is None if not set.
`token`	`str`	`None`	The JIRA API token for authentication, retrieved from the environment variable `JIRA_TOKEN`. Default is None if not set.

Toolkit Functions

Function	Description
`get_issue`	Retrieves issue details from JIRA. Parameters include: - `issue_key`: the key of the issue to retrieve Returns a JSON string containing issue details or an error message.
`create_issue`	Creates a new issue in JIRA. Parameters include: - `project_key`: the project in which to create the issue - `summary`: the issue summary - `description`: the issue description - `issuetype`: the type of issue (default is “Task”) Returns a JSON string with the new issue’s key and URL or an error message.
`search_issues`	Searches for issues using a JQL query in JIRA. Parameters include: - `jql_str`: the JQL query string - `max_results`: the maximum number of results to return (default is 50) Returns a JSON string containing a list of dictionaries with issue details or an error message.
`add_comment`	Adds a comment to an issue in JIRA. Parameters include: - `issue_key`: the key of the issue - `comment`: the comment text Returns a JSON string indicating success or an error message.

Information

View on Github

Getting Started

Documentation

How To

Prerequisites

Example

Toolkit Params

Toolkit Functions

Information

​Prerequisites

​Example

​Toolkit Params

​Toolkit Functions

​Information

Prerequisites

Example

Toolkit Params

Toolkit Functions

Information