docs(api): document v1 MCP servers listing endpoint#37
Conversation
Documents GET /api/v1/mogplex/mcp/servers (shipped in mogplex#543) as a dedicated reference page distinct from the JSON-RPC POST /api/v1/mogplex/mcp endpoint, since they're often confused. - New content/docs/web/api/mcp-servers.mdx — full reference + security notes - route-families.mdx — adds the new route to the v1 surface list - mcp.mdx — cross-link callout disambiguating the two MCP endpoints - index.mdx — adds it to the read-in-order list and updates the safe-first request from the legacy /api/mcp-servers?format=cli to the v1 path - meta.json — sidebar nav Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![mogplex[bot]](https://avatars.githubusercontent.com/in/3107927?s=60&v=4){kind=small}
There was a problem hiding this comment.
Mogplex PR Review
Status: Attention needed
Well-structured docs PR that correctly disambiguates two easily-confused endpoints with cross-link callouts in both directions, sidebar ordering, and index updates. One correctness gap in the response example could mislead API consumers, and there is a minor phrasing inheritance issue in index.mdx. Small fix needed before merge.
2 findings were added inline.
|
|
||
| ```typescript | ||
| type MogplexApiMcpServer = { | ||
| name: string; // unique per user |
There was a problem hiding this comment.
Warning: Response example contradicts the documented disabled-server behavior
The type comment on enabled reads // disabled servers are still returned, which is an important behavioral contract. However, the JSON response example only shows entries with "enabled": true. A reader using the example as their mental model will naturally conclude disabled servers are filtered out — directly contradicting the comment.
Suggestion: Add a third server entry with "enabled": false to the response example, or add a sentence immediately after the JSON block: "Servers configured but not enabled appear in the list with "enabled": false." Either approach closes the gap between the type comment and the example.
| - `GET /api/models` to inspect the visible catalog and enabled model set | ||
| - `GET /api/github/installations` to confirm real GitHub App coverage | ||
| - `GET /api/mcp-servers?format=cli` to export the CLI-ready MCP view | ||
| - `GET /api/v1/mogplex/mcp/servers` to export the CLI-ready MCP view (PAT-only) |
There was a problem hiding this comment.
Suggestion: "export" verb in index.mdx inherited from the old CLI-specific path
The updated line reads: GET /api/v1/mogplex/mcp/servers to export the CLI-ready MCP view (PAT-only). The verb "export" and the phrase "CLI-ready" were carried over from the old /api/mcp-servers?format=cli entry, which was explicitly a CLI export format. The v1 endpoint is a general listing — the CLI just happens to consume it. Consider: GET /api/v1/mogplex/mcp/servers to list configured MCP servers with secrets resolved (PAT-only). This matches the description on the new reference page and sets accurate expectations for non-CLI callers.
1 participant
Summary
web/api/mcp-servers.mdxreference page forGET /api/v1/mogplex/mcp/servers(shipped in mogplex#543 and consumed by mogplex-cli#46)./api/v1/mogplex/mcp(JSON-RPC tool-call endpoint) with cross-link callouts both directions — users were going to confuse them.route-families.mdx,index.mdx, and the sidebarmeta.jsonto surface the new page. Swaps the stale/api/mcp-servers?format=cliexample in the "safe first requests" list for the v1 path.Test plan
pnpm types:check— MDX generates, route types pass, tsc clean/web/api/mcp-servers,/web/api/mcp,/web/api/authentication, etc.)🤖 Generated with Claude Code
Need help on this PR? Tag
@codesmithwith what you need.