Server deployments in Metorial define which integrations your AI agent can access. This guide explains how to set them up and use them effectively.

What are Server Deployments?

Server deployments are collections of integrations that you configure in your Metorial dashboard. Each deployment has a unique ID and contains specific tools and services your agent can use.

Finding Your Server Deployment ID

1. Log in to your Metorial dashboard
2. Navigate to the "Deployments" or "Servers" section
3. Find or create a deployment
4. Copy the deployment ID

Using a Single Deployment

await metorial.withProviderSession(
  metorialOpenAI.chatCompletions,
  { 
    serverDeployments: ['deployment-id-here']
  },
  async session => {
    // Your code here
  }
);

Using Multiple Deployments

You can combine tools from multiple deployments:

await metorial.withProviderSession(
  metorialOpenAI.chatCompletions,
  { 
    serverDeployments: [
      'github-deployment-id',
      'calendar-deployment-id',
      'crm-deployment-id'
    ]
  },
  async session => {
    // Agent now has access to tools from all three deployments
  }
);

Best Practices

Organize by Function

Create separate deployments for different purposes:

• A "productivity" deployment with calendar and email tools
• A "development" deployment with GitHub and Jira
• A "customer-data" deployment with CRM and support tools

Use Environment Variables

Store deployment IDs in environment variables:

// .env
METORIAL_GITHUB_DEPLOYMENT=deployment-id-1
METORIAL_CALENDAR_DEPLOYMENT=deployment-id-2

// In your code
const deployments = [
  process.env.METORIAL_GITHUB_DEPLOYMENT,
  process.env.METORIAL_CALENDAR_DEPLOYMENT
].filter(Boolean);

await metorial.withProviderSession(
  metorialOpenAI.chatCompletions,
  { serverDeployments: deployments },
  async session => {
    // Your code
  }
);

Different Deployments for Different Environments

Use different deployments for development and production to control which integrations are available in each environment.

Troubleshooting

"No tools available" error: Check that your deployment ID is correct and that you've configured integrations in that deployment.

"Deployment not found" error: Verify the deployment ID exists in your Metorial dashboard and that your API key has access to it.