Skip to content

Commit 75a4e90

Browse files
committed
tweak docs
1 parent 3bea091 commit 75a4e90

3 files changed

Lines changed: 8 additions & 4 deletions

File tree

docs/src/content/docs/guides/mcps.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
title: MCP Guide
2+
title: Using MCPs
33
description: Learn how to use Model Context Protocol (MCP) servers with GitHub Agentic Workflows to connect AI agents to external tools, databases, and services.
4+
sidebar:
5+
order: 200
46
---
57

68
This guide covers using Model Context Protocol (MCP) servers with GitHub Agentic Workflows.

docs/src/content/docs/guides/security.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Security Guide
33
description: Important security considerations for GitHub Agentic Workflows, including sandboxing, permissions, and best practices for safe agentic automation.
4+
sidebar:
5+
order: 100
46
---
57

68
> [!WARNING]

docs/src/content/docs/tools/cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ The `mcp` command provides comprehensive tools for discovering, listing, and ins
559559

560560
> **📘 Complete MCP Guide**: For comprehensive MCP setup, configuration examples, and troubleshooting, see the [MCPs](/gh-aw/guides/mcps/).
561561
>
562-
> **🔧 MCP Server**: To run gh-aw as an MCP server exposing CLI tools, see the [MCP Server Guide](/gh-aw/guides/mcp-server/).
562+
> **🔧 MCP Server**: To run gh-aw as an MCP server exposing CLI tools, see the [MCP Server Guide](/gh-aw/tools/mcp-server/).
563563
564564
### MCP Server Discovery
565565

@@ -669,7 +669,7 @@ For detailed MCP debugging and troubleshooting guides, see [MCP Debugging](/gh-a
669669

670670
The `mcp-server` command runs gh-aw as a Model Context Protocol (MCP) server, exposing CLI commands as tools that can be called by AI agents and other MCP clients. This enables secure, isolated access to gh-aw functionality.
671671

672-
> **📘 Complete MCP Server Guide**: For comprehensive setup, security architecture, workflow integration examples, and troubleshooting, see the [MCP Server Guide](/gh-aw/guides/mcp-server/).
672+
> **📘 Complete MCP Server Guide**: For comprehensive setup, security architecture, workflow integration examples, and troubleshooting, see the [MCP Server Guide](/gh-aw/tools/mcp-server/).
673673
674674
**Starting the Server:**
675675

@@ -712,7 +712,7 @@ imports:
712712

713713
The MCP server uses a subprocess wrapper architecture where each tool invocation spawns a `gh aw` CLI subprocess. This ensures GitHub tokens and secrets remain isolated from the MCP server process, preventing credential leakage to agentic workflows.
714714

715-
For complete documentation including examples, security details, and troubleshooting, see the [MCP Server Guide](/gh-aw/guides/mcp-server/).
715+
For complete documentation including examples, security details, and troubleshooting, see the [MCP Server Guide](/gh-aw/tools/mcp-server/).
716716

717717
## 👀 Watch Mode for Development
718718
The `--watch` flag provides automatic recompilation during workflow development, monitoring for file changes in real-time. See [Authoring in VS Code](/gh-aw/tools/vscode/).

0 commit comments

Comments
 (0)