Skip to main content
Glama

Edit issue metadata

gh_edit_issue
Destructive

Edit an existing GitHub issue's title, body, labels, assignees, or milestone, with authoritative readback verification after each change.

Instructions

Destructive write: edit metadata on exactly one existing issue after ordinary write authorization. The request may change title, body, labels, assignees, or milestone; one mutation attempt is followed by authoritative semantic readback of the requested fields. Ambiguous mutations are never retried automatically. It does not close or reopen the issue, post comments, delete the issue, or bypass repository policy.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoReplacement Markdown issue body.
repoYesGitHub repository name without the owner prefix.
ownerYesGitHub repository owner or organization login.
titleNoReplacement issue title.
numberYesIssue number to edit.
milestoneNoMilestone number to set.
labels_addNoLabels to add.
assignees_addNoAssignee logins or the @me selector to add.
labels_removeNoLabels to remove.
assignees_removeNoAssignee logins or the @me selector to remove.
remove_milestoneNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYes
stateYes
titleYes
numberYes
messageYes
warningNo
request_idNo
write_completedYes
readback_completedYes
precondition_checkedYes
state_matches_requestedYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed34 schema fields changedv0.8.1
    • changedInput schema / properties / assignees_add / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "type": "string"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "maxLength": 39,
      +      "minLength": 1,
      +      "pattern": "^(?:@me|[A-Za-z0-9](?:[A-Za-z0-9-]{0,38}))$",
      +      "type": "string"
      +    },
      +    "maxItems": 10,
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / assignees_add / description
      Added value: +"Assignee logins or the @me selector to add."
    • changedInput schema / properties / assignees_remove / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "type": "string"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "maxLength": 39,
      +      "minLength": 1,
      +      "pattern": "^(?:@me|[A-Za-z0-9](?:[A-Za-z0-9-]{0,38}))$",
      +      "type": "string"
      +    },
      +    "maxItems": 10,
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / assignees_remove / description
      Added value: +"Assignee logins or the @me selector to remove."
    • changedInput schema / properties / body / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maxLength": 65536,
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / body / description
      Added value: +"Replacement Markdown issue body."
    • changedInput schema / properties / labels_add / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "type": "string"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "maxLength": 100,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "maxItems": 100,
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / labels_add / description
      Added value: +"Labels to add."
    • changedInput schema / properties / labels_remove / anyOf
      Previous value: -[
      -  {
      -    "items": {
      -      "type": "string"
      -    },
      -    "type": "array"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "items": {
      +      "maxLength": 100,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "maxItems": 100,
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / labels_remove / description
      Added value: +"Labels to remove."
    • changedInput schema / properties / milestone / anyOf
      Previous value: -[
      -  {
      -    "type": "integer"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "description": "Positive GitHub object number.",
      +    "minimum": 1,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / milestone / description
      Added value: +"Milestone number to set."
    • addedInput schema / properties / number / description
      Added value: +"Issue number to edit."
    • addedInput schema / properties / number / minimum
      Added value: +1
    • addedInput schema / properties / owner / description
      Added value: +"GitHub repository owner or organization login."
    • addedInput schema / properties / owner / maxLength
      Added value: +39
    • addedInput schema / properties / owner / minLength
      Added value: +1
    • addedInput schema / properties / owner / pattern
      Added value: +"^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})$"
    • addedInput schema / properties / repo / description
      Added value: +"GitHub repository name without the owner prefix."
    • addedInput schema / properties / repo / maxLength
      Added value: +100
    • addedInput schema / properties / repo / minLength
      Added value: +1
    • addedInput schema / properties / repo / pattern
      Added value: +"^[A-Za-z0-9_.-]{1,100}$"
    • changedInput schema / properties / title / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "maxLength": 256,
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / title / description
      Added value: +"Replacement issue title."
    • changedOutput schema / description
      Previous value: -"Result of editing an issue."New value: +"Authoritative outcome of one issue metadata edit attempt."
    • addedOutput schema / properties / number / minimum
      Added value: +1
    • addedOutput schema / properties / precondition_checked
      Added value: +{
      +  "title": "Precondition Checked",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / readback_completed
      Added value: +{
      +  "title": "Readback Completed",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / request_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Request Id"
      +}
    • addedOutput schema / properties / state_matches_requested
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "title": "State Matches Requested"
      +}
    • addedOutput schema / properties / warning
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Warning"
      +}
    • addedOutput schema / properties / write_completed
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "title": "Write Completed"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "number",
      -  "title",
      -  "state",
      -  "url",
      -  "message"
      -]New value: +[
      +  "precondition_checked",
      +  "write_completed",
      +  "readback_completed",
      +  "state_matches_requested",
      +  "number",
      +  "title",
      +  "state",
      +  "url",
      +  "message"
      +]
    • changedOutput schema / title
      Previous value: -"IssueEdit"New value: +"IssueEditResult"
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and readOnlyHint=false. The description adds significant context: it is a destructive write requiring ordinary authorization, performs a single mutation attempt with semantic readback, never auto-retries ambiguous mutations, and does not circumvent repository policy. This goes well beyond the annotation flags.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, front-loaded with 'Destructive write', no redundant phrases, and every sentence adds distinct information. The structure is efficient and scannable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 11-parameter mutation tool, the description covers authorization, scope (one issue), readback verification, retry policy, and exclusions. Output schema covers return values, so omitting them here is appropriate. The description is complete for a complex tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 91%, so the baseline is 3. The description briefly lists mutable field categories but does not clarify per-parameter semantics such as null handling or interaction between add/remove arrays. This adds little beyond the schema's own parameter descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool edits metadata on exactly one existing issue and enumerates the mutable fields (title, body, labels, assignees, milestone). It distinguishes itself from siblings by explicitly listing what it does not do (close/reopen, post comments, delete), removing ambiguity.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides when-to-use context ('exactly one existing issue', 'ordinary write authorization') and when-not-to-use exclusions (does not close/reopen, post comments, delete, bypass policy). However, it does not explicitly name alternative tools for these excluded actions, stopping short of full alternative guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/fvanevski/gh_mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server