Skip to content

Commit 0cf70eb

Browse files
authored
Remove redundant param for get_me and update contribution guide (#649)
* remove reason param for get_me * updating toolsnap * update contributing * updating tool get_me * add small changes * update snapshots
1 parent 3730b84 commit 0cf70eb

File tree

4 files changed

+15
-20
lines changed

4 files changed

+15
-20
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,21 @@ Please note that this project is released with a [Contributor Code of Conduct](C
1414

1515
These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.
1616

17-
1. install Go [through download](https://go.dev/doc/install) | [through Homebrew](https://formulae.brew.sh/formula/go)
18-
1. [install golangci-lint v2](https://golangci-lint.run/welcome/install/#local-installation)
17+
1. Install Go [through download](https://go.dev/doc/install) | [through Homebrew](https://formulae.brew.sh/formula/go)
18+
2. [Install golangci-lint v2](https://golangci-lint.run/welcome/install/#local-installation)
1919

2020
## Submitting a pull request
2121

2222
1. [Fork][fork] and clone the repository
23-
1. Make sure the tests pass on your machine: `go test -v ./...`
24-
1. Make sure linter passes on your machine: `golangci-lint run`
25-
1. Create a new branch: `git checkout -b my-branch-name`
26-
1. Make your change, add tests, and make sure the tests and linter still pass
27-
1. Push to your fork and [submit a pull request][pr] targeting the `main` branch
28-
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
23+
2. Make sure the tests pass on your machine: `go test -v ./...`
24+
3. Make sure linter passes on your machine: `golangci-lint run`
25+
4. Create a new branch: `git checkout -b my-branch-name`
26+
5. Add your changes and tests, and make sure the Action workflows still pass
27+
- Run linter: `script/lint`
28+
- Update snapshots and run tests: `UPDATE_TOOLSNAPS=true go test ./...`
29+
- Update readme documentation: `script/generate-docs`
30+
6. Push to your fork and [submit a pull request][pr] targeting the `main` branch
31+
7. Pat yourself on the back and wait for your pull request to be reviewed and merged.
2932

3033
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
3134

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -550,7 +550,7 @@ export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description
550550
<summary>Context</summary>
551551

552552
- **get_me** - Get my user profile
553-
- `reason`: Optional: the reason for requesting the user information (string, optional)
553+
- No parameters required
554554

555555
</details>
556556

pkg/github/__toolsnaps__/get_me.snap

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,9 @@
33
"title": "Get my user profile",
44
"readOnlyHint": true
55
},
6-
"description": "Get details of the authenticated GitHub user. Use this when a request includes \"me\", \"my\". The output will not change unless the user changes their profile, so only call this once.",
6+
"description": "Get details of the authenticated GitHub user. Use this when a request is about the user's own profile for GitHub. Or when information is missing to build other tool calls.",
77
"inputSchema": {
8-
"properties": {
9-
"reason": {
10-
"description": "Optional: the reason for requesting the user information",
11-
"type": "string"
12-
}
13-
},
8+
"properties": {},
149
"type": "object"
1510
},
1611
"name": "get_me"

pkg/github/context_tools.go

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,11 @@ type UserDetails struct {
3535
// GetMe creates a tool to get details of the authenticated user.
3636
func GetMe(getClient GetClientFn, t translations.TranslationHelperFunc) (mcp.Tool, server.ToolHandlerFunc) {
3737
tool := mcp.NewTool("get_me",
38-
mcp.WithDescription(t("TOOL_GET_ME_DESCRIPTION", "Get details of the authenticated GitHub user. Use this when a request includes \"me\", \"my\". The output will not change unless the user changes their profile, so only call this once.")),
38+
mcp.WithDescription(t("TOOL_GET_ME_DESCRIPTION", "Get details of the authenticated GitHub user. Use this when a request is about the user's own profile for GitHub. Or when information is missing to build other tool calls.")),
3939
mcp.WithToolAnnotation(mcp.ToolAnnotation{
4040
Title: t("TOOL_GET_ME_USER_TITLE", "Get my user profile"),
4141
ReadOnlyHint: ToBoolPtr(true),
4242
}),
43-
mcp.WithString("reason",
44-
mcp.Description("Optional: the reason for requesting the user information"),
45-
),
4643
)
4744

4845
type args struct{}

0 commit comments

Comments
 (0)