Jira
SDK reference for jira operations
Overview
Jira project management and issue tracking
- Category:
project - Auth Required: Yes
- Supported Modes: standard, delegated
Operations
createIssue
Create a new Jira issue
Arguments:
projectKey(string, required): Jira project key (e.g., "PROJ")summary(string, required): Issue summary/titledescription(string, optional): Issue descriptionissueType(string, optional): Issue type (Task, Bug, Story, etc.)
Returns:
AdapterOperationResult - Created issue information
Response Fields:
| Field | Type | Description |
|---|---|---|
issueKey | string | Created issue key |
issueId | string | Created issue ID |
summary | string | Issue summary |
Example:
searchIssues
Search Jira issues using JQL. Returns normalized flat issue summaries.
Arguments:
jql(string, required): JQL query stringmaxResults(number, optional): Maximum number of results (default: 50, max: 100)
Returns:
AdapterOperationResult - Returns { jql, count, issues[] }. Each issue has FLAT fields: id, key, summary, status, statusId, issueType, issueTypeId, priority, priorityId, assignee, assigneeAccountId, projectKey, projectName, labels[], created, updated, isAssigned. No nested objects.
Response Fields:
| Field | Type | Description |
|---|---|---|
jql | string | JQL query used |
count | number | Number of results |
issues | JiraIssueSummary[] | List of matching issues |
issues item fields (JiraIssueSummary)
| Field | Type | Description |
|---|---|---|
id | string | Unique issue ID |
key | string | Issue key (e.g., PROJ-123) |
summary | string | Issue summary/title |
status | string | Status name |
statusId | string | Status ID |
issueType | string | Issue type name |
issueTypeId | string | Issue type ID |
priority | string | Priority name |
priorityId | string | Priority ID |
assignee | string | Assignee display name |
assigneeAccountId | string | Assignee account ID |
projectKey | string | Project key |
projectName | string | Project name |
labels | string[] | Issue labels |
created | string | Created timestamp (ISO 8601) |
updated | string | Updated timestamp (ISO 8601) |
isAssigned | boolean | Whether issue has an assignee |
Example:
getIssue
Get a specific Jira issue by key or ID. Returns normalized flat structure.
Arguments:
issueKey(string, required): Issue key (e.g., "PROJ-123") or ID
Returns:
AdapterOperationResult - Returns FLAT structure with: id, key, summary, description, status, statusId, issueType, issueTypeId, priority, priorityId, assignee, assigneeAccountId, reporter, reporterAccountId, projectKey, projectName, projectId, labels[], created, updated, isAssigned, hasLabels. No nested objects.
Response Fields:
| Field | Type | Description |
|---|---|---|
id | string | Unique issue ID |
key | string | Issue key (e.g., PROJ-123) |
summary | string | Issue summary/title |
description | string | Issue description (extracted from ADF) |
status | string | Status name |
statusId | string | Status ID |
issueType | string | Issue type name |
issueTypeId | string | Issue type ID |
priority | string | Priority name |
priorityId | string | Priority ID |
assignee | string | Assignee display name |
assigneeAccountId | string | Assignee account ID |
reporter | string | Reporter display name |
reporterAccountId | string | Reporter account ID |
projectKey | string | Project key |
projectName | string | Project name |
projectId | string | Project ID |
labels | string[] | Issue labels |
created | string | Created timestamp (ISO 8601) |
updated | string | Updated timestamp (ISO 8601) |
isAssigned | boolean | Whether issue has an assignee |
hasLabels | boolean | Whether issue has labels |
Example:
updateIssue
Update an existing Jira issue
Arguments:
issueKey(string, required): Issue key (e.g., "PROJ-123")summary(string, optional): New issue summary/titledescription(string, optional): New issue description
Returns:
AdapterOperationResult - Updated issue information
Response Fields:
| Field | Type | Description |
|---|---|---|
issueKey | string | Updated issue key |
updated | boolean | Whether update succeeded |
Example:
deleteIssue
Delete a Jira issue
Arguments:
issueKey(string, required): Issue key (e.g., "PROJ-123")
Returns:
AdapterOperationResult - Deletion confirmation
Response Fields:
| Field | Type | Description |
|---|---|---|
issueKey | string | Deleted issue key |
deleted | boolean | Whether deletion succeeded |
Example:
addComment
Add a comment to a Jira issue
Arguments:
issueKey(string, required): Issue key (e.g., "PROJ-123")comment(string, required): Comment text
Returns:
AdapterOperationResult - Created comment information
Response Fields:
| Field | Type | Description |
|---|---|---|
issueKey | string | Issue key |
commentId | string | Created comment ID |
added | boolean | Whether comment was added |
Example:
transitionIssue
Transition a Jira issue to a different status
Arguments:
issueKey(string, required): Issue key (e.g., "PROJ-123")transitionId(string, required): ID of the transition to perform
Returns:
AdapterOperationResult - Transition result
Response Fields:
| Field | Type | Description |
|---|---|---|
issueKey | string | Issue key |
transitioned | boolean | Whether transition succeeded |
transitionId | string | Transition ID used |
Example:
assignIssue
Assign a Jira issue to a user
Arguments:
issueKey(string, required): Issue key (e.g., "PROJ-123")accountId(string, required): Atlassian account ID of the assignee
Returns:
AdapterOperationResult - Assignment result
Response Fields:
| Field | Type | Description |
|---|---|---|
issueKey | string | Issue key |
accountId | string | Assigned user account ID |
assigned | boolean | Whether assignment succeeded |
Example:
getProjects
Get all accessible Jira projects. Returns normalized flat project structures.
Returns:
AdapterOperationResult - Returns { count, projects[] }. Each project has FLAT fields: id, key, name, projectTypeKey, leadName, leadAccountId. No nested objects.
Response Fields:
| Field | Type | Description |
|---|---|---|
count | number | Number of projects |
projects | JiraProject[] | List of projects |
projects item fields (JiraProject)
| Field | Type | Description |
|---|---|---|
id | string | Project ID |
key | string | Project key |
name | string | Project name |
projectTypeKey | string | Project type key |
leadName | string | Project lead name |
leadAccountId | string | Project lead account ID |
Example:
listProjects
List all accessible Jira projects (alias for getProjects). Returns normalized flat structures.
Returns:
AdapterOperationResult - Returns { count, projects[] }. Each project has FLAT fields: id, key, name, projectTypeKey, leadName, leadAccountId. No nested objects.
Response Fields:
| Field | Type | Description |
|---|---|---|
count | number | Number of projects |
projects | JiraProject[] | List of projects |
projects item fields (JiraProject)
| Field | Type | Description |
|---|---|---|
id | string | Project ID |
key | string | Project key |
name | string | Project name |
projectTypeKey | string | Project type key |
leadName | string | Project lead name |
leadAccountId | string | Project lead account ID |
Example:
getProjectMetadata
Get metadata for a specific Jira project. Returns normalized flat structures.
Arguments:
projectKey(string, required): Project key (e.g., "PROJ")
Returns:
AdapterOperationResult - Returns { projectKey, projectName, issueTypeCount, issueTypes[], priorityCount, priorities[] }. Each issueType has FLAT fields: id, name, description, isSubtask. Each priority has: id, name, description.
Response Fields:
| Field | Type | Description |
|---|---|---|
projectKey | string | Project key |
projectName | string | Project name |
issueTypeCount | number | Number of issue types |
issueTypes | JiraIssueType[] | Available issue types |
issueTypes item fields (JiraIssueType)
| Field | Type | Description |
|---|---|---|
id | string | Issue type ID |
name | string | Issue type name |
description | string | Issue type description |
isSubtask | boolean | Whether this is a subtask type |
| priorityCount | number | Number of priorities |
| priorities | JiraPriority[] | Available priorities |
priorities item fields (JiraPriority)
| Field | Type | Description |
|---|---|---|
id | string | Priority ID |
name | string | Priority name |
description | string | Priority description |
Example:
getTransitions
Get available transitions for a Jira issue. Returns normalized flat structures.
Arguments:
issueKey(string, required): Issue key (e.g., "PROJ-123")
Returns:
AdapterOperationResult - Returns { issueKey, count, transitions[] }. Each transition has FLAT fields: id, name, toStatus, toStatusId. No nested objects.
Response Fields:
| Field | Type | Description |
|---|---|---|
issueKey | string | Issue key |
count | number | Number of transitions |
transitions | JiraTransition[] | Available transitions |
transitions item fields (JiraTransition)
| Field | Type | Description |
|---|---|---|
id | string | Transition ID |
name | string | Transition name |
toStatus | string | Target status name |
toStatusId | string | Target status ID |
Example:
listAssignableUsers
List users that can be assigned to issues in a project
Arguments:
projectKey(string, required): Project key (e.g., "PROJ")
Returns:
AdapterOperationResult - Returns { projectKey, count, users[] }. Each user has: accountId, displayName, emailAddress, active.
Response Fields:
| Field | Type | Description |
|---|---|---|
projectKey | string | Project key |
count | number | Number of users |
users | JiraUser[] | Assignable users |
users item fields (JiraUser)
| Field | Type | Description |
|---|---|---|
accountId | string | User account ID |
displayName | string | User display name |
emailAddress | string | User email address (optional) |
active | boolean | Whether user is active |
Example:
getIssueTypes
Get available issue types for a project. Returns normalized flat structures.
Arguments:
projectKey(string, required): Project key (e.g., "PROJ")
Returns:
AdapterOperationResult - Returns { projectKey, count, issueTypes[] }. Each issueType has FLAT fields: id, name, description, isSubtask. No nested objects.
Response Fields:
| Field | Type | Description |
|---|---|---|
projectKey | string | Project key |
count | number | Number of issue types |
issueTypes | JiraIssueType[] | Available issue types |
issueTypes item fields (JiraIssueType)
| Field | Type | Description |
|---|---|---|
id | string | Issue type ID |
name | string | Issue type name |
description | string | Issue type description |
isSubtask | boolean | Whether this is a subtask type |
Example:
discoverExtended
Search Jira API for available operations beyond core tools
Arguments:
query(string, required): Describe what you want to do (e.g., "add label to card")limit(number, optional): Max results to return (default 5)
Returns:
AdapterOperationResult - List of matching operations with their details
Example:
executeExtended
Execute a Jira API operation by operationId
Arguments:
operationId(string, required): The operationId from discoverExtended resultspathParams(object, optional): Path parameters, e.g., { id: "abc123" }queryParams(object, optional): Query string parametersbody(object, optional): Request body for POST/PUT/PATCH operations
Returns:
AdapterOperationResult - API response data
Example:
Extended Operations
This adapter supports the full Jira API via OpenAPI discovery. Use discoverExtended to find operations and executeExtended to run them.