Skip to main content
Glama

update_channel_status

Enable or disable a specific streaming channel in Restream's multi-platform streaming service. Control channel activation status using channel ID and enable/disable settings.

Instructions

Enable or disable a specific streaming channel

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
channelIdYesThe ID of the channel to update
enabledYesWhether to enable (true) or disable (false) the channel

Implementation Reference

  • Core implementation of the update channel status logic, performing PATCH request to Restream API endpoint /user/channels/{channelId} to toggle enabled status.
    async updateChannelStatus(channelId: string, enabled: boolean): Promise<Channel> {
      try {
        const response = await this.axiosInstance.patch<Channel>(
          `/user/channels/${channelId}`,
          { enabled }
        );
        return response.data;
      } catch (error) {
        throw this.handleError(error, `Failed to update channel ${channelId}`);
      }
    }
  • MCP server tool call handler for 'update_channel_status', validates arguments and delegates to RestreamClient.
    case 'update_channel_status': {
      if (!args || typeof args.channelId !== 'string' || typeof args.enabled !== 'boolean') {
        throw new Error('channelId and enabled are required');
      }
      const channel = await restreamClient.updateChannelStatus(args.channelId, args.enabled);
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(channel, null, 2),
          },
        ],
      };
    }
  • Input schema defining required parameters: channelId (string) and enabled (boolean).
    inputSchema: {
      type: 'object',
      properties: {
        channelId: {
          type: 'string',
          description: 'The ID of the channel to update',
        },
        enabled: {
          type: 'boolean',
          description: 'Whether to enable (true) or disable (false) the channel',
        },
      },
      required: ['channelId', 'enabled'],
    },
  • src/index.ts:74-91 (registration)
    Registration of the 'update_channel_status' tool in the MCP tools list, including name, description, and input schema.
    {
      name: 'update_channel_status',
      description: 'Enable or disable a specific streaming channel',
      inputSchema: {
        type: 'object',
        properties: {
          channelId: {
            type: 'string',
            description: 'The ID of the channel to update',
          },
          enabled: {
            type: 'boolean',
            description: 'Whether to enable (true) or disable (false) the channel',
          },
        },
        required: ['channelId', 'enabled'],
      },
    },
Behavior2/5

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

No annotations are provided, so the description carries full burden for behavioral disclosure. While 'Enable or disable' implies a mutation operation, the description doesn't address permissions needed, whether changes are reversible, rate limits, side effects on active streams, or what happens after the operation completes. This leaves significant behavioral gaps for a mutation tool.

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

Conciseness5/5

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

The description is a single, efficient sentence that communicates the core purpose without unnecessary words. It's appropriately sized for a simple tool with two parameters and gets straight to the point.

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

Completeness2/5

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

For a mutation tool with no annotations and no output schema, the description is insufficient. It doesn't explain what 'enabled' or 'disabled' mean functionally, what the response looks like, error conditions, or how this operation interacts with sibling tools like 'start_stream' and 'stop_stream'. The description leaves too many contextual questions unanswered.

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

Parameters3/5

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

Schema description coverage is 100%, with both parameters clearly documented in the schema. The description adds no additional parameter semantics beyond what's already in the schema (channel ID and enable/disable boolean). The baseline score of 3 reflects adequate but minimal value added by the description.

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

Purpose4/5

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

The description clearly states the action ('Enable or disable') and resource ('a specific streaming channel'), making the purpose immediately understandable. However, it doesn't differentiate this tool from sibling tools like 'update_stream_settings' or explain how channel status differs from stream control operations.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'start_stream', 'stop_stream', and 'update_stream_settings', there's no indication whether channel status is a separate administrative control, a prerequisite for streaming, or how it relates to other channel operations.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/shaktech786/restream-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server