> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Jira > A tool for bug tracking, issue tracking, and agile project management A tool for bug tracking, issue tracking, and agile project management. `jira` · **102 tools** · **3 triggers** ## Connect it ```bash theme={"theme":"github-dark"} run auth jira run auth jira --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run jira # common commands run jira --all # every command ``` ```ts theme={"theme":"github-dark"} import { jira } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-attachment` | Uploads and attaches a file to a Jira issue. | | `add-comment` | Adds a comment using Atlassian Document Format (ADF) for rich text to an existing Jira issue. | | `add-users-to-project-role` | Adds users and optionally groups to a project role. | | `add-user-to-group` | Adds a user to a Jira group. | | `add-watcher-to-issue` | Adds a user to an issue's watcher list by account ID. Requires the authenticated user to have permission to view the issue and manage watchers... | | `add-worklog` | Tool to add a worklog entry to a Jira issue. Use when logging time spent on an issue. | | `assign-issue` | Assigns a Jira issue to a user, default assignee, or unassigns; supports email/name lookup. | | `bulk-create-issue` | Creates multiple Jira issues (up to 50 per call) with full feature support including markdown, assignee resolution, and priority handling. | | `create-board` | Creates a new Jira board (kanban, scrum, or agility) with optional filter and location configuration. | | `create-group` | Creates a new group in Jira with the specified name. | | `create-issue` | Creates a new Jira issue (e.g., bug, task, story) in a specified project. | | `create-issue-link` | Links two Jira issues using a specified link type with optional comment. | | `create-project` | Creates a new Jira project with required lead, template, and type configuration. | | `create-sprint` | Creates a new sprint on a Jira board with optional start/end dates and goal. | | `create-version` | Creates a new version for releases or milestones in a Jira project. | | `delete-issue` | Permanently and irreversibly deletes a Jira issue by its ID or key. | | `edit-issue` | Updates an existing Jira issue with field values and operations. | | `fetch-bulk-issues` | Tool to bulk fetch multiple Jira issues by their IDs or keys (max 100 per call). | | `find-users` | DEPRECATED: Use JIRA\_FIND\_USERS2 instead. Searches for Jira users by email or display name to find account IDs; essential for assigning issues... | | `get-all-groups` | Retrieves a page of groups from the Jira instance. Useful for resolving correct group names or IDs before passing them to other tools. | | `get-all-projects` | Retrieves all visible projects using the modern paginated Jira API with server-side filtering and pagination support. | | `get-all-users` | Retrieves all users from the Jira instance including active, inactive, app accounts, and system accounts, with pagination support. | | `get-attachment` | Retrieves the binary content of a Jira attachment by ID. Use when you need to download a specific file attached to an issue. | | `get-attachment-meta` | Tool to retrieve Jira attachment settings including upload limits and enabled status. | | `get-components` | Tool to retrieve components from Jira projects with search and filtering. | | Tool | What it does | | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-attachment` | Uploads and attaches a file to a Jira issue. | | `add-comment` | Adds a comment using Atlassian Document Format (ADF) for rich text to an existing Jira issue. | | `add-users-to-project-role` | Adds users and optionally groups to a project role. | | `add-user-to-group` | Adds a user to a Jira group. | | `add-watcher-to-issue` | Adds a user to an issue's watcher list by account ID. Requires the authenticated user to have permission to view the issue and manage watchers... | | `add-worklog` | Tool to add a worklog entry to a Jira issue. Use when logging time spent on an issue. | | `analyse-expression` | Analyses Jira expressions for syntax validation, type checking, and complexity analysis. | | `assign-issue` | Assigns a Jira issue to a user, default assignee, or unassigns; supports email/name lookup. | | `bulk-create-issue` | Creates multiple Jira issues (up to 50 per call) with full feature support including markdown, assignee resolution, and priority handling. | | `check-permissions` | Check user permissions for global and project-level operations in Jira. | | `create-board` | Creates a new Jira board (kanban, scrum, or agility) with optional filter and location configuration. | | `create-group` | Creates a new group in Jira with the specified name. | | `create-issue` | Creates a new Jira issue (e.g., bug, task, story) in a specified project. | | `create-issue-link` | Links two Jira issues using a specified link type with optional comment. | | `create-jql-autocompletedata` | Retrieves JQL autocomplete reference data including reserved words, field names, and function names. | | `create-project` | Creates a new Jira project with required lead, template, and type configuration. | | `create-sprint` | Creates a new sprint on a Jira board with optional start/end dates and goal. | | `create-version` | Creates a new version for releases or milestones in a Jira project. | | `delete-attachment` | Permanently deletes an attachment from Jira by its ID. This action is irreversible - the attachment cannot be recovered once removed. | | `delete-comment` | Deletes a specific comment from a Jira issue using its ID and the issue's ID/key; requires user permission to delete comments on the issue. | | `delete-issue` | Permanently and irreversibly deletes a Jira issue by its ID or key. | | `delete-version` | Deletes a Jira version and optionally reassigns its issues. | | `delete-worklog` | Deletes a worklog from a Jira issue with estimate adjustment options. | | `edit-issue` | Updates an existing Jira issue with field values and operations. | | `evaluate-expression` | Tool to evaluate Jira expressions using the enhanced search API. | | `fetch-bulk-issues` | Tool to bulk fetch multiple Jira issues by their IDs or keys (max 100 per call). | | `find-users` | DEPRECATED: Use JIRA\_FIND\_USERS2 instead. Searches for Jira users by email or display name to find account IDs; essential for assigning issues... | | `find-users2` | Tool to find users in Jira by query string, account ID, or property search. | | `find-users-for-picker` | Find users for picker components by matching query against user attributes like display name and email. | | `get-all-groups` | Retrieves a page of groups from the Jira instance. Useful for resolving correct group names or IDs before passing them to other tools. | | `get-all-issue-type-schemes` | Retrieves all Jira issue type schemes with optional filtering and pagination. | | `get-all-projects` | Retrieves all visible projects using the modern paginated Jira API with server-side filtering and pagination support. | | `get-all-statuses` | Retrieves all issue statuses associated with workflows from Jira. | | `get-all-users` | Retrieves all users from the Jira instance including active, inactive, app accounts, and system accounts, with pagination support. | | `get-attachment` | Retrieves the binary content of a Jira attachment by ID. Use when you need to download a specific file attached to an issue. | | `get-attachment-meta` | Tool to retrieve Jira attachment settings including upload limits and enabled status. | | `get-comment` | Retrieves a specific comment by ID from a Jira issue with optional expansions. | | `get-components` | Tool to retrieve components from Jira projects with search and filtering. | | `get-create-metadata-issue-type-fields` | Tool to retrieve field metadata for a specific issue type in a project. | | `get-current-user` | Retrieves detailed information about the currently authenticated Jira user. | | `get-dashboards` | Tool to list and search Jira dashboards visible to the current user. | | `get-favorite-filters` | Tool to retrieve favorite filters for the current user. Use when you need to discover which saved filters the user has marked as favorites. | | `get-fields` | Tool to retrieve Jira issue fields metadata. Use before editing an issue to discover custom field IDs and names. | | `get-fields-paginated` | Tool to retrieve Jira fields in pages. Use when you need to filter or page through custom and system fields. | | `get-filter` | Retrieves a specific Jira saved filter by ID, including its JQL and sharing metadata, to reuse in subsequent searches. | | `get-group` | Retrieves details of a specific Jira group by name or ID. Use JIRA\_GET\_ALL\_GROUPS to discover valid group names/IDs first. | | `get-info` | Retrieves runtime information for the Jira Service Management instance. | | `get-issue` | Retrieves a Jira issue by ID or key with customizable fields and expansions. | | `get-issue-create-metadata` | DEPRECATED: Use JIRA\_GET\_CREATE\_METADATA\_ISSUE\_TYPE\_FIELDS instead. | | `get-issue-edit-metadata` | Tool to retrieve editable fields for a Jira issue. Use before running an edit action to fetch custom field metadata and required fields. | | `get-issue-link-types` | Retrieves all configured issue link types from Jira. | | `get-issue-picker-suggestions` | Tool to get issue picker suggestions from Jira. Use when you need to search for issues and get auto-completion suggestions. | | `get-issue-property` | Retrieves a custom property from a Jira issue by key. | | `get-issue-resolutions` | Retrieves all available issue resolution types from Jira. | | `get-issue-types` | Retrieves all Jira issue types available to the user using the modern API v3 endpoint; results vary based on 'Administer Jira' global or 'Browse... | | `get-issue-watchers` | Retrieves users watching a Jira issue for update notifications. | | `get-issue-worklogs` | DEPRECATED: Use JIRA\_GET\_WORKLOG instead. This action is deprecated because it lacks the expand parameter for worklog properties. | | `get-jql-autocompletedata` | Tool to retrieve JQL autocomplete reference data. Use when you need to discover available JQL fields, functions, and reserved words for building queries. | | `get-jql-autocompletedata-suggestions` | Tool to get JQL field auto-complete suggestions. Use when building JQL queries to discover valid field values or predicate options. | | `get-my-permissions` | Tool to retrieve the user's permissions in Jira. Use when checking what actions the authenticated user can perform in a specific context (project, issue, or comment). | | `get-mypreferences-locale` | Tool to retrieve the locale preference of the currently authenticated Jira user. | | `get-permissions` | Tool to retrieve all available Jira permissions. Use when you need to list all permission types that exist in Jira, including project and global permissions. | | `get-permitted-projects` | Tool to retrieve projects where the current user has specific permissions. | | `get-project` | Retrieves details of a Jira project by its ID or key. | | `get-project-roles` | Retrieves all available roles for a Jira project. Role IDs are project-specific and must not be reused across projects; call this action per project... | | `get-project-templates` | Retrieves available Jira project templates for creating projects. | | `get-project-type` | Retrieves detailed information about a specific Jira project type by its key. | | `get-project-versions` | Retrieves all versions for a Jira project with optional expansion. | | `get-recent-projects` | Retrieves a list of projects recently accessed by the authenticated user. | | `get-remote-issue-links` | Retrieves links from a Jira issue to external resources. | | `get-server-info` | Tool to retrieve Jira instance server information. Use when you need details about the Jira version, build, deployment type, or server configuration. | | `get-service-desk-request-type-fields` | Tool to retrieve JSM request type field metadata for filling out portal requests. | | `get-sprint` | Retrieves detailed information about a specific sprint by its ID. | | `get-system-avatars` | Tool to retrieve all system avatars for a specific type (issuetype, project, user, or priority). | | `get-transitions` | Retrieves available workflow transitions for a Jira issue. Always use the numeric `id` from the response when calling JIRA\_TRANSITION\_ISSUE - ... | | `get-universal-avatar-type-owner` | Tool to retrieve all avatars (system and custom) for a specific type and entity in Jira. | | `get-universal-avatar-view-type` | Tool to retrieve the default avatar image for a specific type (project, issuetype, or priority) from Jira. | | `get-user-groups` | Retrieves all groups for a specific Jira user by account ID. | | `get-view-type-avatar` | Tool to retrieve a specific avatar image by type and ID from Jira. | | `get-votes` | Fetches voting details for a Jira issue; requires voting to be enabled in Jira's general settings. | | `get-worklog` | Retrieves worklogs for a specified Jira issue. | | `list-all-projects` | DEPRECATED: Use JIRA\_GET\_ALL\_PROJECTS instead. Tool to list all projects accessible to the user. | | `list-boards` | Retrieves paginated Jira boards with filtering and sorting options. | | `list-comments` | Tool to retrieve multiple comments by their IDs in a single request. | | `list-filters` | Tool to search and list Jira saved filters (saved searches) visible to the current user. | | `list-groups-picker` | Tool to search and list groups using Jira's picker endpoint. | | `list-issue-comments` | Retrieves paginated comments from a Jira issue with optional ordering. | | `list-project-types` | Retrieves all Jira project types available in the instance. Use when you need to discover available project types or list all types without filtering by a specific key. | | `list-sprints` | Retrieves paginated sprints from a Jira board with optional state filtering. | | `move-issue-to-sprint` | Moves one or more Jira issues to a specified active sprint. | | `parse-jql-queries` | Parse and validate JQL queries, returning their abstract syntax tree structure along with any errors or warnings. | | `remove-user-from-group` | Removes a user from a Jira group. This is a destructive operation that revokes group-based permissions; confirm intent before calling. | | `remove-user-from-project-role` | Removes a user or group from a project role. | | `remove-watcher-from-issue` | Removes a user from an issue's watcher list by account ID. | | `search-approximate-count` | Count issues matching a JQL query using approximate count endpoint. | | `search-dashboards` | Tool to search for Jira dashboards with filtering, sorting, and pagination support. | | `search-for-issues-using-jql-get` | Searches for Jira issues using JQL with pagination and field selection. | | `search-for-issues-using-jql-post` | DEPRECATED: Use JIRA\_SEARCH\_ISSUES instead. Searches for Jira Cloud issues using Enhanced JQL via POST request; supports eventual consistency and token-based pagination. | | `search-issues` | Advanced Jira issue search supporting structured filters and raw JQL. | | `send-notification-for-issue` | Sends a customized email notification for a Jira issue. | ## Triggers (3) Subscribe with `.on(...)` in a script. A trigger with required configuration takes it as the second argument. | Trigger | Needs | What fires it | | ------------- | ------------- | --------------------------------------------------------------------------- | | New Issue | `project_key` | Fires when a new issue is created in the Jira project you configure. | | New Project | nothing | Triggered when a new project is added in Jira | | Updated Issue | `project_key` | Fires when an existing issue is changed in the Jira project you configure - | [Open Jira in the console →](https://app.boxd.sh/integrations/detail/jira)