Skip to main content
Glama

HeySale — AI Website Salesperson

Get the install script

get_salesperson_installation
Read-onlyIdempotent

Return the exact one-line script to add to a website so its salesperson appears for visitors, plus where to place it and whether HeySale has detected it yet. Give it the salesperson_id returned when the salesperson was created.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
salesperson_idYesThe salesperson_id returned by create_website_salesperson.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYesBuild state of the salesperson, e.g. analyzing, building, ready, failed.
ownershipYes
expires_atNo
environmentNo
next_actionNoPlain-language next step for the caller.
preview_urlNo
salespersonYes
website_urlYes
installationYes
salesperson_idYes
salesperson_nameYes
test_environmentNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": {},
      +  "properties": {
      +    "environment": {
      +      "type": "string"
      +    },
      +    "expires_at": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "installation": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "async": {
      +          "type": "boolean"
      +        },
      +        "detection": {
      +          "type": "string"
      +        },
      +        "installation_status": {
      +          "description": "What HeySale's own telemetry currently sees.",
      +          "enum": [
      +            "detected",
      +            "not_detected",
      +            "domain_mismatch",
      +            "unknown"
      +          ],
      +          "type": "string"
      +        },
      +        "placement": {
      +          "type": "string"
      +        },
      +        "review_install_url": {
      +          "description": "Sandbox only: expiring link that installs the test salesperson.",
      +          "type": "string"
      +        },
      +        "script": {
      +          "description": "The one-line script to add to the website before the closing body tag.",
      +          "type": "string"
      +        },
      +        "type": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "next_action": {
      +      "description": "Plain-language next step for the caller.",
      +      "type": "string"
      +    },
      +    "ownership": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "claim_url": {
      +          "description": "One-time link the website owner uses to claim the salesperson. Absent once claimed.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "manage_url": {
      +          "description": "Where the owner manages the salesperson. Present once claimed.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "status": {
      +          "description": "Whether a HeySale account owns this salesperson yet.",
      +          "enum": [
      +            "unclaimed",
      +            "claimed"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "status"
      +      ],
      +      "type": "object"
      +    },
      +    "preview_url": {
      +      "type": "string"
      +    },
      +    "salesperson": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "domain": {
      +          "type": "string"
      +        },
      +        "id": {
      +          "description": "The salesperson_id.",
      +          "type": "string"
      +        },
      +        "name": {
      +          "type": "string"
      +        },
      +        "website_url": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "name"
      +      ],
      +      "type": "object"
      +    },
      +    "salesperson_id": {
      +      "type": "string"
      +    },
      +    "salesperson_name": {
      +      "type": "string"
      +    },
      +    "status": {
      +      "description": "Build state of the salesperson, e.g. analyzing, building, ready, failed.",
      +      "type": "string"
      +    },
      +    "test_environment": {
      +      "type": "boolean"
      +    },
      +    "website_url": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "salesperson",
      +    "salesperson_id",
      +    "salesperson_name",
      +    "website_url",
      +    "status",
      +    "ownership",
      +    "installation"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / salesperson_id / description
      Added value: +"The salesperson_id returned by create_website_salesperson."
  3. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already mark it read-only/idempotent and non-destructive; the description adds relevant behavioral detail by stating the output (script text, placement, detection status) and implying no side effects. It does not cover edge cases like unknown IDs, but this is minor for a getter.

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 object and action, no fluff. The key output details, script, placement, and detection status, are packed into one efficient sentence.

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 read-only retrieval tool, the description covers what is returned, where the input comes from, and the primary use case. It stops short of noting error behavior or what happens if the ID is invalid/not yet installed, but the output schema likely fills that gap. Complete enough for most agent use.

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?

Input-schema coverage is 100% and the schema already explains that salesperson_id comes from create_website_salesperson. The description repeats this instructional intent without adding new parameter semantics, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific resource ('exact one-line script') and the expected output (script, placement, detection status). It is less explicit about how this differs from siblings like verify_salesperson_installation and check_salesperson_status, though the tool name helps disambiguate.

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?

Provides clear context: the tool is for retrieving the installation script for a website, and it tells the agent the required input (the salesperson_id returned at creation). It does not explicitly say when not to use it or name alternatives, so it misses the top score.

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.