Skip to content

docs(cli): fix Jira CLI card to reflect direct Atlassian REST API access#1364

Open
kovtcharov-amd wants to merge 1 commit into
mainfrom
docs/jira-cli-card-wording
Open

docs(cli): fix Jira CLI card to reflect direct Atlassian REST API access#1364
kovtcharov-amd wants to merge 1 commit into
mainfrom
docs/jira-cli-card-wording

Conversation

@kovtcharov-amd
Copy link
Copy Markdown
Collaborator

Why this matters

A review comment on the merged #1337 (review) flagged a docs-accuracy bug: the new Jira CLI card said gaia jira works "via the MCP bridge." That's wrong and could send users down a needless setup path. The code path (handle_jira_command → imports gaia.apps.jira.app directly, comment: "no MCP needed") and the Jira guide ("communicates directly with the Atlassian REST API — no intermediary services or MCP bridge required") both contradict the card. This aligns the card with the code and the guide.

The --mcp-host / --mcp-port flags are a real optional integration (they exist in the jira subparser), so they remain in the options table — only the high-level description changed.

Test plan

  • Card description at docs/reference/cli.mdx Jira section now reads "using your Atlassian credentials (REST API)" and matches docs/guides/jira.mdx.
  • gaia jira -h still lists --mcp-host/--mcp-port (options table unchanged).

The Jira CLI card claimed gaia jira works "via the MCP bridge," but
handle_jira_command runs gaia.apps.jira.app directly ("no MCP needed")
and the Jira guide states it talks to the Atlassian REST API with no
bridge required. The --mcp-host/--mcp-port options remain valid for the
optional MCP integration, so they stay in the options table.
@github-actions github-actions Bot added the documentation Documentation changes label Jun 2, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

One-line change, correctly targeted: the Jira card description was factually wrong, and this fixes it to match both the code path (handle_jira_commandgaia.apps.jira.app, "no MCP needed") and the Jira guide (docs/guides/jira.mdx:12).

Summary

A single-character-budget fix that removes a misleading "via the MCP bridge" claim that would have sent users down a needless MCP setup path. The replacement — "using your Atlassian credentials (REST API)" — matches the Jira guide verbatim and reflects the actual handle_jira_command code path. The --mcp-host/--mcp-port options table is intentionally left intact because those flags do exist in the subparser as an optional integration path.

Issues Found

None.

Strengths

  • Accurate root cause. The PR description traces the bug all the way through the code (handle_jira_command → import, the "no MCP needed" comment, the guide text) rather than just noting a cosmetic mismatch. This makes it easy to verify correctness without reading the code.
  • Surgical scope. Only the one wrong phrase is changed; the options table (which correctly lists the optional --mcp-host/--mcp-port flags) is untouched — good judgement not to remove real functionality from the docs.
  • Self-verifying test plan. The two test-plan checkboxes map directly to the two things a reviewer needs to confirm: card text and CLI flag presence.

Verdict

Approve. No blocking issues. The fix is correct, minimal, and consistent with docs/guides/jira.mdx.

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

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant