From ad21803dbf5dff1a9f1110a92b2368d061530014 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 14 Mar 2026 00:06:03 +0000 Subject: [PATCH] docs: condense tools.md Registry Field section and trim Related Documentation Remove verbose "When to use" bullets, duplicate example, and redundant closing sentence from Registry Field. Trim Related Documentation from 11 to 8 items by removing CLI, Workflow Structure, and Imports links that are less directly relevant to the Tools overview page. Co-Authored-By: Claude Sonnet 4.6 --- docs/src/content/docs/reference/tools.md | 32 +----------------------- 1 file changed, 1 insertion(+), 31 deletions(-) diff --git a/docs/src/content/docs/reference/tools.md b/docs/src/content/docs/reference/tools.md index d32f566cec..70b1e3a188 100644 --- a/docs/src/content/docs/reference/tools.md +++ b/docs/src/content/docs/reference/tools.md @@ -131,43 +131,16 @@ mcp-servers: ### Registry Field -The `registry` field specifies the URI to an MCP server's installation location in an MCP registry. This is useful for documenting the source of an MCP server and can be used by tooling to discover and install MCP servers: +The `registry` field specifies the source URI of an MCP server in a registry. It is informational — useful for documenting server origin and enabling registry-aware tooling — and does not affect execution. Works with both stdio and HTTP servers: ```yaml wrap -mcp-servers: - markitdown: - registry: "https://api.mcp.github.com/v0/servers/microsoft/markitdown" - command: "npx" - args: ["-y", "@microsoft/markitdown"] -``` - -**When to use**: - -- **Document server source**: Include `registry` to indicate where the MCP server is published -- **Registry-aware tooling**: Some tools may use the registry URI for discovery and version management -- **Both stdio and HTTP servers**: Works with both `command`-based stdio servers and `url`-based HTTP servers - -**Examples**: - -```yaml wrap -# Stdio server with registry mcp-servers: filesystem: registry: "https://api.mcp.github.com/v0/servers/modelcontextprotocol/filesystem" command: "npx" args: ["-y", "@modelcontextprotocol/server-filesystem"] - -# HTTP server with registry -mcp-servers: - custom-api: - registry: "https://registry.example.com/servers/custom-api" - url: "https://api.example.com/mcp" - headers: - Authorization: "Bearer ${{ secrets.API_TOKEN }}" ``` -The `registry` field is informational and does not affect server execution. It complements other configuration fields like `command`, `args`, `container`, or `url`. - ## Related Documentation - [GitHub Tools](/gh-aw/reference/github-tools/) - GitHub API operations, toolsets, and modes @@ -178,6 +151,3 @@ The `registry` field is informational and does not affect server execution. It c - [Frontmatter](/gh-aw/reference/frontmatter/) - All frontmatter configuration options - [Network Permissions](/gh-aw/reference/network/) - Network access control for AI engines - [MCPs](/gh-aw/guides/mcps/) - Complete Model Context Protocol setup and usage -- [CLI Commands](/gh-aw/setup/cli/) - CLI commands for workflow management -- [Workflow Structure](/gh-aw/reference/workflow-structure/) - Directory layout and organization -- [Imports](/gh-aw/reference/imports/) - Modularizing workflows with includes