Skip to main content
Glama

Get Scene Item ID

obs-get-scene-item-id
Read-onlyIdempotent

Retrieve the unique ID of a scene item by providing the source name and scene details.

Instructions

Get the ID of a scene item by its source name

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sceneNameNoName of the scene to search
sceneUuidNoUUID of the scene to search
canvasUuidNoUUID of the canvas containing the scene
sourceNameNoName of the source to find
sourceUuidNoUUID of the source to find
searchOffsetNoMatch offset when the source appears multiple times
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is established. The description adds the lookup-by-source-name behavior but does not disclose what happens on multiple matches, missing matches, or how UUIDs interact with names. No contradiction exists.

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 11-word sentence that front-loads the action and primary input. There is no redundancy or filler.

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?

For a read-only lookup with six optional parameters and no output schema, the description is minimal. It does not explain the return format, multi-match handling, or how to combine scene and source identifiers, leaving those details to the schema. Annotations cover safety and schema covers parameter semantics, making it minimally complete but not rich.

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 coverage is 100%, so each of the six parameters is already described. The description only adds that the search is 'by its source name', which reinforces sourceName but offers no additional semantic detail about identifier precedence, match offset, or scene selection.

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?

Description clearly states the action: 'Get the ID of a scene item' and the key input: 'by its source name'. It is specific and distinguishes from sibling tools such as obs-get-scene-item-source (inverse operation) and obs-get-scene-items (list operation).

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?

No guidance is provided on when to use this tool versus alternatives. It does not mention related tools like obs-get-scene-item-source or obs-get-scene-items, nor any exclusions or prerequisites beyond the implied lookup scenario.

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/Tom-R-Main/OBS-MCP'

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