Skip to main content
Glama

get_scene_item_index

Retrieve the stacking position of an OBS scene item by providing its scene name and item ID. The index starts at 0 for the bottommost source, indicating the item's order in the list.

Instructions

Get a scene item's stacking position (0 = bottom of the source list).

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, the description carries the burden of behavioral disclosure. It explains the return value's semantics (0 = bottom), implying a read-only operation, but does not state potential errors, return type, or side-effect-free nature explicitly. Still, for a simple getter this is adequate but not rich.

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, focused sentence with no wasted words. It front-loads the action and includes the crucial positioning detail efficiently.

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 with no output schema, the description explains the return value (stacking position with 0=bottom), which is the key information needed. It does not need to describe return format or errors, though a note on integer type or not-found behavior would make it complete. Siblings are not relevant here.

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%, so the description must compensate for parameter semantics. However, the description does not mention scene_name or scene_item_id at all, relying entirely on the schema titles. It adds no extra meaning beyond what the property names already 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?

The description clearly states a specific verb ('Get') and resource ('a scene item's stacking position'), with an important clarification (0 = bottom). It is easily distinguished from sibling tools like get_scene_item_list, get_scene_item_id, and set_scene_item_index.

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

Usage Guidelines2/5

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

The description gives no guidance on when to use this tool versus alternatives. It does not mention any exclusions, prerequisites, or specific use cases beyond the basic action.

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