docs(mcp): document pinning server_id on config.yaml MCP servers - #1119
Merged
Conversation
A config-defined MCP server's id is derived from its connection fields, so editing the url, name, transport, auth type or alias mints a new id and every key or team grant holding the old one silently stops matching. Document the new optional server_id field, the recipe for adopting it on a server that already has grants, and the rules: non-empty string, no duplicate pins, no pin that is another entry's name or alias, what happens when a pin collides with a database-backed server, and the effect on the short tool prefix.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the optional
server_idfield added in BerriAI/litellm#39286.A config-defined MCP server's id is derived by hashing its
server_name,url,transport,auth_typeandalias, so editing any of those mints a new id and every key or team grant holding the old one silently stops matching; the server just disappears fromtools/listwith nothing logged. The new section explains that, shows how to pin the id, and gives the recipe for adopting it on a server that already has grants (read the current id fromGET /v1/mcp/serverand pin that exact value, so the ids already stored in permissions stay valid).The Rules list covers what fails config load (a blank or non-string value, two entries sharing an id, a pin that is another entry's
server_nameoralias), what does not fail config load but is still wrong (a pin already held by a database-backed server: config.yaml is read before the database, so you get a WARNING and the database row wins), and the one behavior change worth knowing about, which is that the short tool prefix underLITELLM_USE_SHORT_MCP_TOOL_PREFIXis derived from the server id.Resolves LIT-5055