Skip to main content
Glama

List plans

list_plans
Read-only

List all plans (products) in the current environment. Autumn API: POST /v1/plans.list. Returns { list }.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entity_idNoEntity id for entity-scoped plans.
customer_idNoInclude eligibility info (trial availability, attach scenario) for this customer.
all_versionsNoIf true, include all plan versions.
include_archivedNoIf true, include archived plans.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safe-read behavior is covered. The description adds some value beyond the annotations by revealing the API endpoint and the return shape ({ list }), but it does not disclose pagination, limits, or any ordering/filtering behavior, which would be genuinely useful context for a list endpoint.

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?

A single terse sentence that front-loads the core purpose and appends the endpoint and return format, with no filler. Every clause carries information an agent can act on.

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?

With a 100%-covered schema, no required parameters, and annotations supplying the read-only safety profile, the description covers the essential contract: what it lists, the endpoint, and the response shape. It is adequately complete for a simple collection endpoint, missing only optional niceties like pagination details.

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 all four parameters (entity_id, customer_id, all_versions, include_archived) are already fully documented by the schema. The description adds no parameter-specific meaning beyond the { list } return note, which fits the baseline-3 expectation for high schema coverage.

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 ('List') and a clear resource ('plans (products)') scoped to the current environment, and names the underlying API endpoint (POST /v1/plans.list). This clearly differentiates it from siblings like get_plan (singular retrieval) and attach_plan (mutation), so an agent can tell it apart without opening the schema.

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?

The description says 'List all plans,' which implicitly positions this as the batch/collection operation distinct from get_plan and attach_plan among the siblings. However, it never explicitly states when to prefer this over the alternatives or when not to use it, so the routing guidance is implied rather than stated.

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.