Skip to content

Commit 857e74a

Browse files
author
Lasim
committed
docs(all): update README to improve clarity and structure with additional spacing
1 parent 4ff5141 commit 857e74a

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ DeployStack was built to solve these problems head-on.
4444
- Automatically shuts down idle processes to save resources
4545

4646
**Before DeployStack:**
47+
4748
```bash
4849
# Manual setup nightmare
4950
npm install -g some-mcp-cli
@@ -52,6 +53,7 @@ some-mcp configure --api-key=xxx
5253
```
5354

5455
**After DeployStack:**
56+
5557
```json
5658
// VS Code settings.json - that's it!
5759
{
@@ -66,13 +68,15 @@ some-mcp configure --api-key=xxx
6668
## Architecture: Two Ways to Deploy
6769

6870
### Global Satellites (Managed by DeployStack)
71+
6972
- **Zero Installation**: Just add URL to VS Code
7073
- **Freemium Model**: Free tier with basic MCP servers
7174
- **Instant Access**: Pre-configured tools ready to use
7275
- **Multi-tenant**: Resource isolation between teams
7376
- **Example**: `https://satellite.deploystack.io/mcp`
7477

7578
### Team Satellites (Deploy Your Own) - (On Premise or Cloud) - (Comming Soon)
79+
7680
- **Enterprise Security**: On-premise deployment within your network
7781
- **Internal Access**: Connect to company databases, APIs, file systems
7882
- **Complete Isolation**: Full team separation using Linux containers
@@ -81,13 +85,14 @@ some-mcp configure --api-key=xxx
8185

8286
### Technical Flow
8387

84-
```
88+
```bash
8589
VS Code → HTTPS Request → DeployStack Satellite → MCP Server Process → External API
8690
↓ ↓ ↓ ↓
8791
(OAuth JWT) (Team Permissions) (Credential Injection) (GitHub/etc)
8892
```
8993

9094
**Core Components:**
95+
9196
- **Control Plane**: `cloud.deploystack.io` - web dashboard for teams, credentials, configurations
9297
- **Satellites**: Managed MCP infrastructure - no local processes, just HTTPS
9398
- **Process Manager**: On-demand MCP server spawning with X-minute idle timeout
@@ -96,20 +101,24 @@ VS Code → HTTPS Request → DeployStack Satellite → MCP Server Process → E
96101
### Why Satellite vs Traditional Gateway?
97102

98103
**Conversion Rate Data:**
104+
99105
- **Traditional Gateway CLI**: 1% (install CLI → configure → first use)
100106
- **DeployStack Satellite**: 12% (register → copy URL → first use)
101107

102108
**User Experience:**
109+
103110
- **Gateway**: "Install our CLI tool, configure localhost, manage processes"
104111
- **Satellite**: "Add this URL: `https://satellite.deploystack.io/mcp`"
105112

106113
**Why This Matters:**
114+
107115
- **Adoption Friction Kills Everything**: Every MCP solution requiring CLI installation loses 99% of interested developers
108116
- **"Another Local Proxy" Fatigue**: Market saturated with similar gateway solutions requiring installation
109117
- **Teams Can't Scale**: Complex setups prevent MCP adoption beyond early adopters
110118
- **Enterprise Path**: Natural progression from managed service to on-premise deployment
111119

112120
**Technical Benefits:**
121+
113122
- **No Local Dependencies**: No Node.js, npm, or port management
114123
- **Familiar Pattern**: Works like OpenAI API, Claude API, or any SaaS
115124
- **Auto-scaling**: Handles traffic spikes automatically
@@ -119,13 +128,15 @@ VS Code → HTTPS Request → DeployStack Satellite → MCP Server Process → E
119128
## Roadmap
120129

121130
### **Phase 1: Foundation** (Completed)
131+
122132
- **[Done]** Deployed `cloud.deploystack.io` hosted version with a robust backend and frontend
123133
- **[Done]** Implemented a secure user and team management system with roles and permissions
124134
- **[Done]** Integrated OAuth for secure logins (e.g., GitHub)
125135
- **[Done]** Created the initial MCP Server Catalog for tool discovery
126136
- **[Done]** Established documentation and self-hosted Docker support
127137

128138
### **Phase 2: Enterprise Governance** (Completed)
139+
129140
- **[Done]** Auto-install MCP servers for new users with admin-controlled defaults
130141
- **[Done]** Featured MCP servers filtering for improved tool discovery
131142
- **[Done]** Global Event Bus System - event-driven architecture with plugin integration
@@ -134,6 +145,7 @@ VS Code → HTTPS Request → DeployStack Satellite → MCP Server Process → E
134145
- **[Done]** Advanced MCP Argument & Environment Variable Handling - comprehensive service layer with schema validation and runtime configuration assembly
135146

136147
### **Phase 3: Satellite MVP** (Current Priority)
148+
137149
- **[Done]** **Global Satellite Infrastructure** - managed MCP servers via HTTPS
138150
- **[Done]** **Zero-Installation Experience** - just add URL to VS Code
139151
- **[Done]** **OAuth Authentication** - seamless token-based auth
@@ -146,18 +158,21 @@ VS Code → HTTPS Request → DeployStack Satellite → MCP Server Process → E
146158
- **[To Do]** Deeper integration with IDEs and AI agent frameworks
147159

148160
### **Phase 4: Advanced Architecture** (Next)
161+
149162
- **[Done]** **Multi-Transport Support** - SSE, Streamable HTTP, Direct HTTP protocols
150163
- **[To Do]** **Real-Time Command Orchestration** - instant status feedback
151164
- **[To Do]** **Comprehensive Monitoring** - satellite health and usage analytics
152165
- **[To Do]** **Enterprise Security** - audit logging and compliance features
153166

154167
### **Phase 5: Enterprise Team Satellites** (Future)
168+
155169
- **[To Do]** **Team Satellites** - customer-deployed satellites for enterprise
156170
- **[To Do]** **Advanced Team Isolation** - Linux namespaces and cgroups
157171
- **[To Do]** **On-Premise Deployment** - GitHub Actions runner-style deployment
158172
- **[To Do]** **Enterprise Authentication** - SSO integration (SAML, OIDC)
159173

160174
### **Phase 6: Ecosystem Expansion** (Future)
175+
161176
- **[To Do]** Advanced MCP server marketplace
162177
- **[To Do]** Multi-region satellite deployment
163178
- **[To Do]** IDE integrations and developer tools
@@ -189,6 +204,7 @@ We're building the future of MCP adoption. Want to help?
189204
5. Submit pull request with clear description
190205

191206
**Areas we need help:**
207+
192208
- Satellite infrastructure and scaling
193209
- MCP server integrations and testing
194210
- Documentation and developer experience

0 commit comments

Comments
 (0)