Skip to main content
Glama
wave-av

WAVE MCP Server

Official
by wave-av

wave_show_graphic

Show, hide, or update an HTML5 graphics overlay on a video production using a graphic template ID and data bindings.

Instructions

Show or hide an HTML5 graphics overlay on a production

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
production_idYesThe production ID
graphic_idYesThe graphic template ID
actionYesAction to perform
dataNoData bindings for the graphic template

Implementation Reference

  • Registration and full implementation of the wave_show_graphic tool. Registered via server.tool() with schema (production_id, graphic_id, action, data) and handler that POSTs to /api/v1/studio/productions/{production_id}/graphics/{graphic_id}.
    server.tool(
      "wave_show_graphic",
      "Show or hide an HTML5 graphics overlay on a production",
      {
        production_id: z.string().uuid().describe("The production ID"),
        graphic_id: z.string().describe("The graphic template ID"),
        action: z.enum(["show", "hide", "update"]).describe("Action to perform"),
        data: z
          .record(z.string(), z.unknown())
          .optional()
          .describe("Data bindings for the graphic template"),
      },
      async ({ production_id, graphic_id, action, data }) => {
        const res = await waveFetch(
          `/api/v1/studio/productions/${production_id}/graphics/${graphic_id}`,
          {
            method: "POST",
            body: JSON.stringify({ action, data: data ?? {} }),
          },
        );
        if (!res.ok) return errorContent(res.status, res.body);
        return textContent(res.body);
      },
    );
  • Zod schema for wave_show_graphic: production_id (UUID), graphic_id (string), action (enum: show/hide/update), data (optional record of string to unknown).
    {
      production_id: z.string().uuid().describe("The production ID"),
      graphic_id: z.string().describe("The graphic template ID"),
      action: z.enum(["show", "hide", "update"]).describe("Action to perform"),
      data: z
        .record(z.string(), z.unknown())
        .optional()
        .describe("Data bindings for the graphic template"),
    },
  • Handler function: sends POST request to WAVE API graphics endpoint with action and data payload, returns text or error response.
    async ({ production_id, graphic_id, action, data }) => {
      const res = await waveFetch(
        `/api/v1/studio/productions/${production_id}/graphics/${graphic_id}`,
        {
          method: "POST",
          body: JSON.stringify({ action, data: data ?? {} }),
        },
      );
      if (!res.ok) return errorContent(res.status, res.body);
      return textContent(res.body);
    },
  • Helper waveFetch function used by the handler to call the WAVE API with authentication headers.
    async function waveFetch(
      path: string,
      init?: RequestInit,
    ): Promise<{ ok: boolean; status: number; body: string }> {
      const url = `${getBaseUrl()}${path}`;
      const res = await fetch(url, {
        ...init,
        headers: {
          ...getAuthHeaders(),
          ...init?.headers,
        },
      });
      const body = await res.text();
      return { ok: res.ok, status: res.status, body };
    }
  • Helper functions textContent and errorContent used by the handler to format successful and error responses.
    function textContent(text: string): { content: Array<{ type: "text"; text: string }> } {
      return { content: [{ type: "text" as const, text }] };
    }
    
    function errorContent(
      status: number,
      body: string,
    ): { content: Array<{ type: "text"; text: string }> } {
      return textContent(`Error ${status}: ${body}`);
    }
Behavior2/5

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

With no annotations, the description must cover behavior. It only states 'show or hide' but fails to mention the 'update' action. It does not explain side effects, persistence, or visibility scope. The behavioral traits beyond the schema are not disclosed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is very concise at one sentence, but it fails to mention the 'update' action, making it inaccurate. Conciseness is only valuable if accurate.

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

Completeness2/5

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

For a tool with 4 parameters including a nested object and no output schema, the description is too sparse. It does not explain return values, error conditions, or the lifecycle of the overlay.

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?

Input schema has 100% description coverage, so the parameters are already documented. The description adds no new semantic information beyond the schema, earning a baseline score of 3.

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?

Description clearly states the tool controls an HTML5 graphics overlay on a production. It distinguishes from sibling tools which handle other aspects like cameras or streams. However, it omits the 'update' action present in the schema, making it slightly incomplete.

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 on when to use this tool versus alternatives. The description does not mention prerequisites, typical use cases, or when other tools might be more appropriate.

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/wave-av/mcp-server'

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