Skip to main content
Glama

Set renewal mode

set_contract_product_renewal

Turn auto-renewal on or off for a contract product. Disabling renewal schedules service expiry at the end of the paid period.

Instructions

Turn auto-renewal on or off for a contract product. Turning renewal off schedules the service to expire at the end of the paid period.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
renewYestrue = auto-renew, false = expire at period end
contract_idYesContract UUID
cancellation_reasonNoOnly needed if brand settings require it
contract_product_idYesContract product UUID
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false), the description adds the behavioral consequence of disabling renewal—scheduling expiration at the end of the paid period. This clarifies the non-destructive yet mutating nature, providing useful context beyond the structured annotations.

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?

The description is two sentences, front-loaded with the primary action and complemented by a succinct explanation of the off state. No redundant detail exists.

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 mutation tool with four parameters, no output schema, and good annotations, the description covers the essential behavior and effect. It lacks details on return values or prerequisites, but these are not critical given the schema coverage and simplicity of the operation.

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?

The input schema already provides descriptive parameter definitions with 100% coverage. The description adds no new parameter-specific meaning beyond restating the renew semantics in prose, so a baseline score of 3 is appropriate.

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?

The description clearly states the action: turning auto-renewal on or off for a contract product. It specifies the resource (contract product) and the effect of turning renewal off (service expires at end of paid period), distinguishing it from sibling tools like cancel_contract_product or activate_contract_product.

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?

The context of when to use this tool is clear: when you need to change the auto-renewal setting for a contract product. It does not explicitly mention alternatives or exclusions, but the purpose is distinct enough that no ambiguity arises.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/spidyhost-crm/upmind-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server