docs: provider management API (v1.8.0) + MCP provider_* tools - #11
Merged
Conversation
…_* tools Add the 7 /provider/* endpoints to the openapi under a new Provider tag (plans, plan methods, node status, HTTP/WS node upsert, node status set), with request/response schemas extracted from api/provider source at v1.8.0. Add a Provider tools section to intro/mcp-server.mdx describing the provider_* MCP tools (registered when ROUTEMESH_MGMT_TOKEN is set and the token's customer is linked to a provider) and the node-screening guardrails. Covers api-server v1.8.0 (DREAM-682..689) and routemesh-mcp @5285991.
Kody Review CompleteGreat news! 🎉 Keep up the excellent work! 🚀 Kody Guide: Usage and ConfigurationInteracting with Kody
Current Kody ConfigurationReview OptionsThe following review options are enabled or disabled:
|
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.
Description
This PR updates the Mintlify documentation to document the provider-scoped management surface introduced by the v1.8.0 provider management API and its corresponding MCP
provider_*tools. The change is documentation-only: it makes the new provider tools discoverable, clarifies when they are exposed, and documents their authorization, validation, and error behavior.What changed
The provided patch modifies
intro/mcp-server.mdxto document the provider MCP tool surface.Adds a
Provider toolssectionA new section documents seven provider tools and maps each tool to its corresponding provider API endpoint:
provider_list_plansGET /provider/plansprovider_get_plan_methodsGET /provider/plans/:planId/methodsprovider_get_node_statusGET /provider/nodes/:nodeId/statusprovider_upsert_plan_methodsPOST /provider/plans/:planId/methodsprovider_upsert_nodePUT /provider/nodesprovider_upsert_ws_nodePUT /provider/nodes/wsprovider_set_node_statusPOST /provider/nodes/statusThe section also documents the expected response shape for
provider_get_node_status:and the documented node status values:
healthydisabled by providerprovider-deletedClarifies provider tool activation
The docs now state that provider tools are exposed only when:
ROUTEMESH_MGMT_TOKENis set, andThis makes explicit that setting the management token alone is not sufficient; the token’s customer must have a provider relationship for the
provider_*tools to appear.Documents provider authentication and scoping
The new section explains that the provider tools authenticate using the same management token, sent in the
X-Api-Keyheader, and that provider resources are scoped to the provider associated with that token.It also documents the provider authorization semantics:
403 provider not resolved.404, so resource existence is not leaked.This gives MCP clients and provider operators a clear contract for expected failure modes.
Documents node screening behavior
The patch adds explicit guardrails for node upserts:
http(s)endpoints.wss://endpoints.eth_subscribe("newHeads"), with the server dialing to verify.The docs also document the related error behavior:
400.404.409.This clarifies the validation boundary for provider node registration and helps prevent accidental or unsafe endpoint configuration.
Updates token documentation
The
ROUTEMESH_MGMT_TOKENenvironment variable table row is updated to state that, when set, the MCP server exposes:The token-scoping note is also updated. Previously it described customer management tokens as scoped only to customer management routes. The updated note says the token is scoped to:
This is a meaningful clarification for least-privilege token usage and token revocation.
Functional impact
There are no runtime code changes in the provided diff. The functional impact is documentation clarity and operational safety:
provider_*MCP tools.Technical context and added clarity
Several details in the patch reinforce the intended provider management model:
403for missing provider linkage and404for cross-provider resource access.