Skip to content

quick-start.mdx

Latest commit

 

History

History
298 lines (213 loc) · 7.07 KB

quick-start.mdx

File metadata and controls

298 lines (213 loc) · 7.07 KB
Raw
title Quick Start
description Get started with DeployStack in minutes - create your free account, set up MCP servers, and install the gateway locally.
sidebar Quick Start
icon Zap

import { Callout } from 'fumadocs-ui/components/callout'; import { Tabs, Tab } from 'fumadocs-ui/components/tabs'; import { Steps, Step } from 'fumadocs-ui/components/steps';

Quick Start

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.

What You'll Accomplish

By the end of this guide, you'll have:

  • A free DeployStack account with team management
  • Your first MCP server configured with secure credentials
  • The DeployStack Gateway running locally
  • VS Code connected to your team's MCP tools

Prerequisites

  • Node.js: Install Node.js (v18 or higher)
  • VS Code or Cursor: For MCP tool integration
  • A few minutes: This entire setup takes less than 5 minutes

Step 1: Create Your Free Account

**Sign Up for DeployStack** 
Visit [cloud.deploystack.io](https://cloud.deploystack.io) and create your free account:

- Sign up with your email address or GitHub account
- Complete email verification if required
- You'll automatically get your own default team
**Explore Your Dashboard** 
Once logged in, you'll see preinstalled MCP servers in your dashboard.
We have preinstalled popular MCP servers like Sequential Thinking. You can add more whenever you want to.

Step 2: Install and Configure the Gateway

The DeployStack Gateway runs locally and connects your development tools to your team's MCP servers.

**Install the Gateway** 
Install the DeployStack Gateway globally via npm:

```bash
npm install -g @deploystack/gateway
```
**Login to DeployStack** 
Authenticate with your DeployStack account:

```bash
deploystack login
```

This will:
- Open a browser window for authentication
- Download your team's MCP server configurations
- Set up secure credential access

Login command will pull your MCP configurations and credentials from the cloud.deploystack.io and start the DeployStack gateway.
**Verify Gateway Status** 
Check that everything is working:

```bash
deploystack status
```

You should see:
- Gateway status: Running
- Your team name
- List of available MCP servers

Step 3: Connect Your Development Environment

Now connect VS Code or Cursor to use your team's MCP servers.

**Configure VS Code MCP Settings** 
Open your VS Code settings and configure MCP to use the DeployStack Gateway.

**Location**: `.vscode/settings.json` or global VS Code settings

**Before** (manual MCP server management):

```json
{
  "mcpServers": {
    "github": {
      "command": "npx",
      "args": ["@github/mcp"],
      "env": {
        "GITHUB_TOKEN": "your-token-here"
      }
    }
  }
}
```

**After** (DeployStack Gateway):

```json
{
  "mcpServers": {
    "deploystack": {
      "url": "http://localhost:9095/sse",
      "name": "DeployStack Gateway",
      "description": "Enterprise MCP Gateway with team-based access control"
    }
  }
}
```
**Test MCP Connection** 
1. **Restart VS Code** to load the new MCP configuration
2. **Open Claude or compatible MCP client**
3. **Test a tool**: Try using one of your configured MCP servers
4. **Verify**: Tools should work without any manual credential setup

Step 4: Explore Your Setup

Now that everything is connected, explore what you can do:

**List Available Tools** 
See all MCP tools available through your gateway:

```bash
deploystack mcp
```

This shows all tools from your team's MCP servers with their descriptions.
**Monitor Gateway Activity** 
View real-time logs and activity:

```bash
deploystack logs
```

This shows MCP server activity, tool usage, and any issues.
**Manage Your Team** 
Back in the [DeployStack dashboard](https://cloud.deploystack.io):
- Add more MCP servers to your team
- Manage credentials securely

Common Gateway Commands

Here are the essential commands you'll use regularly:

# Check gateway status
deploystack status

# Start the gateway
deploystack start

# Stop the gateway
deploystack stop

# Restart the gateway
deploystack restart

# View logs
deploystack logs

# List available MCP tools
deploystack mcp

# Update configurations from cloud
deploystack refresh

# Switch teams (if you have multiple)
deploystack teams

Multiple Teams

If you're part of multiple teams or create additional teams:

# List your teams
deploystack teams

# Switch to a specific team
deploystack teams --switch 2

# Check current team context
deploystack status

When you switch teams, the gateway automatically:

  • Downloads new team configurations
  • Starts the new team's MCP servers
  • Stops the previous team's servers
  • Updates available tools

What's Next?

Add More MCP Servers

Expand your toolkit by adding more MCP servers:

  • BrightData: Web scraping and data collection
  • Weather: Weather information and forecasts
  • Database: Connect to your databases
  • Custom Servers: Add your own private MCP servers

Team Collaboration

If you're working with a team:

Troubleshooting

Gateway Won't Start

# Check if you're logged in
deploystack status

# Re-login if needed
deploystack login

# Check for port conflicts
lsof -i :9095

MCP Tools Not Working

  1. Check gateway status:

    deploystack status

  2. Verify VS Code configuration:

    • Ensure the MCP server URL is http://localhost:9095/sse
    • Restart VS Code after configuration changes

  3. Check credentials:

    • Verify credentials are properly configured in your dashboard
    • Test credentials directly in the DeployStack interface

Need Help?

🎉 Congratulations! You now have DeployStack configured and running. Your development environment is connected to enterprise-grade MCP management with secure credential handling and team collaboration features.

Next Steps: Explore the MCP Catalog to add more tools to your team, or invite colleagues to collaborate on your projects.