docs(rhdh-jira): add Gotcha #19 — MCP create_jira_issue does not support ADF - #76
Merged
christoph-jerolimov merged 1 commit intoJul 29, 2026
Conversation
…ue does not support ADF When an IDE provides `create_jira_issue` via MCP, agents take the shortcut and pass raw markdown as the description. Jira wraps it in a single ADF paragraph node, rendering headings, bold, task lists, and links as literal characters. Add a gotcha warning agents to use `acli jira workitem create` with `--description-file` for formatted descriptions, and to reserve the MCP tool for quick unformatted issues only. Co-authored-by: Cursor <cursoragent@cursor.com>
christoph-jerolimov
approved these changes
Jul 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
create_jira_issuetool does not support ADF formatting## Heading,**bold**,- [ ] taskas literal charactersacli jira workitem createwith--description-filefor formatted descriptions, and to reserve the MCP tool for quick unformatted issues onlyContext
Discovered while creating RHIDP-15904 — the MCP tool produced an unformatted description that had to be corrected with
acli edit --description-fileusing proper ADF JSON. Gotcha #6 already documents that ADF is required, but doesn't mention MCP as a common bypass vector.Test plan
uv run pytest— 436 passed, 5 skipped, 1 pre-existing failure (missingskopeo)uv run ruff check .— all checks passedMade with Cursor