Skip to content

Commit bb94195

Browse files
committed
docs(issue_write): tighten body description and add inline code formatting
Address reviewer feedback on the issue_write body warning: - Use backticks around method="update" and add_issue_comment so they render as inline code in the README rather than as plain prose. - Tighten the sentence (drop the redundant 'rather than appending to it' and 'without modifying the body'). - Keep REPLACES as the single emphatic marker, which is the entire point of #2410 (LLM agents silently destroying issue bodies on update). Regenerates pkg/github/__toolsnaps__/issue_write.snap and the auto-generated README / docs surfaces via script/generate-docs.
1 parent 6c5d97c commit bb94195

5 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -853,7 +853,7 @@ The following sets of tools are available:
853853
- **issue_write** - Create or update issue
854854
- **Required OAuth Scopes**: `repo`
855855
- `assignees`: Usernames to assign to this issue (string[], optional)
856-
- `body`: Issue body content (Markdown). When method='update', this REPLACES the entire issue body rather than appending to it; to add a comment without modifying the body, use the add_issue_comment tool. (string, optional)
856+
- `body`: Issue body content (Markdown). On `method="update"`, this REPLACES the entire issue body; use `add_issue_comment` to add a comment without modifying the body. (string, optional)
857857
- `duplicate_of`: Issue number that this issue is a duplicate of. Only used when state_reason is 'duplicate'. (number, optional)
858858
- `issue_number`: Issue number to update (number, optional)
859859
- `labels`: Labels to apply to this issue (string[], optional)

docs/feature-flags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ runtime behavior (such as output formatting) won't appear here.
5454
- **Required OAuth Scopes**: `repo`
5555
- **MCP App UI**: `ui://github-mcp-server/issue-write`
5656
- `assignees`: Usernames to assign to this issue (string[], optional)
57-
- `body`: Issue body content (Markdown). When method='update', this REPLACES the entire issue body rather than appending to it; to add a comment without modifying the body, use the add_issue_comment tool. (string, optional)
57+
- `body`: Issue body content (Markdown). On `method="update"`, this REPLACES the entire issue body; use `add_issue_comment` to add a comment without modifying the body. (string, optional)
5858
- `duplicate_of`: Issue number that this issue is a duplicate of. Only used when state_reason is 'duplicate'. (number, optional)
5959
- `issue_number`: Issue number to update (number, optional)
6060
- `labels`: Labels to apply to this issue (string[], optional)

docs/insiders-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The list below is generated from the Go source. It covers tool **inventory and s
4848
- **Required OAuth Scopes**: `repo`
4949
- **MCP App UI**: `ui://github-mcp-server/issue-write`
5050
- `assignees`: Usernames to assign to this issue (string[], optional)
51-
- `body`: Issue body content (Markdown). When method='update', this REPLACES the entire issue body rather than appending to it; to add a comment without modifying the body, use the add_issue_comment tool. (string, optional)
51+
- `body`: Issue body content (Markdown). On `method="update"`, this REPLACES the entire issue body; use `add_issue_comment` to add a comment without modifying the body. (string, optional)
5252
- `duplicate_of`: Issue number that this issue is a duplicate of. Only used when state_reason is 'duplicate'. (number, optional)
5353
- `issue_number`: Issue number to update (number, optional)
5454
- `labels`: Labels to apply to this issue (string[], optional)

pkg/github/__toolsnaps__/issue_write.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"type": "array"
2323
},
2424
"body": {
25-
"description": "Issue body content (Markdown). When method='update', this REPLACES the entire issue body rather than appending to it; to add a comment without modifying the body, use the add_issue_comment tool.",
25+
"description": "Issue body content (Markdown). On `method=\"update\"`, this REPLACES the entire issue body; use `add_issue_comment` to add a comment without modifying the body.",
2626
"type": "string"
2727
},
2828
"duplicate_of": {

pkg/github/issues.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1815,7 +1815,7 @@ Options are:
18151815
},
18161816
"body": {
18171817
Type: "string",
1818-
Description: "Issue body content (Markdown). When method='update', this REPLACES the entire issue body rather than appending to it; to add a comment without modifying the body, use the add_issue_comment tool.",
1818+
Description: "Issue body content (Markdown). On `method=\"update\"`, this REPLACES the entire issue body; use `add_issue_comment` to add a comment without modifying the body.",
18191819
},
18201820
"assignees": {
18211821
Type: "array",

0 commit comments

Comments
 (0)