> ## Documentation Index
> Fetch the complete documentation index at: https://ikun.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Jira

**JiraTools** 支持 Agent 执行 Jira 任务。

## 先决条件

以下示例需要 `jira` 库和身份验证凭据。

```shell theme={null}
pip install -U jira
```

```shell theme={null}
export JIRA_SERVER_URL="YOUR_JIRA_SERVER_URL"
export JIRA_USERNAME="YOUR_USERNAME"
export JIRA_TOKEN="YOUR_API_TOKEN"
```

## 示例

以下 Agent 将使用 Jira API 在项目中搜索问题。

```python cookbook/tools/jira_tools.py theme={null}
from agno.agent import Agent
from agno.tools.jira import JiraTools

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

## Toolkit 参数

| 参数           | 类型    | 默认值    | 描述                                                          |
| ------------ | ----- | ------ | ----------------------------------------------------------- |
| `server_url` | `str` | `""`   | JIRA 服务器的 URL，从环境变量 `JIRA_SERVER_URL` 中检索。如果未设置，则默认为空字符串。   |
| `username`   | `str` | `None` | 用于身份验证的 JIRA 用户名，从环境变量 `JIRA_USERNAME` 中检索。如果未设置，则默认为 None。 |
| `password`   | `str` | `None` | 用于身份验证的 JIRA 密码，从环境变量 `JIRA_PASSWORD` 中检索。如果未设置，则默认为 None。  |
| `token`      | `str` | `None` | 用于身份验证的 JIRA API 令牌，从环境变量 `JIRA_TOKEN` 中检索。如果未设置，则默认为 None。 |

## Toolkit 函数

| 函数              | 描述                                                                                                                                                                           |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `get_issue`     | 从 JIRA 检索问题详情。参数包括：<br />- `issue_key`: 要检索的问题的键<br />返回包含问题详情的 JSON 字符串或错误消息。                                                                                               |
| `create_issue`  | 在 JIRA 中创建新问题。参数包括：<br />- `project_key`: 要创建问题的项目<br />- `summary`: 问题摘要<br />- `description`: 问题描述<br />- `issuetype`: 问题类型（默认为“Task”）<br />返回包含新问题键和 URL 的 JSON 字符串或错误消息。 |
| `search_issues` | 使用 JIRA 中的 JQL 查询搜索问题。参数包括：<br />- `jql_str`: JQL 查询字符串<br />- `max_results`: 要返回的最大结果数（默认为 50）<br />返回包含问题详情字典列表的 JSON 字符串或错误消息。                                            |
| `add_comment`   | 向 JIRA 中的问题添加评论。参数包括：<br />- `issue_key`: 问题的键<br />- `comment`: 评论文本<br />返回指示成功或错误消息的 JSON 字符串。                                                                            |

## 开发者资源

* 查看 [Tools](https://github.com/agno-agi/agno/blob/main/libs/agno/agno/tools/jira.py)
* 查看 [Cookbook](https://github.com/agno-agi/agno/blob/main/cookbook/tools/jira_tools.py)