Skip to content

[Copilot Dreaming] Avoid development dead ends and remove duplicate guidance - #3824

Closed
Copilot wants to merge 33 commits into
mainfrom
copilot/dream-curate-memories-20261112054523
Closed

Copilot wants to merge 33 commits into
mainfrom
copilot/dream-curate-memories-20261112054523

Conversation

@Copilot

Copilot AI commented Nov 12, 2026

Copy link
Copy Markdown

🧠 How this helps Copilot

The migration guide could lead Copilot to return a value the tool registry cannot register, copy an incompatible schema default, or regenerate snapshots unnecessarily. The proposed guidance follows the current constructor and schema contracts without predicting failures for equivalent schemas.

Development instructions could select no test, point to a missing package or retired REST mock, require a personal token unnecessarily, or suggest that bare invocation starts the server. Correcting those steps and the ignore-pattern and workflow references avoids misleading setup and validation expectations.

Stale size guidance can narrow exploration prematurely. Repeated quality, validation, and package-priority rules add upkeep for maintainers who already supply those duties to the same reader; removing the extra copies leaves the complete rules at their existing owners.

An unrelated tool schema can prevent mcpcurl from generating the requested command. The recovery recipe avoids the observed failed call and source-inspection detour by isolating the requested tool.

Review commit by commit for each change's rationale and evidence.

Note

Copilot Dreaming curates this repository's Copilot instructions and skills in the background, proposing updates to help agents work here. Learn more about Copilot Dreaming.

Automated details

Source: curate-memories Dream, analyzing main at 6fbcd00.

Discarded guidance: Removing all personal-token documentation was rejected in review; the supported alternative stays documented. The merge-policy sentence stays unchanged because workflow event filters do not establish merge requirements.

Copilot AI added 30 commits November 12, 2026 05:45
A migrated constructor returning the documented tuple cannot enter the current tool registry. Following its ServerTool contract avoids an integration repair while preserving generic handler support.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/github/tools.go#L215-L224
https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/github/dependencies.go#L229-L263

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…ults

A bare Tool example can be mistaken for the complete constructor result even though registration needs its wrapper. Identifying the component avoids that contradiction without changing the illustrated input contract.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/github/dependabot.go#L21-L51

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copying the string default does not match the repository's JSON-encoded schema default. Using the established representation avoids a compilation repair while preserving the same default value and enum.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/github/dependabot.go#L113-L118

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…snapshots

Equivalent schemas pass the snapshot comparison, so predicting an inevitable failure can encourage unnecessary regeneration. The update command and intentional-change safeguard remain available when a real mismatch occurs.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/internal/toolsnaps/toolsnaps.go#L47-L66

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…ange

The snapshot comparator ignores array order. Treating ordering as an unavoidable mismatch can prompt needless snapshot churn; the requirement for logically equivalent schemas remains in the same paragraph.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/internal/toolsnaps/toolsnaps.go#L58-L66

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The tracked Go-file inventory is larger than this fixed total. A stale size shortcut risks narrowing exploration prematurely and adds upkeep as the repository grows; current tracked paths remain the authority.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The old selector names no test in the stated package and can return success without exercising GetMe. Selecting the defined unit test avoids that falsely reassuring result.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/github/context_tools_test.go#L22-L31

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
pkg/toolsets is absent from the tracked checkout. The inventory builder owns toolset configuration, so directing exploration there avoids a dead-end package search.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/inventory/builder.go#L98-L120

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…attern

The wider wildcard can make Copilot assume filenames are ignored that the actual pattern does not match. Following the owning ignore entry avoids that staging assumption.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.gitignore#L16-L17

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The same reader already receives the exact lint script and pre-commit obligation in the required command sequence. Another copy adds upkeep without a different trigger; that sequence still requires lint before finishing or committing.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L25-L30

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The required command sequence already covers documentation generation after tool or toolset changes for the same reader. Maintaining the narrower catalogue repeat adds upkeep; the generation obligation remains in that sequence.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L25-L31

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Release-only workflows are not selected by ordinary branch or pull-request updates. Removing the universal event assertion avoids expecting those release jobs during routine development; the separate merge-policy sentence remains unchanged.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/workflows/goreleaser.yml#L1-L5

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Lint CI reads the Go version from go.mod and uses action v9. Accurate setup references avoid directing Copilot toward a different lint runtime.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/workflows/lint.yml#L19-L26

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The release workflow selects version-tag pushes rather than main-branch pushes. Correct trigger guidance avoids expecting releases from routine branch updates; prohibitions on the release script and tag pushes remain in the instructions.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/workflows/goreleaser.yml#L1-L5

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…packages

