Skip to main content
Glama

HeySale — AI Website Salesperson

Check a salesperson's readiness

check_salesperson_status
Read-onlyIdempotent

Find out whether a website salesperson has finished reading the website and is ready to talk to visitors, and whether its script has been detected on the live site. 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": "check_salesperson_status"
  }
}

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
domainNo
statusYesBuild state of the salesperson, e.g. analyzing, building, ready, failed.
installedNo
ownershipYes
expires_atNo
environmentNo
next_actionNoPlain-language next step for the caller.
salespersonYes
website_urlYes
last_seen_atNoWhen the script was last seen loading. Null before installation.
salesperson_idYes
detected_domainsNo
salesperson_nameYes
test_environmentNo
installation_statusNo

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": {
      +    "detected_domains": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "domain": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "environment": {
      +      "type": "string"
      +    },
      +    "expires_at": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "installation_status": {
      +      "enum": [
      +        "detected",
      +        "not_detected",
      +        "domain_mismatch",
      +        "unknown"
      +      ],
      +      "type": "string"
      +    },
      +    "installed": {
      +      "type": "boolean"
      +    },
      +    "last_seen_at": {
      +      "description": "When the script was last seen loading. Null before installation.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "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"
      +    },
      +    "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"
      +  ],
      +  "type": "object"
      +}
  4. Changed1 schema field changed
    • changedInput schema / properties / salesperson_id / description
      Previous value: -"The id returned when the salesperson was created."New 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 readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered. The description contributes the dual-purpose nature of the check and the note that the token comes from creation, but says nothing about unclaimed-vs-claimed behavior, error states, or polling cadence – and the token-requirement detail is already carried by the schema.

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 outcome the caller cares about (readiness and script detection) and followed by the input instruction. Minor redundancy between 'website salesperson' and 'live site', but nothing is wasted.

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?

An output schema exists and annotations cover the safety profile, so the description need not explain return values or side effects. What remains is a slightly thin account of how the two results relate (readiness vs. script detection), which would help an agent interpret a partial success, but overall it is sufficient for a read-only status check.

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 in the schema, including access_token's 'required while unclaimed' caveat and api_key's 'developers only' note. The description only restates that salesperson_id and access_token come from create_website_salesperson, which is a modest restatement rather than new meaning, 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?

States a concrete verb-plus-resource: it reports two specific states – whether the salesperson has finished reading the website and is ready for visitors, and whether its script is detected on the live site. That is clearly distinguishable from get_salesperson_results or verify_salesperson_installation in intent, though it never names a sibling to reinforce the boundary.

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 only implied: the phrase 'has finished reading the website' suggests calling it after creation while setup is in progress, and 'Give it the salesperson_id and the access_token returned when the salesperson was created' implies a post-create flow. There is no explicit when-to-use versus when-to-use-a-sibling statement, such as pointing to get_salesperson_installation for the actual install script retrieval.

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.