Source code for langchain_community.tools.jira.tool

"""
这个工具允许代理与atlassian-python-api库进行交互，并在Jira实例上操作。有关atlassian-python-api库的更多信息，请参阅https://atlassian-python-api.readthedocs.io/jira.html

要使用这个工具，你必须首先设置环境变量：
    JIRA_API_TOKEN
    JIRA_USERNAME
    JIRA_INSTANCE_URL

下面是一个使用Jira工具的示例脚本：

```python
from langchain_community.agent_toolkits.jira.toolkit import JiraToolkit
from langchain_community.utilities.jira import JiraAPIWrapper

jira = JiraAPIWrapper()
toolkit = JiraToolkit.from_jira_api_wrapper(jira)
```
"""
from typing import Optional

from langchain_core.callbacks import CallbackManagerForToolRun
from langchain_core.pydantic_v1 import Field
from langchain_core.tools import BaseTool

from langchain_community.utilities.jira import JiraAPIWrapper


class JiraAction(BaseTool):
    """用于查询Atlassian Jira API的工具。"""

    api_wrapper: JiraAPIWrapper = Field(default_factory=JiraAPIWrapper)  # type: ignore[arg-type]
    mode: str
    name: str = ""
    description: str = ""

    def _run(
        self,
        instructions: str,
        run_manager: Optional[CallbackManagerForToolRun] = None,
    ) -> str:
        """使用Atlassian Jira API来运行一个操作。"""
        return self.api_wrapper.run(self.mode, instructions)