Skip to main content
Glama
Sign In

HelpCenter.io

by io.helpcenter
OverviewDiscussionsAdmin

Get the Widget Install Code

helpcenter_get_widget_install
Read-onlyIdempotent

Get what it takes to put the help center's widget on the user's website: the snippet to paste before (exactly what the dashboard shows), the widget id, the websites allowed to embed it, whether it has been seen running, and whether visitors are served at all. An unpublished, private or suspended help center serves some visitors or none, so a correct install can still show nothing: the result says so. FAQ sections need this snippet on their page too.

Read-only. Creates the widget on first use, as opening the dashboard's Embeddables page does.

Args:

  • response_format ('markdown' | 'json'): default 'markdown'.

Returns: { widget: { app_id, install_snippet, script_url, embedding_origins, embedding_origins_editable, frame_ancestors, installed, last_seen_at, install_window_days, visitors: { served, reason, message }, entitlements: { widget, ai_answers, proactive_messages } } }.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "helpcenter_get_widget_install"
  }
}

Input Schema

NameRequiredDescriptionDefault
site_idNoWhich help center to act on: an id from helpcenter_list_sites. Needed when this connection reaches more than one help center; omit it when it reaches one. Applies to this call only — pass it on every call of a task, and ask the user which help center they mean if their request does not say.
response_formatNoOutput format: 'markdown' for a human-readable summary or 'json' for the full structured payload.markdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior2/5

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

The description discloses a real first-use side effect ('Creates the widget on first use, as opening the dashboard's Embeddables page does') and explains why a successful install may still serve nothing, which is genuinely useful context. However, that disclosed create-on-first-use behavior conflicts with the readOnlyHint=true annotation, which asserts the tool does not modify its environment, so the behavioral contract presented to the agent is internally inconsistent.

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?

The lead sentence front-loads the payload contents and the caveats, and the Returns block is justified because no output schema exists. It is dense but somewhat long, and the 'Read-only. Creates the widget...' pairing is a slightly confusing juxtaposition, though nothing is truly wasted.

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 no output schema, the description compensates by naming the full return shape (widget, installed, last_seen_at, visitors.served/reason, entitlements), and it covers the important edge case that an unpublished or private help center serves no visitors. An agent has enough to call it and interpret 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 description coverage is 100%, and the schema already explains site_id scoping and the response_format enum, so the description adds no parameter guidance beyond it. The Args section merely restates the default, so the baseline of 3 applies.

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 (get the widget install code) and enumerates exactly what the payload contains: paste snippet, widget id, allowed embedding origins, whether it has been seen running, and whether visitors are served. It is clearly distinguishable from sibling mutators such as helpcenter_update_embedding_origins.

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 concrete usage context, including the non-obvious case that FAQ sections also need this snippet, and frames the diagnostic angle ('a correct install can still show nothing'). It does not explicitly say when not to use it or point to helpcenter_update_embedding_origins for changing origins, so it stops short of full alternative routing.

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

All HelpCenter.io 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