Skip to main content
Glama

Get overlay

overlays_get
Read-only

Retrieve a single StreamElements overlay with all widgets and their settings by overlay ID. Useful for inspecting or backing up overlay configuration; responses may be large.

Instructions

Get one overlay with all of its widgets and their settings. Responses can be large.

Input Schema

NameRequiredDescriptionDefault
channelNoStreamElements channel id (24-char hex). Defaults to SE_CHANNEL_ID or the channel that owns the token.
overlayIdYesOverlay id (24-character hex id)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true, openWorldHint=true), so the bar is lower. The description adds genuine behavioral context beyond that: the response is a deep aggregate of widgets plus their settings, and it can be large — a payload-size caveat the annotations do not convey.

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?

Two short sentences, zero filler, with the core identity of the call front-loaded and the size caveat trailing as a secondary caution. Every sentence earns its place.

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?

No output schema exists, so the description carries the burden of describing the return, and it does so at a useful level (overlay plus all widgets and their settings) plus a size warning. What is missing is failure behavior for a nonexistent or unauthorized overlayId, a relevant gap given openWorldHint.

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% for both parameters, including the channel-id defaulting rule, so the schema does the heavy lifting and the baseline of 3 applies. The description adds no format, id, or channel-selection detail beyond what the schema already states.

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?

States a specific verb and resource ('Get one overlay') and adds scope detail ('with all of its widgets and their settings'), which implicitly separates it from overlays_list. It does not explicitly name the sibling it differs from, so it falls short of a 5.

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

Usage Guidelines3/5

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

No explicit when-to-use statement or named alternative (e.g. overlays_update, overlays_list). The note 'Responses can be large' arguably hints that this is the heavyweight option, but the agent must infer that guidance rather than read it.

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

Deploy Server

Other Tools