Skip to content

Commit 584edf7

Browse files
committed
Add proxy to docs
1 parent 916a393 commit 584edf7

File tree

4 files changed

+548
-38
lines changed

4 files changed

+548
-38
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,12 @@ Pre-built images are available:
6767
For detailed installation and configuration, see the [documentation](https://docs.mcpulse.io)
6868

6969

70-
## SDKs
70+
## Integration Options
7171

72-
### Integration SDKs
72+
### Zero-Code Solution
73+
- **MCPulse Proxy**: https://github.com/sirrobot01/mcpulse-proxy - Add analytics to any MCP server without code changes. Works with any MCP server via stdio, HTTP, or SSE.
74+
75+
### SDK Integration
7376
- **Python**: https://github.com/sirrobot01/mcpulse-python
7477
- **Go**: https://github.com/sirrobot01/mcpulse-go
7578
- **Node.js/TypeScript**: coming soon

docs/docs/intro.md

Lines changed: 21 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -39,49 +39,34 @@ Built in Go - handles 10,000+ events/second with sub-second query latency.
3939

4040
Pull the latest image:
4141
```bash
42-
# From GitHub Container Registry
43-
docker pull ghcr.io/sirrobot01/mcpulse:latest
42+
curl -O https://raw.githubusercontent.com/sirrobot01/mcpulse/main/docker-compose.yml
43+
curl -o config.yaml https://raw.githubusercontent.com/sirrobot01/mcpulse/main/config.yaml.example
4444

45-
# Or from Docker Hub
46-
docker pull cy01/mcpulse:latest
47-
```
48-
49-
Create `docker-compose.yml`:
50-
```yaml
51-
version: '3.8'
52-
services:
53-
timescaledb:
54-
image: timescale/timescaledb:latest-pg16
55-
environment:
56-
POSTGRES_DB: mcp_analytics
57-
POSTGRES_USER: mcp_user
58-
POSTGRES_PASSWORD: changeme
59-
ports:
60-
- "5432:5432"
61-
volumes:
62-
- mcpulse-data:/var/lib/postgresql/data
63-
64-
mcpulse:
65-
image: ghcr.io/sirrobot01/mcpulse:latest
66-
ports:
67-
- "8080:8080"
68-
- "9090:9090"
69-
environment:
70-
DATABASE_URL: postgres://mcp_user:changeme@timescaledb:5432/mcp_analytics?sslmode=disable
71-
JWT_SECRET: your_jwt_secret_here_at_least_32_chars
72-
depends_on:
73-
- timescaledb
74-
75-
volumes:
76-
mcpulse-data:
77-
```
7845

7946
Start the services:
8047
```bash
8148
docker compose up -d
8249
```
8350

84-
2. **Integrate an SDK**
51+
2. **Add Analytics to Your MCP Server**
52+
53+
**Option A: Zero-Code Proxy** (recommended for quick start)
54+
```json
55+
{
56+
"mcpServers": {
57+
"my-server": {
58+
"command": "mcpulse-proxy",
59+
"args": ["stdio", "--server-id", "my-server", "--command", "python server.py"],
60+
"env": {
61+
"MCPULSE_URL": "localhost:50051",
62+
"MCPULSE_API_KEY": "your-api-key"
63+
}
64+
}
65+
}
66+
}
67+
```
68+
69+
**Option B: SDK Integration** (for custom control)
8570
```python
8671
from mcpulse import AnalyticsTracker, Config
8772

docs/docs/sdks/overview.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,46 @@ MCPulse provides official SDKs for easy integration with your MCP servers. Choos
88

99
## Available SDKs
1010

11+
### MCPulse Proxy (Zero-Code Solution)
12+
13+
Transparent analytics proxy for any MCP server - no code changes required!
14+
15+
- **Package**: `mcpulse-proxy`
16+
- **Install**: `go install github.com/sirrobot01/mcpulse-proxy@latest`
17+
- **GitHub**: [mcpulse-proxy](https://github.com/sirrobot01/mcpulse-proxy)
18+
19+
**Features:**
20+
- Zero code changes needed
21+
- Works with any MCP server (Python, TypeScript, Go, etc.)
22+
- Multi-transport support (stdio, HTTP, SSE)
23+
- Automatic metric collection
24+
- Config file support for easy setup
25+
- Perfect for Claude Desktop integration
26+
27+
**Quick Example:**
28+
```json
29+
{
30+
"mcpServers": {
31+
"my-server": {
32+
"command": "mcpulse-proxy",
33+
"args": [
34+
"stdio",
35+
"--server-id", "my-server",
36+
"--command", "python server.py"
37+
],
38+
"env": {
39+
"MCPULSE_URL": "localhost:50051",
40+
"MCPULSE_API_KEY": "your-api-key"
41+
}
42+
}
43+
}
44+
}
45+
```
46+
47+
**Use Case:** Perfect for adding analytics to existing MCP servers without modifying code, or when you don't control the server source code.
48+
49+
---
50+
1151
### Python SDK
1252

1353
Official Python SDK with decorator-based tracking and async support.
@@ -151,6 +191,7 @@ All SDKs provide:
151191

152192
## SDK Documentation
153193

194+
- [MCPulse Proxy Guide](./proxy) - Zero-code solution
154195
- [Python SDK Guide](./python)
155196
- [Go SDK Guide](./go)
156197
- TypeScript SDK - Coming Soon

0 commit comments

Comments
 (0)