Skip to main content
Glama

Helper: add an activity line

helper_activity

For a helper session that is not in the call: appends one line (3-8 words) to the call's activity feed as 'Helper : <helper_name>: '. Never spoken verbatim. context and faq: hidden background of this line for the voicebot. Returns the line.

Input Schema

NameRequiredDescriptionDefault
faqNoUp to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot.
goalNoOptional goal of this entry: number or title of a goal of the account (0 or empty = no goal). Unknown goals are ignored. Without it the entry inherits the goal of your last status (helpers: no inheriting).
textYes3-8 words.
contextNoHidden background of this entry for the voicebot (what, why, current state), max 2000 chars, never shown on the page.
credentialYesHelper credential `token` from helper_credential or POST /api/helper/credential.
helper_nameYesName of this helper session, 1-40 chars (shown on the call page as `from`).

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / goal
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Optional goal of this entry: number or title of a goal of the account (0 or empty = no goal). Unknown goals are ignored. Without it the entry inherits the goal of your last status (helpers: no inheriting).",
      +  "title": "Goal"
      +}
  2. Changed3 schema fields changed
    • addedInput schema / $defs
      Added value: +{
      +  "FaqPair": {
      +    "properties": {
      +      "a": {
      +        "description": "The prepared answer, max 200 chars.",
      +        "title": "A",
      +        "type": "string"
      +      },
      +      "q": {
      +        "description": "A likely follow-up question of the person, max 200 chars.",
      +        "title": "Q",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "q",
      +      "a"
      +    ],
      +    "title": "FaqPair",
      +    "type": "object"
      +  }
      +}
    • addedInput schema / properties / context
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Hidden background of this entry for the voicebot (what, why, current state), max 2000 chars, never shown on the page.",
      +  "title": "Context"
      +}
    • addedInput schema / properties / faq
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "$ref": "#/$defs/FaqPair"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Up to 3 likely follow-up questions with prepared answers [{q, a}] (max 200 chars each), hidden, for the voicebot.",
      +  "title": "Faq"
      +}
  3. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations declare readOnly=false, idempotent=false, openWorld=true, but say nothing about what the write produces. The description fills that gap: the exact feed line format, that it is silently logged rather than spoken, that `context` and `faq` stay hidden from the page, and that the call returns the line. It omits any mention of credential/permission failure behavior, which is the only notable gap.

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?

Three short sentences, front-loaded with the precondition and output format, with no filler. The middle sentence duplicates schema wording on context/faq, which is the only wasteful element.

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 6-parameter mutation tool with an output schema and full schema coverage, the description covers the who/what/how plus the non-obvious hidden-field semantics, so an agent can call it correctly. Only the `goal` parameter's interaction with this tool (schema mentions 'helpers: no inheriting') goes unmentioned in the description.

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 coverage is 100%, so every parameter is already documented in the schema, including that `context` and `faq` are hidden voicebot background and that `text` is 3-8 words. The description largely restates those facts ('context and faq: hidden background of this line for the voicebot'), adding little new meaning, notably skipping the `goal` parameter entirely. Baseline 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 concrete verb+resource (appends one line to the call's activity feed) and pins the exact rendering format 'Helper <label>: <helper_name>: <text>'. The precondition 'for a helper session that is not in the call' distinguishes it from the sibling `activity`/`say` tools, which operate for the in-call agent.

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 a clear situational precondition (helper session, not in the call) and signals the line is 'never spoken verbatim', which implicitly rules out using this to talk to the participant. It does not explicitly name the alternative to use for spoken output (e.g. `say`), so the routing guidance stops just short of complete.

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.