Skip to main content
Glama

Always-fresh embed snippets

embed
Read-only

Generates ready-to-paste Markdown GIF/still and HTML video snippets with stable raw.githubusercontent URLs for a demo, so you can publish media without manual URL handling.

Instructions

Ready-to-paste embed snippets (markdown GIF, markdown still, HTML ) for a demo, using stable raw.githubusercontent URLs on the 'demo-media' branch. Pure string generation — no network, no render. Owner/repo come from the repo's origin remote; the demo name from the directory basename. Pair with the demo-publish workflow so CI keeps the URLs fresh. See docs/EMBEDS.md.

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": {
      "dir": "<dir>"
    },
    "name": "embed"
  }
}

Input Schema

NameRequiredDescriptionDefault
dirYesdemo project directory — pass an absolute path
repoNoconsuming repo to detect owner/repo from (default: server cwd)
stillNostill-frame basename under stills/ (default: poster)

Output Schema

NameRequiredDescriptionDefault
demoYes
repoYes
urlsYes
ownerYes
stillYes
branchYes
snippetsYes
workflowYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.20.2
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedOutput schema / properties / urls / properties / pagesVtt
      Added value: +{
      +  "description": "captions for the <video> embed's <track>",
      +  "type": "string"
      +}
    • changedOutput schema / properties / urls / required
      Previous value: -[
      -  "gif",
      -  "mp4",
      -  "still",
      -  "pagesMp4",
      -  "pagesBase"
      -]New value: +[
      +  "gif",
      +  "mp4",
      +  "still",
      +  "pagesMp4",
      +  "pagesVtt",
      +  "pagesBase"
      +]
  2. First observedv0.9.0

TDQS

A4.7/5.0
Behavior5/5

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

Beyond readOnlyHint=true, the description discloses that no network or rendering occurs, that URLs are stable raw.githubusercontent links pinned to the 'demo-media' branch, that owner/repo are auto-detected from the origin remote and the demo name from the directory basename, and that freshness depends on the demo-publish workflow. That is exactly the operational context an agent needs before invoking.

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?

Four tight sentences: output forms first, then the behavioral constraint, then input derivation, then the CI pairing and doc pointer. No filler, and the most decision-relevant facts are front-loaded.

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?

With an output schema present, return shape need not be described; the description covers what is generated, how inputs are derived, the no-network guarantee, and the freshness prerequisite. Nothing an agent needs to call this correctly is missing.

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, but the description adds real meaning by explaining that owner/repo are inferred from the repo's origin remote and the demo name from the directory basename, clarifying how these inputs are resolved rather than passed literally. It adds nothing extra about 'still', which the schema already covers.

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?

Names the concrete output artifact (markdown GIF, markdown still, HTML <video> embed snippets for a demo) and immediately delimits it against rendering siblings with 'Pure string generation — no network, no render,' which separates it from render/gif/stills/frames.

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 clear situational context — use it to get paste-ready snippets and 'Pair with the demo-publish workflow so CI keeps the URLs fresh' — which tells the agent when this tool is appropriate. It stops short of naming explicit alternatives or when-not conditions (e.g., that media must already exist via gif/stills), so it falls short of a 5.

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