Skip to main content
Glama

Get widget embed snippet

get_embed_snippet

Return the SingChat chat-widget embed code for this workspace's web inbox, in three flavors: plain HTML, React (useEffect), and Next.js (next/script). Requires a workspace API key. Optionally pass platform to get just one flavor.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
platformNoWhich snippet to return. Omit to get all three.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations, the description carries the full burden. It discloses that the tool returns embed code in three flavors, optionally filtered by platform, and requires an API key. It implies a read-only operation but does not explicitly state 'read-only' or discuss side effects or rate limits.

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 sentences, front-loaded with the core action. Every clause adds value without redundancy.

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?

For a simple tool with one optional parameter and no output schema, the description is substantially complete. It covers purpose, parameter behavior, and a requirement. It does not describe error conditions or response format, but these are not critical given the tool's simplicity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%. The description adds meaning beyond the schema by explaining that omitting 'platform' returns all three flavors, and that passing it returns just one. This clarifies the behavior of the optional parameter.

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 clearly states the verb ('return'), the resource ('SingChat chat-widget embed code'), and the scope ('this workspace's web inbox'). It specifies three flavors and distinguishes itself from sibling tools which are unrelated.

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?

The description explicitly states when to use the tool (to get embed code) and mentions a prerequisite ('Requires a workspace API key'). However, it does not provide explicit guidance on when not to use it or alternatives, though none are needed.

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.

TDQS

A4.1/5.0
Disambiguation4/5

Tools are largely distinct, with clear purposes for knowledge management, conversations, FAQs, and setup. The only potential overlap is between 'search' (general help) and 'search_knowledge' (workspace KB), but descriptions clarify the context.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (e.g., add_knowledge, list_conversations, manage_faq). No mixing of conventions or vague verbs.

Tool Count5/5

17 tools is well-scoped for a live-chat and AI agent workspace server. The set covers setup, knowledge base, conversations, FAQs, analytics, keywords, and embedding without being overwhelming.

Completeness4/5

The tool surface is comprehensive for core workspace management and support: setup, knowledge ingestion/search, conversation handling, FAQs, analytics, and keywords. Minor gaps like user management or advanced channel configuration, but nothing that critically hinders agent workflows.

Resources