Skip to main content
Glama

Create Plan

plan_create

Creates a Plan Builder plan as a draft: merchants do not see it until plan_activate. Requires name (unique per app) and price_monthly in USD (0 for a free plan). Optional description, price_yearly (needs a monthly price above 0, and no usage pricing), trial_days, features (each feature_id from features_list, and a value for a number feature) and events (per-plan usage terms for events from events_list; at most one with an overage_rate above 0). Takes the app_id returned by apps_list. Returns the same shape as one plans_list entry.

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": {
      "app_id": "<app_id>",
      "name": "<name>",
      "price_monthly": "<price_monthly>"
    },
    "name": "plan_create"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesPlan name, unique among the app's plans.
app_idYesThe app uuid returned by `apps_list`.
eventsNoThe plan's per-event usage terms. Replaces the plan's whole list. At most one event may have an overage rate above 0, and a plan that charges for usage cannot have a yearly price.
featuresNoThe features this plan grants. Replaces the plan's whole list: send every feature the plan should keep. An empty list removes them all.
trial_daysNoOptional free trial length in days (min 0).
descriptionNoOptional description shown with the plan.
price_yearlyNoOptional yearly price in USD (min 0.01). Needs a monthly price above 0, and no usage pricing.
price_monthlyYesMonthly price in USD (min 0). 0 for a free plan.
organization_idNoAn organisation uuid or slug. When supplied, `app_id` is resolved within that organisation and may be a slug instead of a uuid, mirroring the Meridian web app.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations only declare the generic write profile (readOnlyHint=false, destructiveHint=false, openWorldHint=false). The description adds the non-obvious lifecycle fact that the plan is created invisible to merchants until `plan_activate`, plus the return shape ("same shape as one `plans_list` entry"), which the annotations cannot convey.

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?

Front-loads the most important fact (the draft state) in the first clause, then covers requirements and constraints. It is a single dense paragraph for nine parameters; heavy bolding and parenthetical nesting make it slightly harder to scan, but no sentence is wasted.

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

Completeness5/5

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

For a nine-parameter creation tool with no output schema, the description covers the resulting state, activation requirement, prerequisite lookups, key cross-field constraints, and the return shape. An agent has everything needed to invoke it correctly without further exploration.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, so the baseline is 3, but the description adds cross-field meaning: `price_yearly` requires a monthly price above 0 and no usage pricing, and at most one event may carry an overage rate above 0. The required-vs-optional split and the USD/free-plan convention are also restated usefully, though much of this duplicates the schema text.

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 specific verb and resource ("Creates a Plan Builder plan") and immediately qualifies the resulting state as a draft that merchants cannot see until `plan_activate`. This distinguishes it cleanly from `plan_update` and `plan_activate` without requiring the agent to open any schema.

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 clear preconditions and routes the agent to the right prerequisite tools: `apps_list` for `app_id`, `features_list` for `feature_id`, and `events_list` for event terms. It does not explicitly state when to prefer `plan_update` over this tool for an existing plan, which keeps it short of a 5.

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