-
Notifications
You must be signed in to change notification settings - Fork 50
Closed
Labels
Description
Objective
Add documentation for the registry MCP property in user-facing guides.
Context
From discussion #11706: The registry field is implemented (pkg/parser/mcp.go:86), tested (mcp_config_compilation_test.go), and compiled correctly, but has NO end-user documentation. Users need to know this field exists and how to use it.
Approach
Add documentation for the registry field to relevant docs:
docs/reference/tools.md- Add to MCP configuration referencedocs/reference/mcp-gateway.md- Include in MCP server setup examples
Include:
- Field purpose: URI to installation location from MCP registry
- Example usage:
registry: "https://api.mcp.github.com/v0/servers/microsoft/markitdown" - When to use vs other installation methods
Files to Modify
docs/reference/tools.md- Add registry field documentationdocs/reference/mcp-gateway.md- Add registry examples
Acceptance Criteria
- registry field documented in tools.md reference
- Example usage included in mcp-gateway.md
- Clear explanation of when to use registry vs other methods
- Consistent with existing documentation style
- Examples tested to ensure correctness
AI generated by Plan Command for discussion #11706
Reactions are currently unavailable