Jira

Tip

You can connect and scope this context source by hand as this page describes, or ask Promptless in Slack or Microsoft Teams to do it for you. For example, “@Promptless add Jira as a context source limited to my DOCS and ENG projects.” See Ask Promptless to update your configuration.

Jira integration provides read-only access to your project management and issue tracking data for documentation automation. When Jira is configured as a context source, Promptless can search for related tickets to understand requirements and business context—but it never modifies your Jira tickets.

Note

This page covers Jira as a read-only context source. Starting Promptless sessions from Jira tickets and replying on them is a separate capability, documented on the Jira trigger page.

How it works as a context source

When Jira is enabled as a context source:

• Automatic Issue Retrieval: When a GitHub PR or other trigger references a Jira ticket (like PROJ-123), Promptless reads that ticket for context as soon as Jira is connected. It never modifies tickets, and reads only what the connected Jira account can see within the projects you configure under project_keys (all projects by default). Each retrieval covers:
  • summary and description
  • status, type, priority, and resolution
  • labels, components, and affected and fix versions
  • parent, subtasks, and linked issues
  • comments
  • organization-defined custom fields, such as a Documentation field
• Proactive JQL Searches: Promptless can proactively search Jira using JQL queries to find related issues, epics, and project data
• Business Context: Jira tickets provide requirements, business logic, and feature context that enhance documentation accuracy

Example

Jira tracks work from idea to launch, and each ticket records the requirements and acceptance criteria a team agreed on before any code was written. That makes a referenced ticket a reliable source for what a feature is supposed to do.

A developer merges a GitHub PR whose description references PROJ-412, the Jira ticket tracking a new bulk-import feature. The ticket spells out the business requirements: which file formats are supported, the 10,000-row import cap, and the rule that imports run asynchronously with an email notification on completion.

When Promptless picks up the merged PR, it retrieves PROJ-412 and runs a JQL search for related issues in the same epic. It reads the acceptance criteria and carries them into the documentation suggestion—the supported formats, the row limit, and the async-with-email behavior—so the docs reflect what the feature is meant to do, not just what the diff happens to show.

JQL search capabilities

Promptless leverages Jira’s powerful JQL (Jira Query Language) search functionality to find relevant context. This allows intelligent searching across your Jira projects to find related issues, epics, and dependencies.

Configuration

Configure Jira scope in your Configuration page using the context_sources section:

context_sources:
  jira:
    source_type: jira
    project_keys:
      - DOCS
      - PLATFORM
      - ENG

An empty entry (or no entry) gives Promptless access to all projects. Add project_keys only when you need to restrict which projects Promptless can search.

Note

Promptless inherits the permissions of the Jira account used during OAuth connection and only searches projects you explicitly configure.

Data privacy

Promptless queries Jira data in real-time and does not store any of your Jira data. All searches are performed on-demand when documentation updates are needed. As a context source, Promptless only reads from Jira—it never creates, updates, or deletes tickets. (Starting sessions from Jira tickets and replying on them is a separate capability—see the Jira trigger page.)

Setup instructions

To connect Jira to Promptless, see the Atlassian Integration setup guide.