Skip to content

Commit 69ff109

Browse files
committed
chore: added some examples in readme.
1 parent 267496d commit 69ff109

1 file changed

Lines changed: 52 additions & 5 deletions

File tree

README.md

Lines changed: 52 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
**The Zero-Trust Firewall and Protocol Bridge for the Model Context Protocol (MCP)**
66

7-
[![Go Report Card](https://goreportcard.com/badge/github.com/AgentStack-AI/agentgate)](https://goreportcard.com/report/github.com/AgentStack-AI/agentgate)
7+
[![Go Report Card](https://goreportcard.com/badge/github.com/AgentStaqAI/agentgate)](https://goreportcard.com/report/github.com/AgentStaqAI/agentgate)
88
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
9-
[![Stars](https://img.shields.io/github/stars/AgentStack-AI/agentgate?style=social)](https://github.com/AgentStack-AI/agentgate/stargazers)
9+
[![Stars](https://img.shields.io/github/stars/AgentStaqAI/agentgate?style=social)](https://github.com/AgentStaqAI/agentgate/stargazers)
1010

1111
> A sub-millisecond, zero-dependency reverse proxy written in Go that airgaps your AI agents. It intercepts MCP commands, translates them to HTTP/SSE, and wraps them in an impenetrable semantic firewall.
1212
@@ -36,7 +36,7 @@ Relying on "system prompts" for security is a guaranteed way to get your databas
3636
```
3737

3838
```
39-
[ LLM / LangChain ] ──► (HTTP/SSE) ──► [ 🛡️ AgentGate ] ──► (stdio) ──► [ MCP Tools / DB ]
39+
[ LLM / LangChain ] ──► (HTTP/SSE) ──► [ AgentGate ] ──► (stdio) ──► [ MCP Tools / DB ]
4040
4141
┌────────┴────────┐
4242
│ Policy Engine │
@@ -72,19 +72,66 @@ AgentGate is a single, zero-dependency Go binary.
7272

7373
**Option 1 — Homebrew (macOS/Linux)**
7474
```bash
75-
brew tap AgentStack-AI/agentgate
75+
brew tap AgentStaqAI/agentgate
7676
brew install agentgate
7777
```
7878

7979
**Option 2 — Build from Source**
8080
```bash
81-
git clone https://github.com/AgentStack-AI/agentgate.git
81+
git clone https://github.com/AgentStaqAI/agentgate.git
8282
cd agentgate
8383
go build -o agentgate .
8484
```
8585

8686
---
8787

88+
## 5-Minute Example
89+
90+
Define your MCP servers in `agentgate.yaml`:
91+
92+
```yaml
93+
version: "1.0"
94+
network:
95+
port: 8083
96+
auth:
97+
require_bearer_token: "my-secret-token"
98+
audit_log_path: "audit.log"
99+
100+
mcp_servers:
101+
filesystem:
102+
upstream: "exec:npx -y @modelcontextprotocol/server-filesystem /home/user/projects"
103+
policies:
104+
access_mode: "allowlist"
105+
allowed_tools: ["read_file", "list_directory"]
106+
rate_limit:
107+
max_requests: 60
108+
window_seconds: 60
109+
110+
my_postgres:
111+
upstream: "http://localhost:9090" # An already-running MCP HTTP server
112+
policies:
113+
allowed_tools: ["query"]
114+
human_approval:
115+
require_for_tools: ["query"]
116+
webhook:
117+
type: "slack"
118+
url: "https://hooks.slack.com/services/..."
119+
```
120+
121+
Start AgentGate, then point your LLM client at it using the protocol your MCP server speaks:
122+
123+
| Protocol | Your MCP server speaks | URL to give your LLM client |
124+
|---|---|---|
125+
| **Streamable HTTP** (MCP spec 2025) | Native MCP / Go & TS SDKs | `http://localhost:8083/filesystem/mcp` |
126+
| **Server-Sent Events** (SSE legacy) | Python SDK, FastMCP | `http://localhost:8083/filesystem/sse` |
127+
| **Synchronous JSON-RPC** (plain HTTP) | Custom HTTP servers, curl | `http://localhost:8083/filesystem/` |
128+
129+
All three paths go through the **same firewall** — auth, RBAC, regex sandbox, rate limiting, and HITL checks apply equally regardless of the transport protocol.
130+
131+
> See the **[API & Endpoints guide](api_docs.md)** for a detailed breakdown of how each protocol works.
132+
133+
---
134+
88135
## ⚙️ Usage
89136

90137
**1. Configure your Firewall**

0 commit comments

Comments
 (0)