モデルコンテキストプロトコル(MCP)サーバー向けのゲートウェイです。

このゲートウェイは、sandbox.mcp構成を通じてGitHub Agentic Workflowsと連携し、サンドボックス環境で動作するAIエージェントにMCPサーバーアクセスを提供します。

クイックスタート

1. Dockerイメージを取得(利用可能な場合):

2. 設定ファイルを作成する(config.json):

注:JSON標準設定において、gatewayセクションは必須であり、port、domain、そしてagentIdまたはagentIdsのちょうど1つを含む必要があります。上記の値は例です;gatewayやこれらの必須フィールドのいずれかを省略すると、起動時にスキーマ検証に失敗します。その他のgatewayフィールドは任意で、存在すれば検証されます。オプションのサーバーフィールドにはentrypoint、entrypointArgs、mounts、args、connectTimeout、toolTimeoutがあります。サーバーフィールドの完全な参照についてはdocs/CONFIGURATION.mdを参照してください。

完全な例をお探しですか?config.example.toml、config.example-payload-threshold.toml、example-http-config.jsonを参照してください。

3. コンテナを走らせる:

[!注] CLIは--configまたは--config-stdinのいずれかを必要とします。パイピングJSONの設定は--config-stdinが必要です。

MCP Gateway

A gateway for Model Context Protocol (MCP) servers.

This gateway is used with GitHub Agentic Workflows via the sandbox.mcp configuration to provide MCP server access to AI agents running in sandboxed environments.

Quick Start

1. Pull the Docker image (when available):

   docker pull ghcr.io/github/gh-aw-mcpg:latest
   

2. Create a configuration file (config.json):

   {
     "gateway": {
       "port": 8000,
       "domain": "${MCP_GATEWAY_DOMAIN}",
       "agentId": "${MCP_GATEWAY_AGENT_ID}"
     },
     "mcpServers": {
       "github": {
         "type": "stdio",
         "container": "ghcr.io/github/github-mcp-server:latest",
         "env": {
           "GITHUB_PERSONAL_ACCESS_TOKEN": ""
         }
       }
     }
   }
   

   Note: for JSON stdin configuration the gateway section is required, and it must include port, domain, and exactly one of agentId or agentIds. The values shown above are examples; omitting gateway — or any of these required fields — fails schema validation at startup. All other gateway fields are optional and are validated when present. Optional server fields include entrypoint, entrypointArgs, mounts, args, connectTimeout, and toolTimeout; see docs/CONFIGURATION.md for the complete server-field reference.

   Looking for complete examples? See config.example.toml, config.example-payload-threshold.toml, and example-http-config.json.

3. Run the container:

   docker run --rm -i \
     -e MCP_GATEWAY_PORT=8000 \
     -e MCP_GATEWAY_DOMAIN=localhost \
     -e MCP_GATEWAY_AGENT_ID=your-agent-id \
     -v /var/run/docker.sock:/var/run/docker.sock \
     -v /path/to/logs:/tmp/gh-aw/mcp-logs \
     -p 8000:8000 \
     ghcr.io/github/gh-aw-mcpg:latest < config.json
   

[!NOTE] The CLI requires either --config or --config-stdin; piping JSON configuration requires --config-stdin. The container entrypoint script (run_containerized.sh) automatically adds --config-stdin when it starts awmg. If you run awmg directly (outside the container) and want to pipe JSON config, you must pass --config-stdin explicitly.

Inside the container, the gateway starts in routed mode on http://0.0.0.0:8000, proxying MCP requests to your configured backend servers. When running awmg directly without --listen, the default listen address is http://127.0.0.1:3000.

Required flags:

• -i: Enables stdin for passing JSON configuration
• -v /var/run/docker.sock: Required when using the default Docker runtime
• Dockerless Podman mode ("gateway": {"dockerless": true}) does not use the Docker socket; grant the container the capabilities required for nested containers (for example, --privileged)
• -p 8000:8000: Port mapping must match MCP_GATEWAY_PORT