Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 25, 2026

The registry field exists in MCP server configuration (implemented in pkg/parser/mcp.go:89, tested in mcp_config_compilation_test.go) but lacked user-facing documentation.

Changes

docs/src/content/docs/reference/tools.md

  • Added registry to MCP server options list
  • Created "Registry Field" section with purpose, usage guidance, and examples for both stdio and HTTP servers

docs/src/content/docs/reference/mcp-gateway.md

  • Added registry to Server Configuration Fields table (Section 4.1.2)
  • Added Appendix A.5 with JSON examples demonstrating registry usage

Example

mcp-servers:
  markitdown:
    registry: "https://api.mcp.github.com/v0/servers/microsoft/markitdown"
    command: "npx"
    args: ["-y", "@microsoft/markitdown"]

The field is informational—used for documentation and tooling discovery, does not affect server execution. Applies to both stdio and HTTP transport types.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.13.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>[plan] Document registry field in user-facing documentation</issue_title>
<issue_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:

  1. docs/reference/tools.md - Add to MCP configuration reference
  2. docs/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 documentation
  • docs/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

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for registry field in user-facing guides Document registry field for MCP server configuration Jan 25, 2026
Copilot AI requested a review from pelikhan January 25, 2026 01:26
Copy link
Contributor

@pelikhan pelikhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot simplify docs

@pelikhan pelikhan marked this pull request as ready for review January 25, 2026 05:34
@pelikhan pelikhan merged commit e96e7b1 into main Jan 25, 2026
69 of 70 checks passed
@pelikhan pelikhan deleted the copilot/add-registry-field-documentation branch January 25, 2026 05:34
Copilot AI requested a review from pelikhan January 25, 2026 05:35
Copilot stopped work on behalf of pelikhan due to an error January 25, 2026 05:35
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.

[plan] Document registry field in user-facing documentation

2 participants