Skip to main content
Glama

get_scene_item_locked

Retrieve the lock state of an OBS scene item to determine if it can be moved or resized in the user interface.

Instructions

Get a scene item's lock state (locked items can't be moved/resized in the UI).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scene_nameYes
scene_item_idYes
Behavior3/5

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

With no annotations provided, the description carries the burden of behavioral disclosure. It adds useful context by explaining what 'locked' means (can't be moved/resized in UI), but it does not disclose the return format (e.g., boolean), error behavior, or any side effects. This is a simple read operation, so the missing details are notable but not critical.

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 and adds a brief, relevant parenthetical. Every word earns its place, and no fluff or redundant information is present.

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?

This is a simple getter with two parameters and no output schema. The description explains what a lock state is, but it omits the return value shape (presumably a boolean) and any error cases like invalid scene/item IDs. Given the simple nature, this is adequate but not complete.

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

Parameters2/5

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

Schema description coverage is 0%, and the description does not compensate by explaining the parameters. While scene_name and scene_item_id are somewhat self-explanatory, the description does not clarify how to obtain the scene_item_id or how the two parameters relate. It adds no meaning beyond the schema's property names and types.

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 uses a specific verb ('Get') and resource ('a scene item's lock state'), making the tool's function immediately clear. It also distinguishes itself from the sibling set_scene_item_locked by focusing on reading lock state, and the parenthetical clarifies the practical meaning of 'locked'.

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 clearly implies when to use this tool: when you need to check whether a scene item is locked. It does not explicitly mention alternatives, but the presence of set_scene_item_locked in the sibling list makes the get vs. set distinction obvious. There are no exclusions or conditional guidance, so it stops short of a 5.

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/xDarkzx/OBS_MCP'

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