Jira Tool Calling

[jonathanhawkins]

Please add new tools to JIRA.

Jira Tool Calling - API Endpoints

1. Create Issue

• Endpoint: POST /rest/api/3/issue
• Purpose: Create a new issue in a specified project.
• Required Parameters:
  • project.key
  • summary
  • issuetype.name
• Optional Parameters:
  • description
  • assignee.accountId
  • priority.name
  • timetracking.originalEstimate
• Notes:
  To determine required fields for a specific project and issue type, use the GET /rest/api/3/issue/createmeta endpoint.
  Source: Everhour

2. Update Issue

• Endpoint: PUT /rest/api/3/issue/{issueIdOrKey}
• Purpose: Update fields of an existing issue, including changing its priority.
• Required Parameters:
  • issueIdOrKey
• Optional Parameters:
  • fields
  • update
• Notes:
  You can use either the fields object for simple updates or the update object for more complex operations.
  To change the priority of an issue, include the priority field in the fields object.

3. Delete Issue

• Endpoint: DELETE /rest/api/3/issue/{issueIdOrKey}
• Purpose: Delete an issue by ID or key.
• Required Parameters:
  • issueIdOrKey
• Optional Parameters:
  • deleteSubtasks
• Notes:
  To delete an issue with subtasks, set deleteSubtasks to true.
  [Source: Tempo Help Center, Atlassian Marketplace]

4. Search Issues (JQL)

• Endpoint: GET /rest/api/3/search
• Purpose: Search for issues using Jira Query Language (JQL).
• Required Parameters:
  • jql
• Optional Parameters:
  • startAt
  • maxResults
  • fields
• Notes:
  Ensure the JQL query is URL-encoded.
  Source: GitHub

5. Transition Issue

• Endpoint: POST /rest/api/3/issue/{issueIdOrKey}/transitions
• Purpose: Transition an issue to a different status.
• Required Parameters:
  • issueIdOrKey
  • transition.id
• Optional Parameters:
  • fields
  • update
• Notes:
  To determine available transitions and required fields, use GET /rest/api/3/issue/{issueIdOrKey}/transitions?expand=transitions.fields.

6. Assign Issue

• Endpoint: PUT /rest/api/3/issue/{issueIdOrKey}/assignee
• Purpose: Assign an issue to a user.
• Required Parameters:
  • issueIdOrKey
  • accountId
• Notes:
  The accountId of the user can be obtained via the GET /rest/api/3/user/search endpoint.

7. Add Attachment to Issue

• Endpoint: POST /rest/api/3/issue/{issueIdOrKey}/attachments
• Purpose: Add one or more attachments to an issue.
• Required Parameters:
  • issueIdOrKey
  • file
• Headers Required:
  • X-Atlassian-Token: no-check
  • Content-Type: multipart/form-data
• Notes:
  Attachments must be uploaded as multipart/form-data.

8. Get Project Details

• Endpoint: GET /rest/api/3/project/{projectIdOrKey}
• Purpose: Retrieve details of a specific project.
• Required Parameters:
  • projectIdOrKey
• Notes:
  This endpoint provides information such as project name, key, and issue types.

9. Create Sub-task

• Endpoint: POST /rest/api/3/issue
• Purpose: Create a sub-task under an existing parent issue.
• Required Parameters:
  • project.key
  • summary
  • issuetype.id (must correspond to a sub-task issue type)
  • parent.key (key of the parent issue)
• Optional Parameters:
  • description
  • assignee.accountId
  • priority.name
• Notes:
  Creating sub-tasks helps in breaking down complex tasks into manageable units, facilitating better tracking and assignment.
  Ensure that the issuetype.id corresponds to a sub-task type configured in your Jira instance.
  [Source: Business Programming, Atlassian Developer]

10. Manage Sprints

• Endpoint: POST /rest/agile/1.0/sprint
• Purpose: Create a new sprint in a specified board.
• Required Parameters:
  • name
  • originBoardId
• Optional Parameters:
  • startDate
  • endDate
  • goal
• Notes:
  Managing sprints is crucial for agile development processes.
  This endpoint allows producers to programmatically create sprints, aiding in planning and organizing development cycles.