Skip to main content
Glama

Get or restyle the audio player snippet

get_audio_embed
Read-onlyIdempotent

Returns the embeddable player snippet for an audio episode made with create_audio, with a new look when theme, layout, colour, title, transcript or attribution fields are passed; the audio itself is not re-rendered. Also the way to pick up an episode that was still rendering. Takes a few seconds. Give the snippet to the user in full, in a code block.

Input Schema

NameRequiredDescriptionDefault
colorNoPlayer accent colour as hex, for example #5688b0.
themeNoPlayer theme. Default dark.
layoutNoPlayer layout. Default full.
audioIdYesThe audioId returned by create_audio.
projectYesThe Hi, Moose project, by its name as shown by list_projects. The projectId is also accepted.
showTitleNoShow the title line in the player. Default false.
customTitleNoA custom title line for the player, for example "Listen to this article". Turns the title on.
showTranscriptNoShow the transcript button. Default true.
hideAttributionNoHide the "Audio by Hi, Moose" line. Paid plans only; ignored on free plans.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already cover the read-only/idempotent/non-destructive profile, and the description adds context the annotations cannot: no re-render of the audio, a few-seconds latency expectation, and the polling use case for in-progress episodes. It also prescribes output handling ('give the snippet to the user in full, in a code block'), which matters because there is no output schema.

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?

Three short sentences, front-loaded with the return value and scoping, then the restyle/poll conditions, then the presentation instruction. Nothing is redundant and the non-obvious caveat (no re-render) appears early.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter tool with no output schema, the description covers what is returned (a snippet), what it does not do (re-render audio), latency, the alternate polling use case, and how to present the result. An agent has everything needed to call and handle it correctly.

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 description coverage is 100%, so every parameter including enums and defaults is already documented; that sets the baseline at 3. The description only loosely groups the styling fields ('theme, layout, colour, title, transcript or attribution') without adding per-parameter meaning beyond what the schema states.

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?

States a specific verb and resource ('Returns the embeddable player snippet for an audio episode') and ties it to the sibling that produces the input ('made with create_audio'). It also distinguishes the operation's scope by clarifying that the audio itself is not re-rendered.

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?

Gives two concrete triggers: restyling via the optional display fields, and picking up an episode that was still rendering. There is no explicit when-not-to-use or naming of an alternative retrieval path, but the conditions for selecting this tool are clear.

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.

Resources