Skip to main content
Glama

get_install_code

Read-only

The code that puts Help on a site, with its key filled in: button is the Help button on every page (the script and ), the easiest for a site builder such as Shopify, Wix, Squarespace, Webflow or Framer; html is the form on one page (the script and ). The script carries the site's domain proofs (data-help-proof), so verify_domain finds them on the published home page. The test key works on any site, sends no email and counts towards no plan; the live key works only on a domain the workspace has verified.

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": {
      "product_id": "<product_id>"
    },
    "name": "get_install_code"
  }
}

Input Schema

NameRequiredDescriptionDefault
modeNo"test" (the default: works on any site, sends no email, counts towards no plan) or "live" (works only on a verified domain).
product_idYesThe site's id (a uuid), from list_products.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / mode / type
      Previous value: -[
      -  "string",
      -  "null"
      -]New value: +"string"
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Beyond the readOnlyHint and openWorldHint annotations, the description discloses that the test key works on any site, sends no email, and counts towards no plan, while the live key only works on a verified domain. It also explains that the script carries domain proofs so `verify_domain` can find them, adding useful behavioral context.

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 description is front-loaded with what the tool provides and then explains the returned variants and key behavior. It is dense but every sentence carries relevant information; no major redundancy or wasted text.

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 supplies the return-shape information an agent needs: the `button` and `html` code variants, the script's domain proof, and test vs. live key behavior. For a read-only getter with fully described input parameters, this is complete enough to invoke correctly.

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%, so both `mode` and `product_id` are already documented in the schema. The description largely repeats the schema's explanation of test vs. live keys and does not add new parameter-level guidance, such as format details or selection criteria for `product_id` beyond the schema's reference to `list_products`.

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 exactly what the tool returns: install code that puts Help on a site with the key filled in. It distinguishes the two returned variants, `button` (Help button on every page) and `html` (form on one page), so an agent can understand the resource without opening the schema.

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 clear guidance on choosing between the `button` and `html` output variants for different site-builder scenarios (Shopify, Wix, Squarespace, Webflow, Framer vs. a single-page form). It also explains when the test vs. live key applies, though it does not explicitly exclude or name alternative sibling tools.

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.

Resources