You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-24Lines changed: 34 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,13 +23,15 @@ DeployStack was built to solve these problems head-on.
23
23
24
24
DeployStack introduces a powerful Control Plane / Data Plane architecture to bring order to the chaos.
25
25
26
-
1.**`cloud.deploystack.io` (The Control Plane)**: A centralized web UI where administrators and team leads define the entire AI tooling landscape.
26
+
1.**`cloud.deploystack.io` (The Control Plane)**: A centralized web UI where administrators and team leads define the entire AI tooling landscape.
27
+
27
28
-**Centralized Credential Vault**: Securely store all your MCP server credentials (API keys, tokens) in one encrypted location.
28
29
-**Access Control Policies**: Define which teams and users have permission to access which MCP Server.
29
30
-**MCP Catalog**: Manage a central catalog of all approved MCP servers (local, remote (coming soon), or third-party (coming soon)).
30
31
-**Audit & Analytics**: Gain visibility into which tools are being used, by whom, and how often.
31
32
32
-
2.**The `DeployStack Gateway` (The Local Data Plane)**: A lightweight, secure agent that runs on each developer's machine.
33
+
2.**The `DeployStack Gateway` (The Local Data Plane)**: A lightweight, secure agent that runs on each developer's machine.
34
+
33
35
-**One-Time Login**: Developers log in once. The Gateway securely fetches the configurations they are authorized to use.
34
36
-**Single Local Endpoint**: The Gateway exposes a single, stable MCP endpoint on `localhost`. Developers point all their tools (VS Code, Cursor, etc.) to this one address.
35
37
-**On-Demand Process Spawning**: The Gateway automatically starts and stops local MCP servers (`stdio`-based) as needed, injecting credentials securely at runtime. It manages the processes so the developer doesn't have to.
@@ -39,11 +41,11 @@ This architecture means developers never handle sensitive credentials, and the o
39
41
40
42
## 🚀 How It Works: A Quick Tour
41
43
42
-
1.**Admin**: Logs into `cloud.deploystack.io`, creates a team, and registers an MCP server (e.g., the `github` mcp server), storing its API token securely in the DeployStack vault. They grant the "Dev Team" access to this server.
43
-
2.**Developer**: Installs the `DeployStack Gateway` and runs `deploystack-gateway login`. They are now authenticated.
44
-
3.**Configuration Sync**: The Gateway securely downloads the configuration for the "Dev Team", including the definition for the `github` mcp server (but not the raw token).
45
-
4.**Local Development**: The developer, in VS Code, makes a call to a `github` mcp via the Gateway's local endpoint (`http://localhost:9090/mcp`).
46
-
5.**The Magic**:
44
+
1.**Admin**: Logs into `cloud.deploystack.io`, creates a team, and registers an MCP server (e.g., the `github` mcp server), storing its API token securely in the DeployStack vault. They grant the "Dev Team" access to this server.
45
+
2.**Developer**: Installs the `DeployStack Gateway` and runs `deploystack-gateway login`. They are now authenticated.
46
+
3.**Configuration Sync**: The Gateway securely downloads the configuration for the "Dev Team", including the definition for the `github` mcp server (but not the raw token).
47
+
4.**Local Development**: The developer, in VS Code, makes a call to a `github` mcp via the Gateway's local endpoint (`http://localhost:9090/mcp`).
48
+
5.**The Magic**:
47
49
- The Gateway receives the request.
48
50
- It sees it's for `github` mcp and checks if the process is running.
49
51
- If not, it spawns the `npx @github/mcp` process, securely injecting the API token from the cloud into the process environment.
@@ -54,48 +56,56 @@ This architecture means developers never handle sensitive credentials, and the o
54
56
55
57
### For Administrators & Team Leads
56
58
57
-
1.**Sign up for free**: [cloud.deploystack.io](https://cloud.deploystack.io)
58
-
2.**Create a Team**: Organize your developers and resources.
59
-
3.**Register MCP Servers**: Add your company's MCP Server to the catalog and store their credentials securely.
60
-
4.**Invite Your Team**: Have your developers install the `DeployStack Gateway`.
59
+
1.**Sign up for free**: [cloud.deploystack.io](https://cloud.deploystack.io)
60
+
2.**Create a Team**: Organize your developers and resources.
61
+
3.**Register MCP Servers**: Add your company's MCP Server to the catalog and store their credentials securely.
62
+
4.**Invite Your Team**: Have your developers install the `DeployStack Gateway`.
61
63
62
64
### For Developers
63
65
64
-
1.**Install the Gateway**:
66
+
1.**Install the Gateway**:
67
+
65
68
```bash
66
69
# Installation command coming soon
67
70
npm install -g @deploystack/gateway
68
71
```
69
-
2. **Login**:
72
+
73
+
2. **Login**:
74
+
70
75
```bash
71
76
deploystack login
72
77
```
73
-
3. **Configure Your Tools**: In VS Code, Cursor, or any other MCP client, set your MCP endpoint to the local Gateway address (e.g., `http://localhost:9095/mcp`).
74
-
4. **Start Building!** All the tools your team has access to are now available automatically.
78
+
79
+
3. **Configure Your Tools**: In VS Code, Cursor, or any other MCP client, set your MCP endpoint to the local Gateway address (e.g., `http://localhost:9095/mcp`).
80
+
4. **Start Building!** All the tools your team has access to are now available automatically.
75
81
76
82
## Roadmap
77
83
78
84
Our roadmap is designed to build the essential infrastructure for using MCP securely at scale, focusing on the critical pillars of security, governance, and developer experience.
79
85
80
-
**Phase 1: Foundation (Completed)**
86
+
### Phase 1: Foundation (Completed)
87
+
81
88
- **[Done]** Deployed `cloud.deploystack.io` hosted version with a robust backend and frontend.
82
89
- **[Done]** Implemented a secure user and team management system with roles and permissions.
83
90
- **[Done]** Integrated OAuth for secure logins (e.g., GitHub).
84
91
- **[Done]** Created the initial MCP Server Catalog for tool discovery.
85
92
- **[Done]** Established documentation and self-hosted Docker support.
86
93
87
-
**Phase 2: The Secure Gateway (Current Focus)**
94
+
### Phase 2: The Secure Gateway (Current Focus)
95
+
88
96
- **[In Progress]** Develop the `DeployStack Gateway`local application.
89
97
- **[In Progress]** Implement secure authentication and configuration synchronization between the Gateway and the cloud.
90
98
- **[To Do]** Build the on-demand `stdio` process spawning and management logic.
91
99
- **[To Do]** Add support for proxying to remote, HTTP-based MCP servers.
92
100
93
-
**Phase 3: Enterprise Governance**
101
+
### Phase 3: Enterprise Governance
102
+
94
103
- **[To Do]** Build out Audit Logging features in the cloud UI.
95
104
- **[To Do]** Develop Analytics dashboards for tool usage and performance.
0 commit comments