Skip to main content
Glama
royshil
by royshil

obs-get-preview-scene

Retrieve the current preview scene in OBS Studio Mode to verify upcoming scene changes before switching to program output.

Instructions

Get the current preview scene in OBS Studio Mode

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

No annotations are provided, so the description carries the full burden. It indicates a read-only operation ('Get') but doesn't disclose behavioral details like error conditions (e.g., if Studio Mode is off), response format, or whether it requires specific OBS states. It adds basic context but lacks depth for a tool with no annotation coverage.

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, front-loaded sentence that directly states the tool's purpose with zero wasted words. It's appropriately sized for a simple, parameterless tool and earns its place by clearly conveying essential information.

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

Completeness3/5

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

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is minimally adequate. It explains what the tool does but lacks details on return values or error handling, which could be helpful despite the low complexity. It meets basic needs but has room for improvement in completeness.

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?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description doesn't add parameter details, which is appropriate. A baseline of 4 is applied as it efficiently handles the lack of parameters without unnecessary elaboration.

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?

The description clearly states the specific action ('Get') and resource ('current preview scene in OBS Studio Mode'), distinguishing it from siblings like 'obs-get-current-scene' (which gets the program scene) and 'obs-set-preview-scene' (which sets it). It precisely defines the tool's function without redundancy.

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?

The description implies usage context by specifying 'in OBS Studio Mode', suggesting it's only relevant when Studio Mode is active. However, it doesn't explicitly state when not to use it or name alternatives, such as checking if Studio Mode is enabled first with 'obs-get-studio-mode'.

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/royshil/obs-mcp'

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