Skip to main content
Glama

Preview attaching a plan

preview_attach
Read-only

Preview the cost/effect of attaching a plan to a customer WITHOUT charging or changing anything. Read-only. Autumn API: POST /v1/billing.preview_attach.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
plan_idYesThe ID of the plan.
versionNoThe version of the plan to attach.
customizeNoOptional plan overrides (price, items, licenses, free trial).
entity_idNoThe ID of the entity to attach the plan to.
customer_idYesThe ID of the customer to attach the plan to.
feature_quantitiesNoPrepaid feature quantities: array of { feature_id, quantity?, adjustable? }.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description reinforces that with 'WITHOUT charging or changing anything' and 'Read-only', adding the key behavioral consequence of no charge. This goes beyond the bare annotation by specificying the practical side-effect-free nature and the preview-only intent. No contradiction with annotations exists.

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 one tight sentence that front-loads what the tool does and its key side-effect-free property, then appends the endpoint for reference. Every word earns its place, and the formatting makes the critical information immediately visible.

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 read-only preview call, the description covers purpose, safety, and the general outcome ('cost/effect'). With no output schema, it could arguably say a bit more about what the preview returns, but the core guidance for correct invocation—no side effects, preview-only—is complete. The nested customize and feature_quantities parameters are documented in the schema, so the description does not need to repeat them.

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 the parameters are already well-documented. The description does not add parameter-specific detail, but the baseline of 3 applies because schema carries the burden. It loosely ties customer_id and plan_id to the 'attaching a plan to a customer' idea but offers no additional semantic value.

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 opens with the specific verb 'Preview' and the resource 'cost/effect of attaching a plan to a customer', making the operation unmistakable. It explicitly contrasts with the mutating attach_plan sibling by saying 'WITHOUT charging or changing anything', so an agent can tell this apart at a glance.

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 phrase 'WITHOUT charging or changing anything' and 'Read-only' clearly signal this tool is for inspection before a real action, which implies use when the agent wants to evaluate impact without side effects. It does not explicitly name attach_plan as the alternative for actually changing something, but the sibling list plus the contrast is strong enough to guide selection.

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.

TDQS

A3.9/5.0
Disambiguation5/5

All tools have clearly distinct purposes: get/list for various resources, mutation tools like attach_plan, track_usage, and special tools like preview_attach and autumn_request for edge cases. No overlap in functionality.

Naming Consistency4/5

Most tools follow a verb_noun pattern (get_customer, list_plans, create_entity), but a few like autumn_request, preview_attach, and open_customer_portal break the pattern. Still, the naming is clear and predictable overall.

Tool Count4/5

18 tools is slightly above the typical 3-15 range, but each tool serves a distinct purpose in the billing domain, covering customers, plans, features, entities, invoices, usage, and portal access. The count is justified by the complexity of the domain.

Completeness4/5

The tool set covers CRUD for most resources (customers, features, plans, entities, invoices) plus billing operations like attach, check, preview, track usage, and customer portal. Missing delete operations and potential detach, but the read-only autumn_request may cover gaps. Minor gaps, not severe.