Skip to main content
Glama

integrations_set_realtime

Add, replace or remove the realtime (websocket) connector of an HTTP-API integration, leaving the rest of its configuration and its credentials untouched. realtime is the whole block: {protocol: 'actioncable' | 'raw_json', ws_url, auth: {type, placement: 'header' | 'query', query_param, token_mint: {method, path, token_path}}, channel_template, actions: [{name, description, is_write, input_schema, frame}]}. Its actions become tools of the integration. To remove the connector pass remove=true and no block. Needs the admin or owner role.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
removeNotrue = delete the connector and its tools. OMIT to set a block.
realtimeNoThe whole realtime block. OMIT only together with remove=true.
in_workspaceNoRun this one call in this workspace id instead of the session's. Nothing is stored; other sessions are not affected.
integration_idYesThe integration to change (from integrations.list).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations supply the safety profile (readOnly=false, openWorld=false, idempotent=false), and the description adds real value on top: the admin/owner role requirement, the guarantee that other configuration and credentials are untouched, and that removal deletes the connector together with its tools. Note the mild tension with destructiveHint=false, since remove=true performs a deletion; the description itself discloses this rather than hiding it, so this is disclosure, not contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the effect and the preservation guarantee, followed by the block spec and the removal rule. The inline block enumeration is dense but earns its place since the schema types the property only as a generic object; a sentence could be trimmed but nothing is redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutating, nested-config tool with no output schema, the description covers the mutation semantics, permission requirement, and preservation guarantee. It does not describe the response payload, but with no output schema that is a minor gap and the key behavioral facts are present.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description goes beyond the schema by spelling out the internal shape of the `realtime` object (protocol values, ws_url, auth placement/query_param/token_mint, channel_template, actions with is_write and input_schema). That is useful because the schema itself only says 'the whole realtime block'.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb and resource ('set realtime connector of an HTTP-API integration') and immediately bounds the scope: it replaces only the realtime block and leaves configuration and credentials untouched. An agent can distinguish this from integrations_set_auth and integrations_add_endpoints without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear trigger for the removal mode ('pass remove=true and no block') and states the non-obvious side effect that realtime actions become tools of the integration. It does not name sibling tools to prefer for adjacent tasks (e.g., auth or endpoint changes), so routing guidance is implied rather than explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.