Skip to content

docs(mcp): document pinning server_id on config.yaml MCP servers - #1119

Merged
yucheng-berri merged 5 commits into
mainfrom
mcp_config_server_id_docs
Sep 5, 2026
Merged

docs(mcp): document pinning server_id on config.yaml MCP servers#1119
yucheng-berri merged 5 commits into
mainfrom
mcp_config_server_id_docs

Conversation

@yucheng-berri

@yucheng-berri yucheng-berri commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Documents the optional server_id field added in BerriAI/litellm#39286.

A config-defined MCP server's id is derived by hashing its server_name, url, transport, auth_type and alias, 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 from tools/list with 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 from GET /v1/mcp/server and 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_name or alias), 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 under LITELLM_USE_SHORT_MCP_TOOL_PREFIX is derived from the server id.

Resolves LIT-5055


Devin Review

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.
@vercel

vercel Bot commented Sep 2, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
litellm Ready Ready Preview Sep 5, 2026 7:10am UTC

Request Review

devin-ai-integration[bot]

This comment was marked as resolved.

devin-ai-integration[bot]

This comment was marked as resolved.

devin-ai-integration[bot]

This comment was marked as resolved.

@yucheng-berri
yucheng-berri enabled auto-merge (squash) September 5, 2026 07:08
@yucheng-berri
yucheng-berri merged commit 645885e into main Sep 5, 2026
5 checks passed
@yucheng-berri
yucheng-berri deleted the mcp_config_server_id_docs branch September 5, 2026 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant