Skip to content

Commit 27db9d4

Browse files
committed
feat: Add quick start guide to documentation and update teams structure description
1 parent c8fad50 commit 27db9d4

File tree

3 files changed

+129
-149
lines changed

3 files changed

+129
-149
lines changed

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
"group": "Essentials",
1818
"pages": [
1919
"index",
20+
"general/quick-start",
2021
"general/architecture",
2122
"general/teams",
2223
"general/roles",

general/quick-start.mdx

Lines changed: 127 additions & 149 deletions
Original file line numberDiff line numberDiff line change
@@ -1,218 +1,196 @@
11
---
22
title: Quick Start
3-
description: Get started with DeployStack in minutes - create your free account, configure MCP servers, and connect instantly with just a URL.
3+
description: Start using MCP tools in under 1 minute with DeployStack - no installation, no configuration files, just connect and go.
44
---
55

66
# Quick Start
77

8-
Get started with DeployStack in minutes. This guide walks you through creating a free account, configuring your first MCP server, and connecting your development environment with zero installation.
8+
Get your first MCP tools running in under 1 minute. We've eliminated the installation friction that holds back MCP adoption - just create an account, click a button, and connect. Your account comes with a pre-installed MCP server ready to test immediately.
99

1010
## What You'll Accomplish
1111

1212
By the end of this guide, you'll have:
13-
- A free DeployStack account with team management
14-
- Your first MCP server configured with secure credentials
15-
- Instant access to MCP tools via satellite URL
16-
- VS Code connected to your team's MCP tools
13+
- A DeployStack account with one pre-installed MCP server
14+
- Your MCP client (VS Code, Cursor, or Claude Desktop) connected to DeployStack Satellite
15+
- Working MCP tools accessible through your client
16+
- Understanding of how to add more MCP servers
17+
18+
**Time Required:** Under 1 minute (not counting account creation)
1719

1820
## Prerequisites
1921

20-
- **VS Code or Cursor**: For MCP tool integration
21-
- **A few minutes**: This entire setup takes less than 3 minutes
22-
- **No installations required**: Zero local dependencies
22+
You need just two things:
23+
24+
- **An MCP Client**: VS Code, Cursor IDE, or Claude Desktop
25+
- **A Web Browser**: For OAuth authorization
26+
- **That's it**: No installations, no CLI tools, no configuration file editing
2327

24-
## Step 1: Create Your Free Account
28+
## The 3-Step Setup
29+
30+
### Step 1: Create Your Account
2531

2632
<Steps>
27-
<Step title="Sign Up for DeployStack">
28-
Visit [cloud.deploystack.io](https://cloud.deploystack.io) and create your free account:
33+
<Step title="Sign Up">
34+
Visit [cloud.deploystack.io](https://cloud.deploystack.io) and create your free account.
2935

30-
- Sign up with your email address or GitHub account
31-
- Complete email verification if required
32-
- You'll automatically get your own default team
36+
You can sign up with:
37+
- Email address
38+
- GitHub account
3339
</Step>
3440

3541
<Step title="Explore Your Dashboard">
36-
Once logged in, you'll see preinstalled MCP servers in your dashboard.
37-
We have preinstalled popular MCP servers like Sequential Thinking. You can add more whenever you want to.
42+
Once logged in, you'll see your dashboard with:
43+
- One pre-installed MCP server ready to use
44+
- "Get Client Configuration" button in the top-right corner
45+
- Empty team space ready for collaboration
46+
47+
We pre-install a demo MCP server so you can test the platform immediately without adding anything first.
3848
</Step>
3949
</Steps>
4050

41-
## Step 2: Get Your OAuth Credentials
51+
### Step 2: Connect Your MCP Client
4252

43-
DeployStack Satellite provides instant MCP access through managed infrastructure - no installation required.
53+
Now connect your MCP client to DeployStack Satellite. This is where the "zero installation" comes in - no CLI tools to install, no npm packages to manage, just click and connect.
4454

4555
<Steps>
46-
<Step title="Create OAuth Client Credentials">
56+
<Step title="Get Your Configuration">
4757
In your DeployStack dashboard:
4858

49-
1. Navigate to the **Satellite** section
50-
2. Click **Create MCP Client Credentials**
51-
3. Enter a name for your client (e.g., "VS Code", "Claude Desktop")
52-
4. Copy the generated OAuth credentials:
53-
- **Client ID**: `deploystack_mcp_client_abc123def456ghi789`
54-
- **Client Secret**: `deploystack_mcp_secret_xyz789abc123def456ghi789jkl012`
59+
1. Click the **"Get Client Configuration"** button (top-right corner)
60+
2. A modal opens showing supported MCP clients
61+
3. Select your client from the dropdown:
62+
- VS Code
63+
- Cursor IDE
64+
- Claude Desktop
65+
</Step>
66+
67+
<Step title="Install or Copy Configuration">
68+
Depending on your client, you'll see one of two options:
69+
70+
**For Cursor IDE:**
71+
- Click the **"Install in Cursor"** button
72+
- Cursor opens automatically with configuration applied
73+
- Done! Skip to Step 3
5574

56-
These OAuth credentials provide secure access to your team's MCP servers through standard OAuth Bearer Token authentication.
75+
**For VS Code or Claude Desktop:**
76+
- Copy the JSON configuration shown in the modal
77+
- Open your MCP client settings
78+
- Paste the configuration
79+
- Save the settings file
5780
</Step>
5881
</Steps>
5982

60-
## Step 3: Connect Your Development Environment
83+
<Callout type="info">
84+
**What Just Happened?**
85+
86+
You added the DeployStack Satellite URL to your MCP client. Instead of running MCP servers locally, your client now connects to our managed infrastructure where your MCP servers run securely with your team's credentials.
87+
</Callout>
88+
89+
### Step 3: Authorize the Connection
6190

62-
Now connect VS Code or Cursor to use your team's MCP servers via satellite.
91+
The final step happens automatically when you connect - DeployStack uses OAuth2.1 for secure, credential-free authorization.
6392

6493
<Steps>
65-
<Step title="Configure VS Code MCP Settings">
66-
Open your VS Code settings and configure MCP to use the DeployStack Satellite.
67-
68-
**Location**: `.vscode/settings.json` or global VS Code settings
69-
70-
**Before** (manual MCP server management):
71-
72-
```json
73-
{
74-
"mcpServers": {
75-
"github": {
76-
"command": "npx",
77-
"args": ["@github/mcp"],
78-
"env": {
79-
"GITHUB_TOKEN": "your-token-here"
80-
}
81-
}
82-
}
83-
}
84-
```
85-
86-
**After** (DeployStack Satellite):
87-
88-
```json
89-
{
90-
"mcpServers": {
91-
"deploystack": {
92-
"url": "https://satellite.deploystack.io/mcp",
93-
"oauth": {
94-
"client_id": "deploystack_mcp_client_abc123def456ghi789",
95-
"client_secret": "deploystack_mcp_secret_xyz789abc123def456ghi789jkl012"
96-
},
97-
"name": "DeployStack Satellite",
98-
"description": "MCP-as-a-Service with zero installation"
99-
}
100-
}
101-
}
102-
```
94+
<Step title="Start Connection">
95+
In your MCP client:
96+
- Click **"Connect"** or **"Start"** next to the DeployStack Satellite entry
97+
- Your web browser opens automatically
10398
</Step>
10499

105-
<Step title="Test MCP Connection">
106-
1. **Restart VS Code** to load the new MCP configuration
107-
2. **Open Claude or compatible MCP client**
108-
3. **Test a tool**: Try using one of your configured MCP servers
109-
4. **Verify**: Tools should work instantly without any local setup
100+
<Step title="Select Team and Authorize">
101+
In the browser window:
102+
1. You'll see your available teams
103+
2. Select the team you want to use
104+
3. Click **"Authorize"**
105+
4. Browser window closes automatically
106+
</Step>
107+
108+
<Step title="Connected!">
109+
Back in your MCP client:
110+
- Connection status shows "Connected"
111+
- Your pre-installed MCP server is now available
112+
- You can start using MCP tools immediately
110113
</Step>
111114
</Steps>
112115

113-
## Step 4: Explore Your Setup
116+
## Verify It Works
114117

115-
Now that everything is connected, explore what you can do:
118+
Let's make sure your MCP connection is working by testing your pre-installed server.
116119

117120
<Steps>
118-
<Step title="Test Available Tools">
119-
In your VS Code MCP client:
120-
- All configured MCP tools are instantly available
121-
- No local processes or installations required
122-
- Tools automatically include your team's credentials
121+
<Step title="Open Your MCP Client">
122+
In VS Code, Cursor, or Claude Desktop, open the MCP tools panel or command palette.
123123
</Step>
124124

125-
<Step title="Monitor Usage">
126-
View activity in your [DeployStack dashboard](https://cloud.deploystack.io):
127-
- Real-time MCP tool usage
128-
- Team activity and analytics
129-
- Satellite performance metrics
125+
<Step title="Check Available Tools">
126+
You should see tools from your pre-installed MCP server listed.
127+
128+
Try running one of the available tools to confirm everything works.
130129
</Step>
131130

132-
<Step title="Manage Your Team">
133-
Back in the [DeployStack dashboard](https://cloud.deploystack.io):
134-
- Add more MCP servers to your team
135-
- Manage credentials securely
136-
- Monitor satellite usage
131+
<Step title="View in Dashboard">
132+
Go back to [cloud.deploystack.io](https://cloud.deploystack.io) and check:
133+
- Your dashboard shows connection activity
134+
- You can see which MCP server is active
135+
- Usage analytics start appearing
137136
</Step>
138137
</Steps>
139138

140-
## Managing Your Satellite Connection
141-
142-
With DeployStack Satellite, management is done through the web dashboard:
143-
144-
- **Configuration**: All changes made in [cloud.deploystack.io](https://cloud.deploystack.io)
145-
- **Instant Updates**: Changes take effect immediately, no local updates needed
146-
- **Team Switching**: Change teams in the dashboard, regenerate token if needed
147-
- **Monitoring**: View real-time usage and performance metrics
148-
- **Zero Maintenance**: No local processes to start, stop, or restart
149-
150-
## Multiple Teams
151-
152-
If you're part of multiple teams or create additional teams:
153-
154-
1. **Switch Teams**: Use the team selector in your [DeployStack dashboard](https://cloud.deploystack.io)
155-
2. **Generate New OAuth Credentials**: Each team requires separate OAuth client credentials for security
156-
3. **Update VS Code**: Replace the oauth client_id and client_secret with the new team's credentials
157-
4. **Instant Access**: New team's MCP tools are immediately available
158-
159-
When you switch teams:
160-
- New team's MCP servers become available instantly
161-
- Previous team's tools are no longer accessible (security isolation)
162-
- All team-specific credentials are automatically applied
139+
<Callout type="success">
140+
**🎉 You're Done!**
141+
142+
You now have a working MCP connection through DeployStack Satellite. Your pre-installed MCP server is running on managed infrastructure, and you can add more servers anytime from the catalog.
143+
</Callout>
163144

164145
## What's Next?
165146

166147
### Add More MCP Servers
167148

168-
Expand your toolkit by adding more MCP servers:
169-
- **BrightData**: Web scraping and data collection
170-
- **Weather**: Weather information and forecasts
171-
- **Database**: Connect to your databases
172-
- **Custom Servers**: Add your own private MCP servers
149+
Your account comes with one pre-installed server, but DeployStack offers access to hundreds of MCP servers from the official registry:
173150

174-
### Team Collaboration
151+
1. **Browse the Catalog**: Visit the [MCP Server](https://cloud.deploystack.io/) in your dashboard
152+
2. **Choose Servers**: Browse by category or search for specific tools
153+
3. **Add to Team**: Click "Add to Team" on any server
154+
4. **Configure Credentials**: Add required credentials (API keys, tokens, etc.)
155+
5. **Instant Access**: Server appears in your MCP client immediately
175156

176-
If you're working with a team:
177-
- **[Invite Team Members](/onboard-new-team-members)**: Add developers to your team
178-
- **[Manage Roles](/roles)**: Set up proper access control
179-
- **[Team Management](/teams)**: Organize multiple projects
157+
For more details, see the [MCP Server Catalog Guide](/general/mcp-catalog).
180158

181-
## Troubleshooting
159+
### Invite Team Members
182160

183-
### Satellite Connection Issues
161+
DeployStack is built for team collaboration:
184162

185-
1. **Check OAuth credentials**:
186-
- Verify your client_id and client_secret are correct
187-
- Regenerate OAuth credentials in dashboard if needed
163+
1. **Navigate to Team Settings**: Go to your team page
164+
2. **Click "Invite Members"**: Enter email addresses
165+
3. **Set Roles**: Choose appropriate permissions
166+
4. **Send Invitations**: Team members receive email invitations
167+
5. **Instant Sharing**: Once they accept, they get access to all team MCP servers
188168

189-
2. **Verify VS Code configuration**:
190-
- Ensure the satellite URL is `https://satellite.deploystack.io/mcp`
191-
- Check oauth section has your current client_id and client_secret
192-
- Restart VS Code after configuration changes
169+
## Working with Multiple Teams
193170

194-
3. **Test connection**:
195-
```bash
196-
curl -X POST https://satellite.deploystack.io/mcp \
197-
-H "Content-Type: application/json" \
198-
-H "Authorization: Bearer YOUR_OAUTH_TOKEN" \
199-
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
200-
```
171+
If you're part of multiple teams or create additional teams:
201172

202-
### MCP Tools Not Working
173+
1. **Switch Teams in Dashboard**: Use the team selector at [cloud.deploystack.io](https://cloud.deploystack.io)
174+
2. **Disconnect in MCP Client**: Disconnect from DeployStack Satellite
175+
3. **Reconnect**: Click "Connect" again
176+
4. **Choose Different Team**: In the OAuth browser window, select the new team
177+
5. **Authorize**: Your MCP client now uses the new team's servers
203178

204-
1. **Check satellite status**: Visit your [dashboard](https://cloud.deploystack.io) for real-time status
205-
2. **Verify credentials**: Ensure OAuth credentials are properly configured for your team
206-
3. **Client permissions**: Confirm your OAuth client has access to the required MCP servers
179+
**Each team has:**
180+
- Separate MCP server configurations
181+
- Independent credentials and API keys
182+
- Isolated usage and analytics
183+
- Team-specific access control
207184

208-
### Need Help?
185+
## Get Help
209186

210-
- **Community**: Join our [Discord](https://discord.gg/42Ce3S7b3b)
211-
- **Documentation**: Browse our [full documentation](/)
212-
- **Support**: Contact support for technical issues
187+
### Community Support
213188

214-
---
189+
- **Discord**: Join our [Discord community](https://discord.gg/42Ce3S7b3b) for real-time help
190+
- **GitHub Discussions**: Ask questions at [github.com/deploystackio/deploystack](https://github.com/deploystackio/deploystack)
215191

216-
**🎉 Congratulations!** You now have DeployStack Satellite configured and running. Your development environment is connected to enterprise-grade MCP management with zero installation, secure credential handling, and instant team collaboration.
192+
### Documentation
217193

218-
**Next Steps**: Explore the [MCP Catalog](https://cloud.deploystack.io) to add more tools to your team, or invite colleagues to collaborate on your projects.
194+
- **Full Docs**: Browse our complete documentation at [docs.deploystack.io](https://docs.deploystack.io)
195+
- **MCP Catalog**: Learn about available servers at [MCP Server Catalog](/general/mcp-catalog)
196+
- **Team Management**: Read [Team Management Guide](/general/teams) for collaboration features

general/teams.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Teams Structure in DeployStack
33
description: Organize your MCP server management with teams - your workspace for managing servers and configurations in DeployStack.
4+
sidebarTitle: Teams
45
---
56

67
# Teams

0 commit comments

Comments
 (0)