Skip to content

Commit 26f918e

Browse files
update README.md to explain i18n
1 parent 4833cfd commit 26f918e

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,36 @@ GitHub MCP Server running on stdio
267267
268268
```
269269
270+
## i18n / Overriding descriptions
271+
272+
The descriptions of the tools can be overridden by creating a github-mcp-server.json file in the same directory as the binary.
273+
The file should contain a JSON object with the tool names as keys and the new descriptions as values.
274+
For example:
275+
276+
```json
277+
{
278+
"TOOL_ADD_ISSUE_COMMENT_DESCRIPTION": "an alternative description",
279+
"TOOL_CREATE_BRANCH_DESCRIPTION": "Create a new branch in a GitHub repository"
280+
}
281+
```
282+
283+
You can create an export of the current translations by running the binary with the `--export-translations` flag.
284+
This flag will preserve any translations/overrides you have made, while adding any new translations that have been added to the binary since the last time you exported.
285+
286+
```sh
287+
./github-mcp-server --export-translations
288+
cat github-mcp-server.json
289+
```
290+
291+
You can also use ENV vars to override the descriptions. The environment variable names are the same as the keys in the JSON file,
292+
prefixed with `GITHUB_MCP_` and all uppercase.
293+
294+
For example, to override the `TOOL_ADD_ISSUE_COMMENT_DESCRIPTION` tool, you can set the following environment variable:
295+
296+
```sh
297+
export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description"
298+
```
299+
270300
## Testing on VS Code Insiders
271301
272302
First of all, install `github-mcp-server` with:

0 commit comments

Comments
 (0)