모델 컨텍스트 프로토콜(MCP) 서버를 위한 게이트웨이입니다.

이 게이트웨이는 GitHub Agentic Workflows와 함께 sandbox.mcp 구성을 통해 샌드박스 환경에서 실행 중인 AI 에이전트에 MCP 서버 접근을 제공합니다.

퀵 스타트

1. Docker 이미지를 가져와 (가능할 경우):

2. 구성 파일 생성 (config.json):

참고: JSON stdin 구성에서 gateway 섹션은 필수이며, port, domain, 그리고 agentId 또는 [agentIds 중 정확히 하나를 포함해야 합니다. 위에 표시된 값들은 예시입니다; 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