Configure Instaclustr API Server MCP Backend and Tools

Instaclustr API Server MCP Backend

To create a Backend for MCP Virtual Server go to MCP Virtual Server details page and click “Create Backend”

The Instaclustr API backend is a platform-managed backend. MCP tools on this backend proxy HTTP operations to the Instaclustr API. Name, connection settings, and tools are assigned by Instaclustr and cannot be modified. Currently, all MCP tools are configured Read-only API operations,

Select Backend Type “Instaclustr API”. The backend name is set to instaclustr-api.

Select one or both API components to attach to the backend. MCP tools are created automatically from the selected components:

Cluster Management API Core: covers cluster details and operational state.

Monitoring API Core: covers metrics.

See Appendix section for tools detail.

Select the API user that MCP Gateway will use to call the Instaclustr API. You can use an account user or a Service User. See Add a new user for account users, and Service Users for Service Users. Create the required API keys for that user before you create the backend; otherwise the request will fail. See API Keys.

Cluster Management API related operation requires a Read Only Provisioning API key.

Monitoring API related requires a Monitoring API key.

Instaclustr APIs are subject to rate limits, and requests that exceed a throttling limit fail. See Instaclustr API Rate Limits.

After the backend is created, the backend details page lists the generated tools grouped by component. You cannot add, edit, or delete individual tools. To change which tools are available, edit the backend and change the selected components.

If you rotate the selected user’s API keys, or need to refresh the generated tools, go to the backend details page and click “Sync Configuration”.

Export Instaclustr API OpenAPI Specifications

You can download the OpenAPI specification for the Instaclustr API tools from the MCP Gateway Connection Info page. Select components wanted to be downloaded. The zip contains one OpenAPI JSON file per selected API and a README. Use the JSON files to create a custom HTTP Server backend with tools populated from the specification. See Configure HTTP Server MCP Backend and Tools for details.

Configure MCP Tool Access via Terraform

Instaclustr API tools are generated automatically, so you will know their names (listed in the sections below) but not their tool IDs. To create an access control list for these tools with Instaclustr Terraform Registry, look up the tool IDs by name using the instaclustr_mcp_gateway_cluster_mcp_tool_http_server_operation_v1 data source, then reference those IDs in the instaclustr_mcp_gateway_persona_access_control_v1 resource.

// Instaclustr API Backend config
resource "instaclustr_mcp_gateway_mcp_backend_instaclustr_api_v1" "instaclustr_api_backend" {
  virtual_server_id = instaclustr_mcp_gateway_mcp_virtual_server_v1.vs.id
  components        = ["CLUSTER_MANAGEMENT_API_CORE", "MONITORING_API_CORE"]
  api_user          = "mcp-user"
}

// Look up tool IDs by name
data "instaclustr_mcp_gateway_cluster_mcp_tool_http_server_operation_v1" "http_tool" {
  for_each               = toset(["listActiveClusters", "getKafkaCluster"])
  mcp_gateway_cluster_id = instaclustr_mcp_gateway_cluster_v1.mcpg.id

  filter {
    name   = "backendId"
    values = [instaclustr_mcp_gateway_mcp_backend_instaclustr_api_v1.instaclustr_api_backend.id]
  }

  filter {
    name   = "name"
    values = [each.key]
  }
}

// Allow a role to access only those tools
resource "instaclustr_mcp_gateway_persona_access_control_v1" "allow" {
  persona_role      = "role"
  cluster_id        = instaclustr_mcp_gateway_cluster_v1.mcpg.id
  virtual_server_id = instaclustr_mcp_gateway_mcp_virtual_server_v1.vs.id
  type              = "ALLOWLIST"
  tools             = values(data.instaclustr_mcp_gateway_cluster_mcp_tool_http_server_operation_v1.http_tool)[*].id
}

// Instaclustr API Backend config

resource "instaclustr_mcp_gateway_mcp_backend_instaclustr_api_v1" "instaclustr_api_backend" {

virtual_server_id = instaclustr_mcp_gateway_mcp_virtual_server_v1.vs.id

components = ["CLUSTER_MANAGEMENT_API_CORE", "MONITORING_API_CORE"]

api_user = "mcp-user"

}

// Look up tool IDs by name

data "instaclustr_mcp_gateway_cluster_mcp_tool_http_server_operation_v1" "http_tool" {

for_each = toset(["listActiveClusters", "getKafkaCluster"])

mcp_gateway_cluster_id = instaclustr_mcp_gateway_cluster_v1.mcpg.id

filter {

name = "backendId"

values = [instaclustr_mcp_gateway_mcp_backend_instaclustr_api_v1.instaclustr_api_backend.id]

}

filter {

name = "name"

values = [each.key]

}

// Allow a role to access only those tools

resource "instaclustr_mcp_gateway_persona_access_control_v1" "allow" {

persona_role = "role"

cluster_id = instaclustr_mcp_gateway_cluster_v1.mcpg.id

virtual_server_id = instaclustr_mcp_gateway_mcp_virtual_server_v1.vs.id

type = "ALLOWLIST"

tools = values(data.instaclustr_mcp_gateway_cluster_mcp_tool_http_server_operation_v1.http_tool)[*].id

}

The for_each set lists the names of the tools you want to reference, for example listActiveClusters and getKafkaCluster from the Cluster Management API Core tools list below. The backendId filter limits the lookup to tools on this Instaclustr API backend, and the name filter matches each tool name. Each data source instance returns the tool’s id, which the tools list of the instaclustr_mcp_gateway_persona_access_control_v1 resource requires. The same approach works for Denylist access control lists.

Appendix

Cluster Management API Core tools

These tools are created when Cluster Management API Core is selected.

listActiveClusters – Get active cluster IDs.
listResizeOperations – Get resize operations for a cluster data centre.
listUpcomingMaintenanceEvents – List upcoming maintenance events for a cluster.
listInProgressMaintenanceEvents – List in-progress maintenance events for a cluster.
listPastMaintenanceEvents – List past maintenance events for a cluster.
listNetworkFirewallRules – List all cluster network firewall rules.
getCassandraCluster – Get Cassandra cluster details.
listCassandraClusterBackups – List backups and restores for each node in a Cassandra cluster for the last 7 days.
getKafkaCluster – Get Kafka cluster details.
getOpenSearchCluster – Get OpenSearch cluster details.
listOpenSearchClusterBackups – List backups and restores for each node in an OpenSearch cluster for the last 7 days.
getPostgreSQLCluster – Get PostgreSQL cluster details.
listPostgreSQLClusterBackups – List backups and restores for each node in a PostgreSQL cluster for the last 7 days.
getClickHouseCluster – Get ClickHouse cluster details.
listClickHouseClusterBackups – List backups and restores for each node in a ClickHouse cluster for the last 7 days.
getCadenceCluster – Get Cadence cluster details.
getMcpGatewayCluster – Get MCP Gateway cluster details.

Monitoring API Core tools

These tools are created when Monitoring API Core is selected.

getClusterMetricDefinitions – Fetch metric types compatible with the provided cluster.
getClusterMetrics – Retrieve cluster-level monitoring metrics.
getDataCentreMetrics – Retrieve data centre-level monitoring metrics.
getNodeMetrics – Retrieve node-level monitoring metrics.

Please contact [email protected] for any further inquiries.

Configure HTTP Server MCP Backend and Tools

Configure MCP Tool Access

Learn about our
Managed platform

Schedule your 1:1 session with one of our open source experts

Schedule a demo