Skip to content
Shipper

shipper_retract_comment

shipper_retract_comment

Section titled “shipper_retract_comment”

Withdraw a note from a Shipper issue by note ID. A note is an append-only, retractable annotation distinct from Shipper workflow comments. This tool cannot touch workflow comments, including grooming summaries, stage transitions, and blocked comments.

When to use

Section titled “When to use”

Use this to withdraw any note on the selected issue, regardless of author. Pass either the note_id returned by shipper_comment or the event ID on an un-retracted note in shipper_get_issue. Notes are append-only and retractable; Shipper workflow comments—including grooming summaries, stage transitions, and blocked comments—cannot be targeted. Repeated retraction is an idempotent success and retries a failed GitHub mirror deletion, which remains repairable by shipper issue reconcile --repair. If the authoritative local retraction fails, the tool returns the underlying error.

Behavior hints

Section titled “Behavior hints”
  • destructiveHint: true — The tool withdraws an issue note and may delete its GitHub mirror; it cannot remove or rewrite Shipper workflow comments.
  • idempotentHint: true — Retrying the same call is expected to be safe once the target state is reached.
  • openWorldHint: true — The tool reaches GitHub or other external systems outside the MCP server.

Input schema

Section titled “Input schema”
NameTypeRequiredDefaultDescription
issueinteger | stringyes-Shipper issue reference. S# (GitHub #) accepts ordinary surrounding whitespace and requires the current mirror. Bare numbers are Shipper local IDs first; S# is accepted; gh: and # explicitly target a mapped GitHub issue; GitHub issue URLs are accepted. Responses return S# first with GitHub # second when mapped.
note_idstringyes-Required non-blank note identifier returned by shipper_comment or exposed as the note comment event attribute by shipper_get_issue.

Example call

Section titled “Example call”
{
  "issue": "S#42",
  "note_id": "550e8400-e29b-41d4-a716-446655440000"
}

Example result

Section titled “Example result”
Resolved issue: S#42 (GitHub #123): Generate MCP tool reference pages
Note retracted on S#42 (GitHub #123).


Repeated call:
Note already retracted on S#42 (GitHub #123).

Error modes

Section titled “Error modes”
  • Local issue-state replica not initialized: Local issue-state replica is not initialized for owner/repo. Run shipper issue reconcile --repair to import/reconcile it.
  • Local issue-state replica present but not fully reconciled: Local issue-state replica is present but not fully reconciled for owner/repo. Run shipper issue reconcile --repair to import/reconcile it.
  • Local issue-state replica schema unsupported: Local issue-state replica has an unsupported schema for owner/repo. Locally reconstructable older replicas migrate automatically on first issue-state access. Run shipper issue reconcile --repair for supported local-ID V3 blocker imports requiring GitHub data or ordinary current-store repair. Numeric snapshots in issues/<GitHub-number>.json or _pending-blocker-imports/legacy/<GitHub-number>.json refuse the entire store, listing all affected records and leaving existing local issue state unchanged. This Shipper version no longer migrates GitHub-number issue snapshots. Use a Shipper release from before this change to migrate the store before retrying this version. Fresh or recreated stores retain initial blocked-state imports and interrupted-import retries after metadata becomes reconciled; local-ID V3 stored blocker lists can complete locally in store-only mode.
  • Local issue-state replica malformed: Local issue-state replica is malformed for owner/repo. Run shipper issue reconcile --repair to import/reconcile it.
  • Running issue-state reader stale: The running Shipper issue-state reader is stale for owner/repo: observed store schema v10 is newer than supported schema v9. Restart or reconnect the MCP client and server. If a freshly launched server remains incompatible, update the installed Shipper release or rebuild the source checkout before reconnecting. Preserve the issue-state store unchanged.
  • Unknown note identifier: Unknown note identifier “<note_id>” on S# (GitHub #).
  • Non-note workflow history: Identifier “<note_id>” on S# (GitHub #) names non-note workflow history; workflow comments cannot be retracted.
Section titled “Related tools”