Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/agents/go-sdk-tool-migrator.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When generating the migration guide, consider the following aspects:

* The initial tool file and its corresponding test file will have the `//go:build ignore` build tag, as the tests will fail if the code is not ignored. The `ignore` build tag should be removed before work begins.
* The import for `github.com/mark3labs/mcp-go/mcp` should be changed to `github.com/modelcontextprotocol/go-sdk/mcp`
* The return type for the tool constructor function should be updated from `mcp.Tool, server.ToolHandlerFunc` to `(mcp.Tool, mcp.ToolHandlerFor[map[string]any, any])`.
* The return type for the tool constructor function should be updated from `mcp.Tool, server.ToolHandlerFunc` to `inventory.ServerTool`.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Return a registrable tool: The old tuple cannot be placed in the server-tool registry. The current constructor returns inventory.ServerTool; compatible generic-map handlers remain possible.

* The tool handler function signature should be updated to use generics, changing from `func(ctx context.Context, mcp.CallToolRequest) (*mcp.CallToolResult, error)` to `func(context.Context, *mcp.CallToolRequest, map[string]any) (*mcp.CallToolResult, any, error)`.
* The `RequiredParam`, `RequiredInt`, `RequiredBigInt`, `OptionalParamOK`, `OptionalParam`, `OptionalIntParam`, `OptionalIntParamWithDefault`, `OptionalBoolParamWithDefault`, `OptionalStringArrayParam`, `OptionalBigIntArrayParam` and `OptionalCursorPaginationParams` functions should be changed to use the tool arguments that are now passed as a map in the tool handler function, rather than extracting them from the `mcp.CallToolRequest`.
* `mcp.NewToolResultText`, `mcp.NewToolResultError`, `mcp.NewToolResultErrorFromErr` and `mcp.NewToolResultResource` no longer available in `modelcontextprotocol/go-sdk`. There are a few helper functions available in `pkg/utils/result.go` that can be used to replace these, in the `utils` package.
Expand Down Expand Up @@ -60,11 +60,11 @@ return mcp.NewTool(
...
```

The corresponding input schema in modelcontextprotocol/go-sdk would look like this:
The corresponding schema-bearing `mcp.Tool` component would look like this:

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Separate the schema from the constructor: The current constructor wraps an mcp.Tool component rather than returning that component alone. The illustration now identifies only that component, consistent with the repaired constructor type.


```go
...
return mcp.Tool{
mcp.Tool{

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Avoid returning the wrong value: The registry consumes server tools, not bare mcp.Tool values. Removing return keeps this a component illustration instead of a contradictory constructor body.

Name: "list_dependabot_alerts",
Description: t("TOOL_LIST_DEPENDABOT_ALERTS_DESCRIPTION", "List dependabot alerts in a GitHub repository."),
Annotations: &mcp.ToolAnnotations{
Expand All @@ -86,7 +86,7 @@ return mcp.Tool{
Type: "string",
Description: "Filter dependabot alerts by state. Defaults to open",
Enum: []any{"open", "fixed", "dismissed", "auto_dismissed"},
Default: "open",
Default: json.RawMessage(`"open"`),

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Use a copyable JSON default: The same state default in the actual tool is JSON-encoded bytes, not a Go string. The value, enums and required fields remain unchanged.

},
"severity": {
Type: "string",
Expand All @@ -103,7 +103,7 @@ return mcp.Tool{

After migrating the tool code and test file, ensure that all tests pass successfully. If any tests fail, review the error messages and adjust the migrated code as necessary to resolve any issues. If you encounter any challenges or need further assistance during the migration process, please let me know.

At the end of your changes, you will continue to have an issue with the `toolsnaps` tests, these validate that the schema has not changed unexpectedly. You can update the snapshots by setting `UPDATE_TOOLSNAPS=true` before running the tests, e.g.:
You can update the snapshots by setting `UPDATE_TOOLSNAPS=true` before running the tests, e.g.:

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Do not assume every migration breaks snapshots: The snapshot comparison reports whether a mismatch actually exists. The update command and intentional-change safeguard remain, without predicting a failure.


```bash
UPDATE_TOOLSNAPS=true go test ./...
Expand Down
45 changes: 14 additions & 31 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,12 @@ This is the **GitHub MCP Server**, a Model Context Protocol (MCP) server that co
**Key Details:**
- **Language:** Go 1.27.3+ (~38k lines of code)
- **Type:** MCP server application with CLI interface
- **Primary Package:** github-mcp-server (stdio MCP server - **this is the main focus**)

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Primary focus stays explicit: The same local-server work and testing priority remains in the primary-focus reminder; removing this copy does not broaden the task audience.

- **Secondary Package:** mcpcurl (testing utility - don't break it, but not the priority)
- **Framework:** Uses modelcontextprotocol/go-sdk for MCP protocol, google/go-github for GitHub API
- **Size:** ~60MB repository, 70 Go files

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Avoid a misleading size shortcut: The fixed file count understates the tracked Go inventory. It is removed rather than replaced with another snapshot; actual tool registration remains the guide to that work.

- **Library Usage:** This repository is also used as a library by the remote server. Functions that could be called by other repositories should be exported (capitalized), even if not required internally. Preserve existing export patterns.

**Code Quality Standards:**
- **Popular Open Source Repository** - High bar for code quality and clarity
- **Comprehension First** - Code must be clear to a wide audience

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Clarity rule stays covered: The more complete clarity rule still requires code a wide audience can understand; this removal drops only a repeated mandate.

- **Clean Commits** - Atomic, focused changes with clear messages
- **Structure** - Always maintain or improve, never degrade
- **Code over Comments** - Prefer self-documenting code; comment only when necessary
Expand Down Expand Up @@ -71,7 +68,7 @@ go test ./pkg/github -run TestGetMe
├── pkg/ # Public API packages
│ ├── github/ # GitHub API MCP tools implementation
│ │ └── __toolsnaps__/ # Tool schema snapshots (*.snap files)
│ ├── toolsets/ # Toolset configuration & management
│ ├── inventory/ # Toolset configuration & management

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Find toolset configuration: The old directory name points to a missing package. The inventory builder owns toolset configuration, so the tree now points there.

│ ├── errors/ # Error handling utilities
│ ├── sanitize/ # HTML/content sanitization
│ ├── log/ # Logging utilities
Expand All @@ -97,41 +94,38 @@ go test ./pkg/github -run TestGetMe
- **Dockerfile:** Multi-stage build (golang:1.27.3-alpine → distroless)
- **server.json:** MCP server metadata for registry
- **.goreleaser.yaml:** Release automation config
- **.gitignore:** Excludes bin/, dist/, vendor/, *.DS_Store, github-mcp-server binary
- **.gitignore:** Excludes bin/, dist/, vendor/, .DS_Store, github-mcp-server binary

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Match staging expectations: The old wildcard suggests a broader pattern than the actual ignore entry. Other listed exclusions stay unchanged.


### Important Scripts (script/ directory)

- **script/lint** - Runs `gofmt` + `golangci-lint`. **MUST RUN** before committing

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Lint remains mandatory: The required pre-commit sequence still requires this exact formatting-and-lint script; the duplicate run mandate is removed.

- **script/test** - Runs `go test -race ./...` (full test suite)
- **script/generate-docs** - Updates README.md tool documentation. Run after tool changes

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Tool documentation stays required: The required-command rule already covers tool and toolset changes, and the tool-change recipe keeps the README update step.

- **script/licenses** - Updates third-party license files when dependencies change
- **script/licenses-check** - Validates license compliance (runs in CI)
- **script/get-me** - Quick test script for get_me tool
- **script/get-discussions** - Quick test for discussions
- **script/tag-release** - **NEVER USE THIS** - releases are managed separately

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Release prohibition stays stronger: The surviving release rule still forbids both the release script and tag pushes; no release action is newly permitted.


## GitHub Workflows (CI/CD)

All workflows run on push/PR unless noted. Located in `.github/workflows/`:
Located in `.github/workflows/`:

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Do not expect release checks on every PR: The blanket push/PR description is contradicted by the tag-only release trigger. This removes that event claim, not the separate pre-merge policy.


1. **go.yml** - Build and test on ubuntu/windows/macos. Runs `script/test` and builds binary
2. **lint.yml** - Runs golangci-lint-action v2.5 (GitHub Action) with actions/setup-go stable
2. **lint.yml** - Runs golangci-lint-action v9 (GitHub Action) with actions/setup-go using go.mod

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Follow the configured lint setup: The old action version and stable-Go description disagree with the owning workflow, which uses action v9 and selects Go from go.mod.

3. **docs-check.yml** - Verifies README.md is up-to-date by running generate-docs and checking git diff
4. **code-scanning.yml** - CodeQL security analysis for Go and GitHub Actions
5. **license-check.yml** - Runs `script/licenses-check` to validate compliance
6. **docker-publish.yml** - Publishes container image to ghcr.io
7. **goreleaser.yml** - Creates releases (main branch only)
7. **goreleaser.yml** - Creates releases (`v*` tags)

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Distinguish release tags from branches: The release workflow is selected by v-prefixed tags, not a main-branch condition. The prohibition on creating releases remains elsewhere.

8. **registry-releaser.yml** - Updates MCP registry

**All of these must pass for PR merge.** If docs-check fails, run `script/generate-docs` and commit changes.
**All of these must pass for PR merge.**

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Documentation recovery stays available: The documentation-failure recipe still says to regenerate and commit the README. Only its repeated sentence is removed; the original pre-merge policy is retained.


## Testing Guidelines

### Unit Tests

- Use `testify` for assertions (`require` for critical checks, `assert` for non-blocking)
- Tests are in `*_test.go` files alongside implementation (internal tests, not `_test` package)
- Mock GitHub API with `go-github-mock` (REST) or `githubv4mock` (GraphQL)
- Tests are in `*_test.go` files alongside implementation

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Do not rule out supported external tests: A current unit-test package uses the external package form. The file-naming and alongside-implementation guidance remains, without the contradicted categorical aside.

- Mock GitHub API with `MockHTTPClientWithHandlers` (REST) or `githubv4mock` (GraphQL)

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Use the repository REST mock: The old library was replaced by the in-repository HTTP helper. The GraphQL helper remains unchanged.

- Test structure for tools:
1. Test tool snapshot
2. Verify critical schema properties (e.g., ReadOnly annotation)
Expand Down Expand Up @@ -175,20 +169,16 @@ All workflows run on push/PR unless noted. Located in `.github/workflows/`:

- **Keep changes minimal and focused** on the specific issue being addressed
- **Prefer clarity over cleverness** - code must be understandable by a wide audience
- **Atomic commits** - each commit should be a complete, logical change

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Atomic commits stay required: The clean-commit rule already requires atomic, focused changes with clear messages, so the repeated commit mandate adds no separate action.

- **Maintain or improve structure** - never degrade code organization

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Structure protection stays covered: The existing structure rule retains the same maintain-or-improve requirement and prohibition on degrading organization.

- Use table-driven tests for behavioral testing
- Comment sparingly - code should be self-documenting

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Comment restraint stays covered: The self-documenting-code rule already limits comments to necessary cases; removing this duplicate does not loosen that rule.

- Follow standard Go conventions (Effective Go, Go proverbs)
- **Test changes thoroughly** before committing
- Export functions (capitalize) if they could be used by other repos as a library

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Library exports stay required: The library-usage rule preserves conditional exports even without internal callers and additionally protects existing export patterns.


## Common Development Workflows

### Adding a New MCP Tool

1. Add tool implementation in `pkg/github/` (e.g., `foo_tools.go`)
2. Register tool in appropriate toolset in `pkg/github/` or `pkg/toolsets/`
2. Register tool in appropriate toolset in `pkg/github/`

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Register tools at an existing owner: The removed package alternative is missing. The constructor registry supports the retained pkg/github route; registration is still required.

3. Write unit tests following the tool test pattern
4. Run `UPDATE_TOOLSNAPS=true go test ./...` to create snapshot
5. Run `script/generate-docs` to update README
Expand Down Expand Up @@ -239,7 +229,6 @@ All workflows run on push/PR unless noted. Located in `.github/workflows/`:

## Environment Variables

- **GITHUB_PERSONAL_ACCESS_TOKEN** - Required for server operation and e2e tests

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Do not require the wrong token: The server accepts App or OAuth authentication, so this universal personal-token prerequisite is false. The dedicated e2e token input remains documented.

- **GITHUB_HOST** - For GitHub Enterprise Server (prefix with `https://`)
- **GITHUB_TOOLSETS** - Comma-separated toolset list (overrides --toolsets flag)
- **GITHUB_READ_ONLY** - Set to "1" for read-only mode
Expand Down Expand Up @@ -270,22 +259,16 @@ server.json - MCP server registry metadata
### Main Entry Point

`cmd/github-mcp-server/main.go` - Uses cobra for CLI, viper for config, supports:
- `stdio` command (default) - MCP stdio transport
- `stdio` command - MCP stdio transport

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Invoke stdio explicitly: The root command and stdio subcommand are distinct; the root has no default server handler. Only the default qualifier is removed, not the stdio command.

- `generate-docs` command - Documentation generation
- Flags: --toolsets, --read-only, --gh-host, --log-file

## Important Reminders

1. **PRIMARY FOCUS:** The local stdio MCP server (github-mcp-server) - this is what you should work on and test with
2. **REMOTE SERVER:** Ignore remote server instructions when making code changes (unless specifically asked). This repo is used as a library by the remote server, so keep functions exported (capitalized) if they could be called by other repos, even if not needed internally.
2. **REMOTE SERVER:** Ignore remote server instructions when making code changes (unless specifically asked).

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🛠️ Keep the remote exception and export duty: The explicit-request exception remains here. The removed export sentence is already fully covered by the library-usage rule, including exports unused internally.

3. **ALWAYS** trust these instructions first - only search if information is incomplete or incorrect
4. **NEVER** use `script/tag-release` or push tags
5. **NEVER** skip `script/lint` before committing Go code changes

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Pre-commit lint stays required: The required-command sequence already covers Go commits and names the exact script; deleting this reminder does not permit skipping lint.

6. **ALWAYS** update toolsnaps when changing MCP tool schemas

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Schema snapshots stay required: The intentional-change update rule and tool-change recipe retain both generation and commit duties.

7. **ALWAYS** run `script/generate-docs` after modifying tools

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Generated docs stay required: The required-command rule already covers tools and toolsets; this removes only the narrower repeated reminder.

8. For specific test files, use `go test ./path -run TestName` not full suite
9. E2E tests require PAT token - you likely cannot run them

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Live-test prerequisite stays explicit: The e2e prerequisite and invocation retain the token requirement, warning and dedicated variable name.

10. Toolsnaps are API documentation - treat changes seriously
11. Build/test/lint are very fast (~1s each) - run frequently
12. CI failures for docs-check or license-check have simple fixes (run the script)

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 Concrete recovery steps stay available: The documentation recovery and license recovery already cover both failure triggers with their exact scripts.

13. mcpcurl is secondary - don't break it, but it's not the priority

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

🧹 The testing utility stays protected: The secondary-package rule still says not to break mcpcurl and keeps its lower priority.

5. For specific test files, use `go test ./path -run TestName` not full suite
6. Toolsnaps are API documentation - treat changes seriously
7. Build/test/lint are very fast (~1s each) - run frequently
Loading