Skip to main content
Glama
Sign In
OBS MCP

OBS MCP

by Tom-R-Main
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Rust
Hybrid

Get Persistent Data

obs-get-persistent-data
Read-onlyIdempotent

Retrieve a slot's value from a chosen persistent data realm (global or profile) to access saved OBS configuration or state.

Instructions

Gets the value of a slot from the selected persistent data realm

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": {
      "realm": "<realm>",
      "slotName": "<slotName>"
    },
    "name": "obs-get-persistent-data"
  }
}

Input Schema

NameRequiredDescriptionDefault
realmYesThe data realm to select. OBS_WEBSOCKET_DATA_REALM_GLOBAL or OBS_WEBSOCKET_DATA_REALM_PROFILE
slotNameYesThe name of the slot to retrieve data from

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A3.6/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is known. The description adds no extra behavioral details such as error handling, return format, or what happens if the slot does not exist, but does not contradict annotations.

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, concise sentence that is front-loaded with the action and resource. No wasted words.

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 2 well-documented params and safety annotations, the description is nearly sufficient. It lacks explicit mention of behavior when the slot is missing, but with no output schema, this is a minor gap.

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 input schema covers 100% of the parameters with descriptions for 'realm' and 'slotName'. The description adds no additional semantic meaning beyond the schema, so it meets the baseline but does not exceed it.

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 the action ('Gets') and the resource ('the value of a slot from the selected persistent data realm'), making it easy to distinguish from sibling tools like obs-set-persistent-data. It is specific and unambiguous.

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 given about when to use this tool versus alternatives. The description simply states what it does, but does not mention exclusions, prerequisites, or contrast with related getters such as obs-get-profile-parameter.

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