Add Server to Stack

Overview

Adds a server from the ToolRouter marketplace to an existing stack. You can specify which tools to enable when adding the server, or enable all tools at once.

Endpoint

POST https://api.toolrouter.ai/v1/stacks/{stack_id}/servers

Authentication

This endpoint requires an API key. Include it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Path Parameters

string

required

The unique identifier of the stack to add the server to

Request Body

string

required

The unique identifier of the server to add to the stack

boolean

default:"false"

Whether to enable all available tools for this server

array

Array of specific tool IDs to enable. Only used if enable_all_tools is false.

Show Tool Selection

If enable_all_tools is true, all tools from the server will be enabled
If enable_all_tools is false and enabled_tools is provided, only those tools will be enabled
If enable_all_tools is false and enabled_tools is not provided, no tools will be enabled initially

Response

string

Confirmation message indicating the server was added successfully and how many tools were enabled

Example Request

Add Server with All Tools Enabled

curl -X POST "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000/servers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": "gmail",
    "enable_all_tools": true
  }'

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
    "server_id": "gmail",
    "enable_all_tools": True
}

response = requests.post(
    "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000/servers",
    headers=headers,
    json=data
)

result = response.json()

const response = await fetch('https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000/servers', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    server_id: "gmail",
    enable_all_tools: true
  })
});

const result = await response.json();

Add Server with Specific Tools

curl -X POST "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000/servers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": "gmail",
    "enable_all_tools": false,
    "enabled_tools": ["gmail_send_email", "gmail_search_emails"]
  }'

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
    "server_id": "gmail",
    "enable_all_tools": False,
    "enabled_tools": ["gmail_send_email", "gmail_search_emails"]
}

response = requests.post(
    "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000/servers",
    headers=headers,
    json=data
)

result = response.json()

Add Server with No Tools (Configure Later)

curl -X POST "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000/servers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": "gmail",
    "enable_all_tools": false
  }'

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
    "server_id": "gmail",
    "enable_all_tools": False
}

response = requests.post(
    "https://api.toolrouter.ai/v1/stacks/stack_123e4567-e89b-12d3-a456-426614174000/servers",
    headers=headers,
    json=data
)

result = response.json()

Example Responses

All Tools Enabled

{
  "message": "Server gmail added to stack stack_123e4567-e89b-12d3-a456-426614174000 with 5 tools enabled"
}

Specific Tools Enabled

{
  "message": "Server gmail added to stack stack_123e4567-e89b-12d3-a456-426614174000 with 2 tools enabled"
}

No Tools Enabled

{
  "message": "Server gmail added to stack stack_123e4567-e89b-12d3-a456-426614174000 with 0 tools enabled"
}

Workflow

After adding a server to a stack:

Configure credentials: Use the Update Credentials endpoint to add required credentials
Enable/disable tools: Use the Update Server Tools endpoint to modify enabled tools
Test tools: Use the Invoke Tool endpoint to test functionality

Error Responses

Server already exists in stack or invalid parameters

{
  "detail": "Server gmail already exists in stack"
}

Invalid or missing API key

{
  "detail": "Unauthorized"
}

Stack or server not found

{
  "detail": "Stack not found"
}

{
  "detail": "Server gmail not found"
}

Rate limit exceeded

{
  "detail": "Too many requests"
}

Server error occurred

{
  "detail": "Failed to add server to stack"
}

Best Practices

Check server availability: Use the List Servers endpoint to see available servers and their tools
Plan tool selection: Review tool descriptions and parameters before enabling
Start with specific tools: Consider enabling only the tools you need rather than all tools
Configure credentials early: Add required credentials immediately after adding the server

API Documentation

Stack Specific Endpoints

Account Management API

Stack Management

Server Management

Credentials Management

Tools Management

SDK

Overview

Endpoint

Authentication

Path Parameters

Request Body

Response

Example Request

Add Server with All Tools Enabled

Add Server with Specific Tools

Add Server with No Tools (Configure Later)

Example Responses

All Tools Enabled

Specific Tools Enabled

No Tools Enabled

Workflow

Error Responses

Best Practices

​Overview

​Endpoint

​Authentication

​Path Parameters

​Request Body

​Response

​Example Request

​Add Server with All Tools Enabled

​Add Server with Specific Tools

​Add Server with No Tools (Configure Later)

​Example Responses

​All Tools Enabled

​Specific Tools Enabled

​No Tools Enabled

​Workflow

​Error Responses

​Best Practices

Overview

Endpoint

Authentication

Path Parameters

Request Body

Response

Example Request

Add Server with All Tools Enabled

Add Server with Specific Tools

Add Server with No Tools (Configure Later)

Example Responses

All Tools Enabled

Specific Tools Enabled

No Tools Enabled

Workflow

Error Responses

Best Practices