Skip to main content
Glama

Update a reward

update_reward
DestructiveIdempotent

Changes a reward's name, stamps needed or description, or turns it off. Only the fields passed change.

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": {
      "reward_id": "<reward_id>"
    },
    "name": "update_reward"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNo
activeNofalse hides the reward from customers and staff.
intentNoOptional. One short sentence on what the person asked you to do, e.g. "Set up a stamp card for Ground Up Café". Leal shows it in the person's activity log under Settings → AI agents, so they can see what was done for them. Leave out customer details.
reward_idYesReward id from list_cards or get_store_setup.
descriptionNo
stamps_requiredNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / intent
      Added value: +{
      +  "description": "Optional. One short sentence on what the person asked you to do, e.g. \"Set up a stamp card for Ground Up Café\". Leal shows it in the person's activity log under Settings → AI agents, so they can see what was done for them. Leave out customer details.",
      +  "type": "string"
      +}
  2. 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 destructiveHint=true, idempotentHint=true and readOnlyHint=false, so safety is partly covered. The description adds the partial-update semantic (unspecified fields are preserved), but does not disclose the breath of the destructive action beyond 'turns it off' — the fact that deactivation hides the reward from customers and staff lives only in the schema, and reversibility is never stated.

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 short sentences, front-loaded with the scope and followed by the partial-update guarantee. No filler or repetition of the title.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive mutation with no output schema, the description should at minimum signal reversibility and when it is the right call over create_reward. Annotations carry the safety flags, so the tool is usable, but an agent could still deactivate a reward without knowing whether the change can be undone.

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?

With 50% schema description coverage, the description names four of the six parameters in prose, which helps map intent to fields but adds no format, range, or type detail beyond the schema. The two most nuanced parameters (intent, active) are explained more fully in the schema than in the description.

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?

Names a specific verb and resource plus the exact updatable fields (name, stamps_required, description, active), so an agent can tell this is a partial-update tool rather than a create. It does not explicitly contrast with create_reward, so sibling differentiation is left implicit.

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 by the verb and field list; there is no statement of when to reach for update_reward versus create_reward, nor any prerequisite such as needing an existing reward id. The 'only the fields passed change' note is a behavioral fact, not a routing hint.

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