Skip to main content
Glama

osc-bridge

get_device_docs

Read-onlyIdempotent

Fetch the markdown companion documentation for one device, if present. The slug is the device's OSC prefix without the leading slash (e.g. 'ableton' for /ableton).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesDevice slug, e.g. 'ableton' or 'minilab3'
user_idNoYour anonymous SynthHub id, if you kept it from an earlier session (see the server instructions). Optional.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYes
has_docsYesFalse when no companion .md exists for the device.
markdownYesThe companion documentation, or a not-found message when has_docs is false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / user_id / description
      Previous value: -"Your anonymous osc-bridge id, if you kept it from an earlier session (see the server instructions). Optional."New value: +"Your anonymous SynthHub id, if you kept it from an earlier session (see the server instructions). Optional."
  2. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint=false, so the safety profile is covered. The description adds the useful caveat that docs may not exist ('if present'), but says nothing about what an empty result looks like or how missing-device errors surface.

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?

Two tight sentences: the action comes first, the parameter derivation second. No filler, and the most load-bearing detail (the slug format) is not buried.

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?

With an output schema present, return values need no explanation, and annotations plus the two documented parameters leave little ambiguity. Only the behavior on missing documentation is left implicit.

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?

Schema coverage is 100%, so the baseline is 3, and the description genuinely adds meaning beyond the schema by defining the slug as the device's OSC prefix minus the leading slash (e.g. 'ableton' for /ableton). The optional user_id is left entirely to the schema text.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (fetch markdown companion documentation for one device) plus a scope qualifier ('if present'). An agent can distinguish it from list_devices or submit_driver, though it never names a sibling it might be confused with.

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?

Implies the usage context through 'if present' and explains how to derive the slug from an OSC prefix, but gives no explicit guidance on when to prefer this over siblings such as list_devices for discovering a device, nor what to do when documentation is absent.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.