Skip to main content
Glama
Sign In
OBS MCP

OBS MCP

by Tom-R-Main
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Rust
Hybrid

Get Scene Item Locked

obs-get-scene-item-locked
Read-onlyIdempotent

Check an OBS scene item's lock status by providing its ID, enabling you to identify items that may block editing operations.

Instructions

Get whether a scene item is locked

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "sceneItemId": "<sceneItemId>"
    },
    "name": "obs-get-scene-item-locked"
  }
}

Input Schema

NameRequiredDescriptionDefault
sceneNameNoName of the scene
sceneUuidNoUUID of the scene
canvasUuidNoUUID of the canvas containing the scene
sceneItemIdYesNumeric ID of the scene item

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A4/5.0
Behavior4/5

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

The annotations already indicate read-only and idempotent behavior, and the description ('Get') is consistent with these traits. It does not add extra behavioral context beyond the annotations, but no contradictions exist, and the annotations sufficiently cover safe usage.

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, clear sentence that directly states the function. It is appropriately sized and front-loaded, with no unnecessary words or complexity.

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?

For a simple getter, the description is sufficient to convey the core functionality. It does not specify the return type (boolean) or error conditions, but given the simplicity and the presence of annotations, it is adequately complete for most use cases.

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?

The schema provides descriptions for all parameters, and the tool description does not add additional meaning about how to use them, such as whether a scene identifier is necessary alongside the item ID. Since schema coverage is 100%, the baseline is 3, and no extra context is provided.

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 it retrieves the locked status of a scene item, using a specific verb and resource. It distinguishes itself from other scene item getters like 'get scene item enabled' or 'get scene item index' by focusing solely on the locked property.

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?

The description does not provide explicit guidance on when to use this tool versus alternatives, such as checking lock status before modifying an item. It only implies usage when the locked state is needed, without discussing exclusions or alternative tools.

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