Skip to main content
Glama

update_stream_settings

Modify your live stream's title, description, or privacy settings to control visibility and content across multiple platforms.

Instructions

Update settings for the current stream such as title, description, or privacy settings

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoThe stream title
descriptionNoThe stream description
privacyNoThe stream privacy setting

Implementation Reference

  • Core handler function that performs the PATCH request to '/user/stream' endpoint with the provided StreamSettings to update the stream.
    async updateStreamSettings(settings: StreamSettings): Promise<Stream> {
      try {
        const response = await this.axiosInstance.patch<Stream>('/user/stream', settings);
        return response.data;
      } catch (error) {
        throw this.handleError(error, 'Failed to update stream settings');
      }
    }
  • MCP server request handler for CallToolRequest of 'update_stream_settings', validates args and delegates to RestreamClient.
    case 'update_stream_settings': {
      if (!args) {
        throw new Error('At least one setting is required');
      }
      const stream = await restreamClient.updateStreamSettings(args);
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(stream, null, 2),
          },
        ],
      };
    }
  • src/index.ts:101-122 (registration)
    Registers the 'update_stream_settings' tool with the MCP server, providing name, description, and input schema.
    {
      name: 'update_stream_settings',
      description: 'Update settings for the current stream such as title, description, or privacy settings',
      inputSchema: {
        type: 'object',
        properties: {
          title: {
            type: 'string',
            description: 'The stream title',
          },
          description: {
            type: 'string',
            description: 'The stream description',
          },
          privacy: {
            type: 'string',
            enum: ['public', 'private', 'unlisted'],
            description: 'The stream privacy setting',
          },
        },
      },
    },
  • TypeScript interface defining the structure of stream settings used by the handler.
    export interface StreamSettings {
      title?: string;
      description?: string;
      privacy?: 'public' | 'private' | 'unlisted';
    }
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states this is an update operation (implying mutation) but doesn't cover permissions needed, whether changes are reversible, rate limits, error conditions, or what happens to unspecified settings. For a mutation tool with zero annotation coverage, this leaves significant gaps.

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 front-loads the core action and key parameters. Every word earns its place with no redundancy or fluff, making it easy to parse quickly.

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?

Given this is a mutation tool with no annotations and no output schema, the description is incomplete. It doesn't explain what the tool returns, error handling, or behavioral nuances. While schema coverage is high for inputs, the overall context for safe and effective use is lacking.

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%, so parameters are fully documented in the schema. The description adds minimal value by listing the same three parameters (title, description, privacy) without providing additional context like format constraints or interdependencies. Baseline 3 is appropriate when schema does the heavy lifting.

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 verb 'Update' and resource 'settings for the current stream', specifying what fields can be modified (title, description, privacy settings). It distinguishes from siblings like 'update_channel_status' by focusing on stream settings rather than channel status. However, it doesn't explicitly contrast with all siblings like 'start_stream' or 'stop_stream'.

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. It doesn't mention prerequisites (e.g., needing an active stream), exclusions, or comparisons with sibling tools like 'update_channel_status'. The agent must infer usage from context alone.

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