Skip to content

RED-220219: omit fields=*all on Jira reads - #27

Open
bmatsliah wants to merge 1 commit into
atlassian:mainfrom
bmatsliah:RED-220219-jira-fields
Open

bmatsliah wants to merge 1 commit into
atlassian:mainfrom
bmatsliah:RED-220219-jira-fields

Conversation

@bmatsliah

Copy link
Copy Markdown

Motivation

jira_get_issue with fields=*all returns every custom field, including hundreds of empty ones, when description, status, assignee, and comments are enough. The Jira skill agents load still pointed at an all-fields read (--full).

Value

  • Agents skip the all-fields payload on ordinary Jira reads.
  • A named custom field is requested by id, so one field does not pull the whole field catalog.
  • Default reads stay sufficient for description, status, and comments.

Value rank

4/10 — cuts a large, repeated context waste on Jira reads; not a service outage.

This PR proves (ticket AC)

Copied here because the review bot cannot open Jira.

  • The Jira skill omits fields=*all. A named custom field is requested by id (--field / --fields / fields listing that id), not via fields=*all or --full. See skills/twg-jira/SKILL.md and skills/twg-jira/references/workitems.md.
  • Default fields already include description, status, and comments. Complete paginated comment history still uses --comments.

Not this PR

Do not treat these as defects in this diff — follow-ups or accepted risks.

  • Changing Jira or twg default field sets in the CLI.
  • Other skills, troubleshooting workflows, and log samples.
  • --full remains the read that needs every field plus comments and remote links.

Reviewer scope

Flag: guidance that still tells an agent to fetch every field in order to read one named custom field.
Leave alone: the pre-existing auth.conf string in skills/twg-bench-lite/scripts/benchmark-lite/runner.mjs (already on main; this diff does not touch it).

Summary

  • Stop recommending an all-fields Jira read for ordinary workitem gets.
  • Request a named custom field by id.
  • State that default fields already include description, status, and comments, and that --comments is the complete paginated history.

Key changes

File What changed
skills/twg-jira/SKILL.md Omit fields=*all; named fields by id; default fields include description, status, and comments
skills/twg-jira/references/workitems.md Same rule; --full reserved for a true all-fields read

Test plan

  • Read skills/twg-jira/SKILL.md and confirm ordinary reads do not use fields=*all or --full.
  • Confirm a named custom field is requested with --field customfield_* or --fields.
  • Confirm --full is documented only for every field plus comments and remote links, and is not combined with --comments or --remote-links.

Public Safety Checklist

  • No tokens, credentials, cookies, auth files, or .env files.
  • No private Jira, Confluence, Bitbucket, infrastructure, pipeline, or customer URLs.
  • No customer data, proprietary content, or internal runbook detail.
  • Generated docs/skills/plugins came from the release/public profile.
  • Plugin or release metadata points to public TWG CLI docs and public CDN URLs.

Verification

Docs-only skill text. No CLI behavior change. Local review of the two files against the checklist above.

Made with Cursor

Default reads already include description, status, and comments.
Request a named custom field by id instead of every field.

Co-authored-by: Cursor <cursoragent@cursor.com>
@atlassian-cla-bot

Copy link
Copy Markdown

Thank you for your submission! Like many open source projects, we ask that you sign our CLA (Contributor License Agreement) before we can accept your contribution.
If your email is listed below, please ensure that you sign the CLA with the same email address.

The following users still need to sign our CLA:
❌bmatsliah

Already signed the CLA? To re-check, try refreshing the page.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant