Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
56 changes: 56 additions & 0 deletions .github/workflows/sync-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Sync Documentation from gh-aw

on:
schedule:
# Run daily at 2:00 AM UTC
- cron: '0 2 * * *'
workflow_dispatch: # Allow manual triggering

permissions:
contents: write
pull-requests: write

jobs:
sync-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}

- name: Sync documentation
run: ./scripts/sync-docs.sh

- name: Check for changes
id: check_changes
run: |
if git diff --quiet docs/; then
echo "has_changes=false" >> $GITHUB_OUTPUT
echo "No documentation changes detected"
else
echo "has_changes=true" >> $GITHUB_OUTPUT
echo "Documentation changes detected"
fi

- name: Create Pull Request
if: steps.check_changes.outputs.has_changes == 'true'
uses: peter-evans/create-pull-request@v6
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "docs: sync MCP Gateway documentation from gh-aw"
title: "docs: sync MCP Gateway documentation from gh-aw"
body: |
This PR contains automated documentation updates synced from the [githubnext/gh-aw](https://github.com/githubnext/gh-aw) repository.

The following documentation has been updated:
- `docs/mcp-gateway.md` - MCP Gateway Specification

**Source**: https://github.com/githubnext/gh-aw/blob/main/docs/src/content/docs/reference/mcp-gateway.md

This sync is performed daily to keep the documentation up-to-date with the main gh-aw repository.
branch: docs/sync-from-gh-aw
delete-branch: true
labels: |
documentation
automated
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Quick reference for AI agents working with MCP Gateway (Go-based MCP proxy serve

## Config Examples

**Configuration Spec**: See **[MCP Gateway Configuration Reference](https://github.com/githubnext/gh-aw/blob/main/docs/src/content/docs/reference/mcp-gateway.md)** for complete specification.
**Configuration Spec**: See **[MCP Gateway Configuration Reference](docs/mcp-gateway.md)** for complete specification.

**TOML** (`config.toml`):
```toml
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ A gateway for Model Context Protocol (MCP) servers.

This gateway is used with [GitHub Agentic Workflows](https://github.com/githubnext/gh-aw) via the `sandbox.mcp` configuration to provide MCP server access to AI agents running in sandboxed environments.

📖 **[Full Configuration Specification](https://github.com/githubnext/gh-aw/blob/main/docs/src/content/docs/reference/mcp-gateway.md)** - Complete reference for all configuration options and validation rules.
📖 **[Full Configuration Specification](docs/mcp-gateway.md)** - Complete reference for all configuration options and validation rules.

> **Documentation Sync**: The specification docs are automatically synced daily from the [githubnext/gh-aw](https://github.com/githubnext/gh-aw) repository. See [docs/README.md](docs/README.md) for details.

## Features

Expand Down Expand Up @@ -85,7 +87,7 @@ args = ["/path/to/filesystem-server.js"]

### JSON Stdin Format

For the complete JSON configuration specification with all validation rules, see the **[MCP Gateway Configuration Reference](https://github.com/githubnext/gh-aw/blob/main/docs/src/content/docs/reference/mcp-gateway.md)**.
For the complete JSON configuration specification with all validation rules, see the **[MCP Gateway Configuration Reference](docs/mcp-gateway.md)**.

```json
{
Expand Down Expand Up @@ -159,7 +161,7 @@ For the complete JSON configuration specification with all validation rules, see
- `mode` must be either `"ro"` or `"rw"`
- Both source and destination paths are required (cannot be empty)

See **[Configuration Specification](https://github.com/githubnext/gh-aw/blob/main/docs/src/content/docs/reference/mcp-gateway.md)** for complete validation rules.
See **[Configuration Specification](docs/mcp-gateway.md)** for complete validation rules.

#### Gateway Configuration Fields (Reserved)

Expand Down
33 changes: 33 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Documentation

This directory contains documentation for the MCP Gateway project.

## Files

- **[mcp-gateway.md](mcp-gateway.md)** - Complete MCP Gateway Specification including configuration format, protocol behavior, authentication, and compliance requirements.

## Sync Process

The documentation in this directory is automatically synced from the [githubnext/gh-aw repository](https://github.com/githubnext/gh-aw/tree/main/docs/src/content/docs/reference) on a daily schedule.

- **Source**: https://github.com/githubnext/gh-aw/blob/main/docs/src/content/docs/reference/mcp-gateway.md
- **Sync Script**: `scripts/sync-docs.sh`
- **Workflow**: `.github/workflows/sync-docs.yml`

### Manual Sync

To manually sync the documentation:

```bash
./scripts/sync-docs.sh
```

This will:
1. Fetch the latest documentation from the gh-aw repository
2. Remove Astro-specific frontmatter
3. Add a sync notice at the top
4. Save to `docs/mcp-gateway.md`

## Authoritative Source

The **official specification** is maintained in the [githubnext/gh-aw](https://github.com/githubnext/gh-aw) repository. The documentation here is a convenience copy for local reference. For compliance testing and official specification details, always refer to the source repository.
Loading
Loading