Skip to main content
Glama

get_canvas_list

List all OBS canvases, including multi-canvas setups, to identify available canvases for control.

Instructions

List all canvases in OBS (multi-canvas is a newer OBS feature; most setups only have the main canvas).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

With no annotations, the description carries the full transparency burden and clearly states a read-only listing behavior ('List all canvases'). It goes beyond a bare statement by disclosing that most setups have only the main canvas, which informs expected results. It does not detail return format, but for a simple list tool this is not a significant gap.

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 sentence, front-loaded with the core action ('List all canvases in OBS') and followed by a concise parenthetical note. Every word contributes meaning, with no redundancy or fluff.

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 zero-parameter list tool with no output schema, the description adequately conveys purpose and situational context, including the nuance about most setups only having a main canvas. It could optionally describe the return shape, but the tool is simple enough that this omission does not prevent correct invocation.

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 tool has zero parameters and the input schema confirms this, so no parameter explanation is needed. The description adds no parameter-specific detail, but the baseline for zero-parameter tools applies. Schema coverage is 100% and there is nothing to clarify.

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 'List all canvases in OBS', which identifies the specific verb (list), resource (canvases), and scope (all in OBS). The parenthetical about multi-canvas adds useful context without obfuscating the primary purpose. It inherently distinguishes from sibling tools like get_scene_list or get_input_list by naming the resource.

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 gives clear context by noting multi-canvas is a newer OBS feature and that most setups only have the main canvas, helping the agent understand when this tool might be relevant. It does not explicitly name alternatives or exclusions, but the context is sufficient for a zero-parameter listing tool.

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