LearnNewsExamplesServices
Frontmatter
id11924
titleClean GitHub Workflow and shared MCP source comments
stateClosed
labels
documentationenhancementairefactoringarchitecturemodel-experience
assigneesneo-gpt
createdAtMay 24, 2026, 10:48 PM
updatedAtMay 28, 2026, 7:54 AM
githubUrlhttps://github.com/neomjs/neo/issues/11924
authorneo-gpt
commentsCount2
parentIssue11912
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtMay 28, 2026, 7:54 AM

Clean GitHub Workflow and shared MCP source comments

Closed v13.0.0/archive-v13-0-0-chunk-13 documentationenhancementairefactoringarchitecturemodel-experience
neo-gpt
neo-gpt commented on May 24, 2026, 10:48 PM

Parent epic: #11912

Context

#11912 is being reshaped into an epic with grouped cleanup subissues. This subissue owns GitHub Workflow services and shared MCP runtime surfaces.

Current grouped baseline on origin/dev:

  • ai/services/github-workflow/**/*.mjs plus ai/mcp/server/github-workflow/**/*.mjs: 93 diagnostic matches.
  • ai/mcp/server/shared/**/*.mjs: 37 diagnostic matches.
  • Top files include PullRequestService.mjs, IssueSyncer.mjs, IssueService.mjs, toolService.mjs, RequestContextService.mjs, and shared auth/transport helpers.

The Problem

GitHub Workflow and shared MCP comments often cite specific PR cycles, ACs, and historical incidents. These comments should instead describe durable API, sync, auth, transport, and graph-ingestion contracts.

The Architectural Reality

This group mediates GitHub issue/PR/discussion sync, review and relationship tooling, shared request context, auth, and transport behavior. Comments in this layer are read by agents during live workflow execution, so stale archaeology can distort current operational decisions.

The Fix

Clean GitHub Workflow and shared MCP source comments in grouped batches:

  1. Rewrite ticket/PR/AC/cycle references into stable API and service-boundary contracts.
  2. Preserve references to public GitHub semantics or schema names when those are the stable authority.
  3. Document false positives and runtime strings that are intentionally left unchanged.
  4. Keep generated OpenAPI/YAML or resource mirrors out of scope unless a .mjs source comment points to them incorrectly.

Contract Ledger Matrix

Target Surface Source of Authority Proposed Behavior Fallback Docs Evidence
GitHub Workflow service comments/JSDoc #11912 source-comment cleanup epic Comments explain sync/review/relationship contracts without PR-cycle archaeology File separate runtime/schema ticket if cleanup finds drift PR bodies Before/after focused diagnostics
Shared MCP runtime comments/JSDoc #11912 source-comment cleanup epic Comments explain auth/request/transport boundaries in stable terms Preserve public API names and exact header names PR bodies Before/after focused diagnostics

Decision Record Impact

Aligned with ADR 0005 and ADR 0008. No ADR amendment expected.

Acceptance Criteria

  • Clean GitHub Workflow service .mjs comments/JSDoc to durable intent phrasing.
  • Clean shared MCP .mjs comments/JSDoc to durable intent phrasing.
  • Preserve runtime behavior and public API/schema names.
  • PR evidence includes before/after focused counts and git diff --check.
  • Parent #11912 remains open until all grouped subissues are complete.

Out of Scope

  • Memory Core, Knowledge Base/Graph, daemon/script, and residual config groups.
  • Runtime behavior changes.
  • Generated issue/PR/discussion mirrors.

Related

Origin Session ID: 019e5bac-15f3-7830-a59c-72772c757f9a

Handoff Retrieval Hint: query_raw_memories("11912 github-workflow shared MCP RequestContext source-comment archaeology")

tobiu referenced in commit 17861d4 - "chore(ai): clean github-workflow source comments (#11924) (#11949) on May 25, 2026, 7:25 AM
tobiu referenced in commit 58cf942 - "chore(ai): clean github workflow sync comments (#11924) (#11972) on May 25, 2026, 4:31 PM
tobiu referenced in commit 88df18d - "chore(ai): clean residual github workflow comments (#11924) (#12021) on May 26, 2026, 7:06 PM
tobiu referenced in commit 3c0888a - "chore(ai): clean shared mcp comments (#11924) (#12057)" on May 27, 2026, 2:13 AM