The repository has unit tests in an external package. The categorical aside could prompt needless package rewrites during maintenance; alongside-file placement and the test framework guidance remain.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/github/dependencies_test.go#L1-L18

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The repository replaced the former mock dependency with local HTTP helpers. Directing new tests to the current helper avoids rediscovering that replacement while leaving GraphQL mocking unchanged.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/github/helper_test.go#L681-L695

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The same reader already receives the wide-audience clarity duty in the repository-wide quality standards. Keeping another equivalent mandate adds upkeep without a separate task trigger; that quality rule remains.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L18-L18

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The repository-wide clean-commit standard already gives the same reader the atomic, focused commit duty. Another copy adds upkeep without changing the action; that standard remains.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L19-L19

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The repository-wide quality standard already gives the same reader the maintain-or-improve duty and the prohibition on degradation. Maintaining a second equivalent rule adds upkeep; the original protection remains.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L20-L20

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The repository-wide self-documenting-code standard already limits the same reader to necessary comments. The extra copy adds upkeep without another condition; that restriction remains in the quality standards.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L21-L21

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The library-usage standard already requires exports for potential external callers and protects existing export patterns. Maintaining a narrower copy adds upkeep; the complete duty remains in that standard.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L14-L14

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
pkg/toolsets is absent from the checkout, while the tool registry collects constructors in pkg/github/tools.go. Naming the actual registration owner avoids a dead-end branch of the new-tool recipe.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/github/tools.go#L215-L224

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…atory

Stdio supports personal tokens, OAuth, and GitHub App authentication. Treating one input as universally required can prompt unnecessary setup; its supported optional role remains documented alongside the separate E2E input.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/cmd/github-mcp-server/main.go#L49-L77
https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/e2e/e2e_test.go#L47-L55

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The native root command has no server run action; stdio is an explicit subcommand. Removing the qualifier avoids expecting bare invocation to start the server, without changing the stdio command or Docker's distinct default.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/cmd/github-mcp-server/main.go#L30-L42

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The same reader already receives the local stdio server's primary-package priority at the start of the instructions. Maintaining a second reminder adds upkeep without a new audience or trigger; the primary-package rule remains.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L10-L10

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…e reminder

The library-usage standard already gives the same reader this export duty, including functions unused internally. Another copy adds upkeep; that complete duty remains, and the reminder's explicit-request exception for remote work is untouched.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L14-L14

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The required command sequence already names this exact script and covers finishing and committing for the same reader. A second mandate adds upkeep without another trigger; the original sequence still forbids skipping lint.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L25-L30

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The tool-change procedure already tells the same reader when to regenerate snapshots and to commit them. The reminder adds upkeep without another action; those schema-change and commit requirements remain in that procedure.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L35-L40

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The required command sequence already covers documentation generation after tool and toolset changes for the same reader. A narrower reminder adds upkeep without another trigger; the broader obligation remains in that sequence.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L25-L31

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The E2E section already gives the same reader the token prerequisite, dedicated variable, invocation, and in-process debug exception. The extra reminder adds upkeep without another duty; those prerequisites and exception remain there.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L150-L156

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI added 3 commits November 12, 2026 05:45
The secondary-package rule already tells the same reader not to break mcpcurl and keeps its lower priority explicit. Another reminder adds upkeep without changing scope; that protection remains in the package overview.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/.github/copilot-instructions.md#L11-L11

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
After duplicate reminders are removed, sequential source labels make the remaining duties easier to reference. This dependent numbering cleanup changes no trigger, prohibition, exception, or validation requirement.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
During a local issue-field read, broad discovery produced no generated command and prompted source inspection. The client decodes the whole schema response before registering commands, so an incompatible schema can block the requested tool.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/cmd/mcpcurl/main.go#L39-L64
https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/cmd/mcpcurl/main.go#L177-L193

Selecting only the requested tool avoids that unrelated schema. Explicit tools suppress default toolsets only when a toolset selection is not also supplied, which is why the recovery replaces the broad selection.

https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/github/server.go#L152-L165
https://github.com/github/github-mcp-server/blob/6fbcd00b2034502ba3001a49dfaf93593aee7069/pkg/inventory/builder.go#L98-L120

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Copilot
Copilot AI requested a review from a team as a code owner November 12, 2026 05:46
Copilot AI adaptive review requested due to automatic review settings November 12, 2026 05:46

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues remain, and the guidance updates align the documented tool-registration, schema, testing, authentication, workflow, and CLI conventions with the current repository.

No open issues 🎉

What changed in this PR

Updates repository guidance so Copilot follows current tool-registration, schema, testing, authentication, workflow, and mcpcurl usage conventions without duplicated or stale instructions.

Changes:

  • Corrects migration guidance for inventory.ServerTool, JSON-schema defaults, and toolsnap updates.
  • Refreshes development instructions for current package paths, test names, mocks, workflows, authentication, and CLI startup behavior.
  • Adds a recovery recipe for isolating a single tool when another schema prevents mcpcurl command generation.
File Description
cmd/​mcpcurl/​README.md Documents using --tools=<tool> to isolate a requested tool during schema recovery.
.github/​copilot-instructions.md Removes stale and duplicate guidance while correcting current repository, workflow, testing, authentication, and startup references.
.github/​agents/​go-sdk-tool-migrator.md Aligns migration instructions with inventory.ServerTool and the SDK’s JSON-schema and snapshot contracts.

Review effort: Lite (auto)

@Copilot

Copilot AI commented Nov 19, 2026

Copy link
Copy Markdown
Author

Closing this older automated guidance proposal in favor of a refreshed proposal against the current repository.

@Copilot Copilot AI closed this Nov 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants