Skip to main content
Glama
Sign In

Frank

by ai.hifrank
OverviewDiscussionsAdmin

Get a Frank website widget and its install snippet

get_embed
Read-only

Returns one widget format's settings, its install snippet — exactly what the Frank dashboard's Code tab shows — how to install it on the user's site, and whether participants can take an interview through it. Install the snippet as given and never swap in another format's embed ID. If runnable is false, tell the user the blockers before installing: until they are fixed nobody can take an interview, and every blocker except out_of_credits also keeps the widget hidden.

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": {
      "researchId": "<researchId>",
      "type": "<type>"
    },
    "name": "get_embed"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeYesWhich widget format: floating, inline or popup.
researchIdYesThe Frank research ID, as returned by list_researches.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover the read-only, non-destructive, closed-world profile, and the description adds real behavioral context: what the response contains, the constraint against swapping embed IDs, and the consequence chain when runnable is false. That goes meaningfully beyond the structured fields.

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

Conciseness4/5

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

Content is front-loaded with the return payload, followed by the operational rule and the conditional branch. The final clause about out_of_credits is dense but earns its place; the whole thing is one compact block.

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?

There is no output schema, so the description must describe returns — it enumerates settings, snippet, install instructions and runnability, which is adequate. The conditional blocker handling is spelled out, so an agent knows how to act on the result.

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 coverage is 100% and the enum values are documented, so the schema does the heavy lifting. The description reinforces that only one format is returned and its embed ID must not be swapped, which adds a little meaning but no new parameter-level detail.

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 states a specific verb and resource — returns one widget format's settings, install snippet, install guidance and runnable status — and distinguishes itself from list_embeds/configure_embed by scope. An agent can tell it fetches a single format's embed rather than listing or mutating.

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?

It gives concrete operating instructions: use the snippet as given, never substitute another format's embed ID, and surface blockers when runnable is false. It doesn't explicitly name list_embeds or configure_embed as alternatives, but the usage context is clear.

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

All Frank toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources