Skip to content

Commit 8938a50

Browse files
author
Lasim
committed
docs: update MCP endpoint in gateway README to reflect new default port
1 parent ee4d2cb commit 8938a50

File tree

2 files changed

+38
-27
lines changed

2 files changed

+38
-27
lines changed

README.md

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,15 @@ DeployStack was built to solve these problems head-on.
2323

2424
DeployStack introduces a powerful Control Plane / Data Plane architecture to bring order to the chaos.
2525

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+
2728
- **Centralized Credential Vault**: Securely store all your MCP server credentials (API keys, tokens) in one encrypted location.
2829
- **Access Control Policies**: Define which teams and users have permission to access which MCP Server.
2930
- **MCP Catalog**: Manage a central catalog of all approved MCP servers (local, remote (coming soon), or third-party (coming soon)).
3031
- **Audit & Analytics**: Gain visibility into which tools are being used, by whom, and how often.
3132

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+
3335
- **One-Time Login**: Developers log in once. The Gateway securely fetches the configurations they are authorized to use.
3436
- **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.
3537
- **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
3941

4042
## 🚀 How It Works: A Quick Tour
4143

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**:
4749
- The Gateway receives the request.
4850
- It sees it's for `github` mcp and checks if the process is running.
4951
- 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
5456

5557
### For Administrators & Team Leads
5658

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`.
6163

6264
### For Developers
6365

64-
1. **Install the Gateway**:
66+
1. **Install the Gateway**:
67+
6568
```bash
6669
# Installation command coming soon
6770
npm install -g @deploystack/gateway
6871
```
69-
2. **Login**:
72+
73+
2. **Login**:
74+
7075
```bash
7176
deploystack login
7277
```
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.
7581

7682
## Roadmap
7783

7884
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.
7985

80-
**Phase 1: Foundation (Completed)**
86+
### Phase 1: Foundation (Completed)
87+
8188
- **[Done]** Deployed `cloud.deploystack.io` hosted version with a robust backend and frontend.
8289
- **[Done]** Implemented a secure user and team management system with roles and permissions.
8390
- **[Done]** Integrated OAuth for secure logins (e.g., GitHub).
8491
- **[Done]** Created the initial MCP Server Catalog for tool discovery.
8592
- **[Done]** Established documentation and self-hosted Docker support.
8693

87-
**Phase 2: The Secure Gateway (Current Focus)**
94+
### Phase 2: The Secure Gateway (Current Focus)
95+
8896
- **[In Progress]** Develop the `DeployStack Gateway` local application.
8997
- **[In Progress]** Implement secure authentication and configuration synchronization between the Gateway and the cloud.
9098
- **[To Do]** Build the on-demand `stdio` process spawning and management logic.
9199
- **[To Do]** Add support for proxying to remote, HTTP-based MCP servers.
92100

93-
**Phase 3: Enterprise Governance**
101+
### Phase 3: Enterprise Governance
102+
94103
- **[To Do]** Build out Audit Logging features in the cloud UI.
95104
- **[To Do]** Develop Analytics dashboards for tool usage and performance.
96105
- **[To Do]** Implement advanced policy controls (e.g., rate limiting, request validation).
97106

98-
**Phase 4: Ecosystem & Integration**
107+
### Phase 4: Ecosystem & Integration
108+
99109
- **[To Do]** Introduce OAuth2 support for delegated authentication to backend services.
100110
- **[To Do]** Enhance the searchable MCP Server Catalog within the cloud UI.
101111
- **[To Do]** Deeper integration with IDEs and AI agent frameworks.
@@ -118,11 +128,11 @@ deploystack/
118128

119129
We are excited about this new direction and welcome contributions. The most immediate need is help building the `DeployStack Gateway`.
120130

121-
1. Fork this repository.
122-
2. Create your feature branch (`git checkout -b feature/gateway-stdio-spawner`).
123-
3. Commit your changes following our [commit guidelines](CONTRIBUTING.md#commit-message-guidelines).
124-
4. Push to the branch (`git push origin feature/gateway-stdio-spawner`).
125-
5. Open a Pull Request.
131+
1. Fork this repository.
132+
2. Create your feature branch (`git checkout -b feature/gateway-stdio-spawner`).
133+
3. Commit your changes following our [commit guidelines](CONTRIBUTING.md#commit-message-guidelines).
134+
4. Push to the branch (`git push origin feature/gateway-stdio-spawner`).
135+
5. Open a Pull Request.
126136

127137
For detailed contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
128138

services/gateway/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,9 @@ deploystack-gateway status
5050
After logging in, the gateway automatically downloads and synchronizes your team's configuration. No manual configuration required!
5151

5252
Your development tools (VS Code, Cursor, etc.) should be configured to use:
53-
```
54-
MCP Endpoint: http://localhost:8080/mcp
53+
54+
```text
55+
MCP Endpoint: http://localhost:9095/mcp
5556
```
5657

5758
## 🤝 Contributing
@@ -64,4 +65,4 @@ We welcome contributions! This is a new service in active development.
6465
4. Push to the branch (`git push origin feature/gateway-improvement`)
6566
5. Open a Pull Request
6667

67-
For detailed contribution guidelines, see [CONTRIBUTING.md](../../CONTRIBUTING.md) in the project root.
68+
For detailed contribution guidelines, see [CONTRIBUTING.md](../../CONTRIBUTING.md) in the project root.

0 commit comments

Comments
 (0)