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 and the access_token returned when the salesperson was created.

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": {
      "salesperson_id": "<salesperson_id>"
    },
    "name": "get_salesperson_installation"
  }
}

Input Schema

NameRequiredDescriptionDefault
api_keyNoDevelopers only. Not required for setup, and never ask a website owner for one.
access_tokenNoThe private access_token returned by create_website_salesperson. Required to see details while the salesperson is unclaimed. Never share it with anyone else.
salesperson_idYesThe salesperson_id returned by create_website_salesperson.

Output 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. Changed2 schema fields changed
    • addedInput schema / properties / access_token
      Added value: +{
      +  "description": "The private access_token returned by create_website_salesperson. Required to see details while the salesperson is unclaimed. Never share it with anyone else.",
      +  "maxLength": 200,
      +  "minLength": 10,
      +  "type": "string"
      +}
    • addedInput schema / properties / api_key
      Added value: +{
      +  "description": "Developers only. Not required for setup, and never ask a website owner for one.",
      +  "maxLength": 200,
      +  "minLength": 10,
      +  "type": "string"
      +}
  2. Changed1 schema field changed
    • addedInput schema / additionalProperties
      Added value: +false
  3. 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"
      +}
  4. Changed1 schema field changed
    • addedInput schema / properties / salesperson_id / description
      Added value: +"The salesperson_id returned by create_website_salesperson."
  5. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare this is a read-only, idempotent, non-destructive call in a closed world, so the safety profile is covered. The description adds value by revealing what comes back (script, placement, detection status) and that the access_token unlocks details while unclaimed, but it says nothing about authorization failures, latency, or what an undetected result implies. No contradiction with annotations.

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?

Two sentences, front-loaded with the primary return value and then the input requirements. No filler or redundancy; the only mild weakness is that the trailing clause about detection overlaps conceptually with sibling tools without resolving it.

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?

The tool is simple (one required parameter, flat schema, existing output schema), and the description covers both what you get back and what to supply. It is nearly complete, with the remaining gap being routing guidance against verify/check/status siblings that an agent choosing between them would want.

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 all three parameters are already documented, including the api_key 'developers only' caveat and the unclaimed-state requirement for access_token. The description restates salesperson_id and access_token without adding syntax or format detail, so the baseline 3 applies; it also omits api_key entirely.

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?

States a concrete verb and resource: returns the one-line install script for a salesperson, plus placement location and detection status. It is specific and easy to distinguish from create_website_salesperson, but it never clarifies how it differs from verify_salesperson_installation or check_salesperson_status, which cover overlapping 'is it detected' ground.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied rather than stated: you call it to obtain the script after creating a salesperson, using the returned salesperson_id and access_token. There is no explicit when-to-use versus the verify/check siblings, and no exclusion guidance for the unclaimed case beyond the schema text.

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.