Prerequisites
- Python 3.10 or higher
pip install praisonaiagents jira- Jira Cloud API token (generate here)
Quick Start
How It Works
Available Tools
| Function | Description |
|---|---|
jira_search(jql) | Search issues with JQL queries |
jira_create_task(project, summary, ...) | Create a new task |
jira_list_boards(board_type) | List all Kanban/Scrum boards |
jira_get_board_issues(board_id, jql) | Get issues on a board |
jira_get_transitions(issue_key) | Get available status transitions |
jira_move_issue(issue_key, status) | Move issue to a status (e.g., “In Progress”, “Done”) |
Common Patterns
Kanban Workflow Agent
An agent that manages the full Kanban lifecycle — creates tasks, moves them through stages, and verifies completion.Issue Search and Reporting
Multi-Agent Project Management
Configuration
Environment Variables
| Variable | Required | Description |
|---|---|---|
JIRA_URL | ✅ | Jira instance URL (e.g., https://your-domain.atlassian.net) |
JIRA_EMAIL | ✅ | Email associated with your Jira account |
JIRA_API_TOKEN | ✅ | API token from Atlassian API tokens |
Create Task Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
project | str | ✅ | Project key (e.g., "KAN") |
summary | str | ✅ | Task title |
description | str | ❌ | Task description |
issue_type | str | ❌ | Issue type (default: "Task") |
priority | str | ❌ | Priority level |
assignee | str | ❌ | Assignee username |
Best Practices
Give agents the project key and board ID
Give agents the project key and board ID
Include the project key and board ID directly in the agent’s instructions so it doesn’t need to guess:
Use JQL for precise searches
Use JQL for precise searches
JQL gives exact control over search results:
Chain transitions through get_transitions first
Chain transitions through get_transitions first
Always let the agent call
jira_get_transitions before jira_move_issue so it knows what transitions are available for the current status.Use gpt-4o-mini for cost efficiency
Use gpt-4o-mini for cost efficiency
Jira operations are straightforward tool calls.
gpt-4o-mini handles them well at lower cost.Watch & Monitor
Monitor issues and projects for changes over time. These tools live inpraisonaiagents.tools (not praisonai_tools board tools above).
Watch tools
| Tool | Description |
|---|---|
jira_watch_issue | Current issue state, or field/comment diff since since_timestamp |
jira_watch_project | Recent project activity, or new/updated issues since since_timestamp |
jira_get_issue_info | Status, priority, assignee, description, recent comments |
jira_search_issues | JQL search with human-readable summary (max_results default 20) |
jira_tools() | Returns all four tools as a list |
url (e.g. https://yourcompany.atlassian.net).
Auth
| Mode | Credentials | Env vars |
|---|---|---|
| Cloud (Atlassian.net) | email + token | JIRA_EMAIL, JIRA_API_TOKEN |
| Self-hosted Server | username + token | JIRA_USERNAME, JIRA_API_TOKEN |
Examples
Pass the JIRA URL in prompts
Pass the JIRA URL in prompts
All watch tools require
url. Include it in user prompts or hard-code it in agent instructions.Use since_timestamp for diffs
Use since_timestamp for diffs
Without
since_timestamp, watch tools return current state only — no change detection.Combine with schedule_tools
Combine with schedule_tools
Watch tools are one-shot polls. Pair with
schedule_add for interval monitoring.Project keys are validated
Project keys are validated
jira_watch_project accepts keys matching ^[A-Z][A-Z0-9_]*$ to prevent JQL injection.Related
Custom Tools
Create your own tools
Schedule Tools
Interval polling for JIRA watch agents
GitHub Tools
Branch, commit, and PR tools

