Configuring Omnistrate MCP Server¶

Connect your AI tools to Omnistrate using the Model Context Protocol (MCP), an open standard that lets AI assistants interact with your Omnistrate services and infrastructure.

What is Omnistrate MCP?¶

Omnistrate MCP is Omnistrate's official MCP server. It is a local MCP server that gives AI tools secure access to your Omnistrate projects and resources through the omnistrate-ctl command-line interface.

It integrates with popular AI assistants like Claude, enabling you to:

• Search and navigate Omnistrate documentation and knowledge base
• Manage services, environments, and service plans
• Create and manage instances and deployments
• Monitor service health and operational events
• Manage subscriptions and customer access
• Configure deployment cells and cloud accounts
• Analyze costs and audit logs

Connecting to Omnistrate MCP¶

To use Omnistrate MCP, you need to have omnistrate-ctl installed and configured on your system. The MCP server communicates with Omnistrate through your local CLI installation.

Prerequisites¶

• omnistrate-ctl CLI tool installed and in your PATH
• Omnistrate account with appropriate permissions
• Authentication configured for your Omnistrate account

Supported clients¶

Omnistrate MCP can be integrated with various AI tools and IDEs that support the Model Context Protocol:

• Claude Code
• Claude.ai and Claude for Desktop
• Cursor
• VS Code with Copilot
• Cline
• Windsurf
• Gemini Code Assist
• Gemini CLI

Recommended agent instructions¶

For optimal performance and safety when using Omnistrate MCP with AI agents, we recommend using the instructions provided in the Omnistrate Agent Instructions repository.

These instructions are designed to:

• Guide AI agents on best practices for interacting with Omnistrate
• Ensure proper handling of sensitive operations
• Improve the quality and reliability of agent-assisted workflows
• Provide context-specific guidance for common Omnistrate tasks

Visit the agent-instructions repository to access the recommended instructions and integrate them into your AI agent configuration.

Setup¶

Connect your AI client to Omnistrate MCP and authorize access to manage your Omnistrate infrastructure.

Claude Code¶

# Install Claude Code
npm install -g @anthropic-ai/claude-code

# Navigate to your project
cd your-awesome-project

# Add Omnistrate MCP
claude mcp add --transport stdio omnistrate omnistrate-ctl mcp start

# Start coding with Claude
claude

# Authenticate the MCP tools by typing /mcp
/mcp

Claude.ai and Claude for Desktop¶

Custom connectors using remote MCP are available on Claude and Claude Desktop for users on Pro, Max, Team, and Enterprise plans.

1. Open Settings in the sidebar
2. Navigate to Connectors and select Add custom connector
3. Configure the connector:
4. Name: Omnistrate
5. Command: omnistrate-ctl mcp start

Cursor¶

Add the snippet below to your project-specific or global .cursor/mcp.json file:

{
  "mcpServers": {
    "omnistrate": {
      "command": "omnistrate-ctl",
      "args": ["mcp", "start"]
    }
  }
}

Once the server is added, Cursor will attempt to connect. Ensure your Omnistrate credentials are configured.

VS Code with Copilot¶

Installation¶

1. Open the Command Palette (Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on macOS)
2. Run MCP: Add Server
3. Select Stdio
4. Enter the following details:
5. Command: omnistrate-ctl
6. Arguments: mcp start
7. Name: Omnistrate
8. Select Global or Workspace depending on your needs
9. Click Add

Authorization¶

Now that you've added Omnistrate MCP, let's start the server:

1. Open the Command Palette (Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on macOS)
2. Run MCP: List Servers
3. Select Omnistrate
4. Click Start Server
5. Ensure your Omnistrate credentials are configured in your environment

Cline¶

Add Omnistrate MCP to your Cline configuration:

1. Open Cline settings
2. Add a new MCP server:
3. Name: Omnistrate
4. Command: omnistrate-ctl
5. Arguments: mcp start
6. Save and restart Cline

Windsurf¶

Add the snippet below to your mcp_config.json file:

{
  "mcpServers": {
    "omnistrate": {
      "command": "omnistrate-ctl",
      "args": ["mcp", "start"]
    }
  }
}

Gemini Code Assist¶

To set up Omnistrate MCP with Gemini Code Assist:

1. Ensure you have Gemini Code Assist installed in your IDE
2. Add the following configuration to your ~/.gemini/settings.json file:

{
  "mcpServers": {
    "omnistrate": {
      "command": "omnistrate-ctl",
      "args": ["mcp", "start"]
    }
  }
}

1. Restart your IDE to apply the configuration
2. Ensure your Omnistrate credentials are configured

Gemini CLI¶

Gemini CLI shares the same configuration as Gemini Code Assist. To set up Omnistrate MCP with Gemini CLI:

1. Ensure you have the Gemini CLI installed
2. Add the following configuration to your ~/.gemini/settings.json file:

{
  "mcpServers": {
    "omnistrate": {
      "command": "omnistrate-ctl",
      "args": ["mcp", "start"]
    }
  }
}

1. Run the Gemini CLI and use the /mcp list command to see available MCP servers
2. Ensure your Omnistrate credentials are configured

Setup steps may vary based on your MCP client version. Always check your client's documentation for the latest instructions.

Security best practices¶

The MCP ecosystem and technology are evolving quickly. Here are our current best practices to help you keep your workspace secure:

Verify your setup¶

• Ensure omnistrate-ctl is installed from the official Omnistrate repository
• Verify that your Omnistrate credentials are properly configured

Trust and verification¶

• Connecting to Omnistrate MCP grants the AI system you're using the same access as your Omnistrate user account
• Review the permissions and access levels of each AI tool you connect

Enable human confirmation¶

• Always enable human confirmation in your workflows to maintain control and prevent unauthorized changes
• Prevents accidental or harmful changes to your services and deployments