Skip to main content
Glama

Update stream details

update_stream
DestructiveIdempotent

Update owned stream metadata. Omitted fields retain current values. A supplied description replaces its formatting with plain text. Does not change visibility, pricing, or custom-target configuration.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesID of a stream you own, from streams_created.
nameNoNew stream name; omit to keep.
labelNoNew short tag; an empty string clears it, omit to keep.
descriptionNoNew plain-text description; omit to keep the current text and formatting.
streamCategoryNoNew topic category; omit to keep.
apiAccessEnabledNoWhether external API consumers can subscribe to this stream; omit to keep.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
streamYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • addedInput schema / properties / apiAccessEnabled / description
      Added value: +"Whether external API consumers can subscribe to this stream; omit to keep."
    • addedInput schema / properties / description / description
      Added value: +"New plain-text description; omit to keep the current text and formatting."
    • addedInput schema / properties / id / description
      Added value: +"ID of a stream you own, from streams_created."
    • addedInput schema / properties / label / description
      Added value: +"New short tag; an empty string clears it, omit to keep."
    • addedInput schema / properties / name / description
      Added value: +"New stream name; omit to keep."
    • addedInput schema / properties / streamCategory / description
      Added value: +"New topic category; omit to keep."
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Genuinely adds behavior beyond the annotations: partial-update semantics ('Omitted fields retain current values') and a destructive side effect not implied by destructiveHint alone — a supplied description flattens existing formatting to plain text. It does not discuss permission/auth requirements or failure behavior, so it falls short of a full behavioral picture for a destructive write.

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?

Four short sentences, front-loaded with the operation and its semantics, then the exclusions. Every sentence carries distinct information; none is filler.

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

Completeness5/5

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

An output schema exists, so return values need not be described, and the annotations already declare the safety profile. Combined with ownership scope, omit-to-keep semantics, and explicit exclusions, an agent has everything needed to invoke this correctly.

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 description coverage is 100%, so the per-parameter baseline is 3. The description adds cross-cutting meaning the schema only repeats per field (omit-to-keep), and the formatting-loss behavior for the description parameter is parameter-relevant context the schema does not convey.

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?

States a specific verb and resource ('Update owned stream metadata') and immediately bounds the scope by naming what it does not touch (visibility, pricing, custom-target configuration), which separates it from siblings like set_stream_custom_targets and patch_stream_custom_targets. An agent can identify the tool without opening the 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?

Usage context is clear: it applies to streams the caller owns (reinforced by the 'from streams_created' hint) and it explicitly excludes visibility, pricing, and custom-target changes, implicitly routing those to the sibling tools. It stops short of naming an alternative tool outright, so it is clear context rather than explicit routing.

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.

Resources