diff --git a/cmd/github-mcp-server/generate_docs.go b/cmd/github-mcp-server/generate_docs.go index a206c9c7e..b3f755846 100644 --- a/cmd/github-mcp-server/generate_docs.go +++ b/cmd/github-mcp-server/generate_docs.go @@ -36,7 +36,7 @@ func generateAllDocs() error { // File to edit, function to generate its docs {"README.md", generateReadmeDocs}, {"docs/remote-server.md", generateRemoteServerDocs}, - {"docs/deprecated-tool-aliases.md", generateDeprecatedAliasesDocs}, + {"docs/tool-renaming.md", generateDeprecatedAliasesDocs}, } { if err := doc.fn(doc.path); err != nil { return fmt.Errorf("failed to generate docs for %s: %w", doc.path, err) diff --git a/docs/deprecated-tool-aliases.md b/docs/deprecated-tool-aliases.md deleted file mode 100644 index 6ea2ba1de..000000000 --- a/docs/deprecated-tool-aliases.md +++ /dev/null @@ -1,31 +0,0 @@ -# Deprecated Tool Aliases - -This document tracks tool renames in the GitHub MCP Server. When tools are renamed, the old names are preserved as aliases for backward compatibility. Using a deprecated alias will still work, but clients should migrate to the new canonical name. - -## Current Deprecations - - -| Old Name | New Name | -|----------|----------| -| *(none currently)* | | - - -## How It Works - -When a tool is renamed: - -1. The old name is added to `DeprecatedToolAliases` in [pkg/github/deprecated_tool_aliases.go](../pkg/github/deprecated_tool_aliases.go) -2. Clients using the old name will receive the new tool -3. A deprecation notice is logged when the alias is used - -## For Developers - -To deprecate a tool name when renaming: - -```go -var DeprecatedToolAliases = map[string]string{ - "old_tool_name": "new_tool_name", -} -``` - -The alias resolution happens at server startup, ensuring backward compatibility for existing client configurations. diff --git a/docs/tool-renaming.md b/docs/tool-renaming.md index cd1bca5c6..66d3ff410 100644 --- a/docs/tool-renaming.md +++ b/docs/tool-renaming.md @@ -40,3 +40,11 @@ A user with this configuration: ``` Will get `issue_read` and `get_file_contents` tools registered, with no errors. + +## Current Deprecations + + +| Old Name | New Name | +|----------|----------| +| *(none currently)* | | +