Skip to main content
Glama

List CRM Segments

crm_segments_list
Read-only

Lists an app's CRM segment definitions: segment_id, handle, name, description, conditions, matched_count, and timestamps. Also returns total_stores for the app's mirrored store universe. Never dumps matching store membership. Takes the app_id returned by apps_list.

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": "crm_segments_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
app_idYesThe app uuid returned by `apps_list`.
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

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint=false and closed-world, so safety is covered; the description adds genuinely new context by clarifying that only definitions are returned and that matching store membership is never dumped, plus that total_stores reflects the whole app universe rather than the segment. It stops short of describing volume or pagination behavior, which would matter for apps with many segments.

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?

Front-loads the operation and return shape, then adds two short scopings ('never dumps membership', 'total_stores') and the dependency hint. Every sentence carries information, with no restatement of the tool name or redundant framing.

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?

There is no output schema, so enumerating the returned fields is exactly the compensating detail an agent needs, and the description supplies it along with the negative guarantee about membership. Both parameters are fully covered by the schema, so nothing required for correct invocation is missing.

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 both app_id and the organization_id resolution/slug behavior are already fully documented in the schema. The description only restates the apps_list provenance of app_id, adding no meaning beyond the structured fields — baseline 3 is appropriate.

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?

States a specific verb and resource ('Lists an app's CRM segment definitions') and enumerates exactly what is returned, which lets an agent recognize this as a read-only enumeration rather than a lookup-by-id (crm_segment_get) or a membership dump. It never names a sibling alternative explicitly, so differentiation is inferred from the scope sentence rather than stated.

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?

Provides a real chaining prerequisite — 'Takes the `app_id` returned by `apps_list`' — so ordering is implied. However there is no explicit when-to-use/when-not comparison against crm_segment_get or any statement of what to do if the app has no segments, leaving usage context partly inferred.

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