Skip to content

[docs] Update documentation for features from 2025-12-16 #6703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Dec 17, 2025
Merged

[docs] Update documentation for features from 2025-12-16 #6703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions docs/src/content/docs/guides/mcps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,22 @@ mcp-servers:
- ask_question
```

#### HTTP Authentication

Configure authentication headers for HTTP MCP servers using the `headers` field:

```yaml wrap
mcp-servers:
authenticated-api:
url: "https://api.example.com/mcp"
headers:
Authorization: "Bearer ${{ secrets.API_TOKEN }}"
X-Custom-Header: "value"
allowed: ["*"]
```

Headers are injected into all HTTP requests made to the MCP server, enabling bearer token authentication, API keys, and other custom authentication schemes.

### 4. Registry-based MCP Servers

Reference MCP servers from the GitHub MCP registry (the `registry` field provides metadata for tooling):
Expand Down Expand Up @@ -205,8 +221,6 @@ mcp-servers:

Use `["*"]` to allow all tools from a custom MCP server.

**HTTP Headers**: Configure authentication in URL parameters (e.g., `?apiKey=${{ secrets.API_KEY }}`).

## Network Egress Permissions

Restrict outbound access for containerized stdio MCP servers using `network.allowed` (see [Docker Container example](#2-docker-container-mcp-servers)). Enforcement uses a [Squid proxy](https://www.squid-cache.org/) with `HTTP_PROXY`/`HTTPS_PROXY` and iptables rules. Only applies to containerized stdio servers.
Expand Down
18 changes: 18 additions & 0 deletions docs/src/content/docs/reference/frontmatter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,24 @@ labels: ["automation", "ci", "diagnostics"]

Labels help organize workflows by purpose, team, or functionality. They appear in status command table output as `[automation ci diagnostics]` and as a JSON array in `--json` mode. Filter workflows by label using `gh aw status --label automation`.

### Metadata (`metadata:`)

Optional key-value pairs for storing custom metadata compatible with the [GitHub Copilot custom agent spec](https://docs.github.com/en/copilot/reference/custom-agents-configuration).

```yaml wrap
metadata:
author: John Doe
version: 1.0.0
category: automation
```

**Constraints:**
- Keys: 1-64 characters
- Values: Maximum 1024 characters
- Only string values are supported
Comment on lines +74 to +81
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

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

The constraint "Only string values are supported" may be misleading when the example shows a numeric version value (1.0.0). While YAML parsers will treat unquoted 1.0.0 as a string, this could cause confusion. Consider either:

  1. Updating the example to use quoted strings to be explicit: version: "1.0.0"
  2. Clarifying the constraint to specify that numeric values will be coerced to strings

Copilot uses AI. Check for mistakes.

Metadata provides a flexible way to add descriptive information to workflows without affecting execution.

### GitHub Token (`github-token:`)

Configures the default GitHub token for engine authentication, checkout steps, and safe-output operations.
Expand Down