Add docs for resource indicator #284
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the resource indicator feature (RFC 8707) when authenticating to remote MCP servers. The new section explains how ToolHive handles resource indicators for OAuth token requests.
- Adds a new section explaining RFC 8707 resource indicator support
- Documents default behavior (automatic use of server URL as resource indicator)
- Provides example of overriding the resource indicator with
--remote-auth-resourceflag
| thv run https://api.example.com/mcp \ | ||
| ... \ | ||
| --remote-auth-resource https://api.example.com |
There was a problem hiding this comment.
The ellipsis (...) placeholder in the command example should be replaced with actual flag examples or removed. Per the writing style guide, examples should be practical and real-world. Consider showing a complete example with the other authentication flags mentioned earlier in the document (like --remote-auth-issuer, --remote-auth-client-id).
There was a problem hiding this comment.
Ignoring this suggestion, since the current format aligns with the examples for custom authentication timeout, skip browser auth, and custom scopes
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Description
Document
--remote-resource-indicatorflag which can be used when running remote MCP servers.Related issues/PRs
stacklok/toolhive#2497
Screenshots
Merge checklist
Content
sidebars.ts) updated for added, deleted, reordered, or renamed filesvercel.jsonfor moved, renamed, or deleted pages (i.e., if the URL slug changed)Reviews