Skip to content

Commit 0da7335

Browse files
committed
docs(all): improve formatting and clarity in README.md
1 parent 187493d commit 0da7335

File tree

1 file changed

+29
-22
lines changed

1 file changed

+29
-22
lines changed

README.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,21 @@ Deploy MCP servers from GitHub to HTTP endpoints in 30 seconds. Works with n8n,
2727

2828
Most MCP servers are **stdio-only**. But workflow automation platforms need **HTTP endpoints**.
2929

30-
| Platform | What They Need | The Problem |
31-
|----------|---------------|-------------|
32-
| **n8n** | HTTP URLs for MCP Client node | stdio doesn't work |
33-
| **Dify** | HTTP/SSE endpoints (v1.6+) | No stdio support |
34-
| **Voiceflow** | Remote MCP endpoints | "Local MCP NOT supported" |
35-
| **Langflow** | HTTP/SSE for production | Local processes won't scale |
30+
| Platform | What They Need | The Problem |
31+
| ------------- | ----------------------------- | --------------------------- |
32+
| **n8n** | HTTP URLs for MCP Client node | stdio doesn't work |
33+
| **Dify** | HTTP/SSE endpoints (v1.6+) | No stdio support |
34+
| **Voiceflow** | Remote MCP endpoints | "Local MCP NOT supported" |
35+
| **Langflow** | HTTP/SSE for production | Local processes won't scale |
3636

3737
Current workarounds are painful:
38+
3839
- `mcp-remote` requires local Node.js setup
3940
- Docker containers need DevOps expertise
4041
- DIY hosting (Fly.io, Railway) takes hours
4142

4243
**And for teams**, the problems multiply:
44+
4345
- Credentials scattered across Slack DMs and `.env` files
4446
- No visibility into who uses which tools
4547
- Onboarding new developers takes hours
@@ -108,7 +110,7 @@ Don't have your own MCP server? Browse our catalog of popular servers:
108110

109111
### Deploy from GitHub
110112

111-
```
113+
```bash
112114
GitHub Repo → DeployStack → HTTP Endpoint → Your MCP Client
113115
```
114116

@@ -120,9 +122,11 @@ GitHub Repo → DeployStack → HTTP Endpoint → Your MCP Client
120122
### 98% Token Reduction
121123

122124
Traditional MCP setup loads all tools into context:
125+
123126
- 10 servers × 15 tools = 150 tools = 75,000 tokens consumed
124127

125128
DeployStack's hierarchical router exposes only 2 meta-tools:
129+
126130
- `discover_mcp_tools` - find relevant tools
127131
- `execute_mcp_tool` - run the tool you need
128132
- Result: 1,372 tokens instead of 75,000
@@ -161,16 +165,16 @@ Full visibility into MCP usage:
161165

162166
Compatible with any MCP client that supports HTTP/SSE:
163167

164-
| Workflow Platforms | AI Coding Tools | Other Clients |
165-
|-------------------|-----------------|---------------|
166-
| n8n | Claude Code | Any HTTP MCP client |
167-
| Dify | Cursor | Custom integrations |
168-
| Voiceflow | VS Code | |
169-
| Langflow | Windsurf | |
168+
| Workflow Platforms | AI Coding Tools | Other Clients |
169+
| ------------------ | --------------- | ------------------- |
170+
| n8n | Claude Code | Any HTTP MCP client |
171+
| Dify | Cursor | Custom integrations |
172+
| Voiceflow | VS Code | |
173+
| Langflow | Windsurf | |
170174

171175
## Architecture
172176

173-
```
177+
```text
174178
┌─────────────┐ ┌─────────────────┐ ┌─────────────┐
175179
│ GitHub │────▶│ DeployStack │────▶│ HTTP URL │
176180
│ Repo │ │ Satellite │ │ Endpoint │
@@ -186,12 +190,12 @@ Compatible with any MCP client that supports HTTP/SSE:
186190

187191
**Two deployment options:**
188192

189-
| Global Satellites | Team Satellites |
190-
|------------------|-----------------|
191-
| Managed by DeployStack | Deploy on your infrastructure |
192-
| Zero setup | Full data control |
193-
| Free tier available | Enterprise security |
194-
| `satellite.deploystack.io` | `satellite.yourcompany.com` |
193+
| Global Satellites | Team Satellites |
194+
| -------------------------- | ----------------------------- |
195+
| Managed by DeployStack | Deploy on your infrastructure |
196+
| Zero setup | Full data control |
197+
| Free tier available | Enterprise security |
198+
| `satellite.deploystack.io` | `satellite.yourcompany.com` |
195199

196200
## Quick Start
197201

@@ -201,12 +205,14 @@ Create a free account at [cloud.deploystack.io](https://cloud.deploystack.io)
201205

202206
### 2. Add MCP Servers
203207

204-
**Option A: Deploy from GitHub**
208+
#### Option A: Deploy from GitHub
209+
205210
- Connect your GitHub account
206211
- Select a repository with an MCP server
207212
- Click Deploy
208213

209-
**Option B: Use Catalog**
214+
#### Option B: Use Catalog
215+
210216
- Browse the MCP server catalog
211217
- Click Install on any server
212218
- Configure credentials if needed
@@ -337,6 +343,7 @@ We welcome contributions. Here's how:
337343
5. Submit a pull request
338344

339345
**Areas where we need help:**
346+
340347
- MCP server integrations
341348
- Documentation improvements
342349
- Satellite infrastructure

0 commit comments

Comments
 (0)