Skip to main content
Glama

Segments · list

segments_list
Read-onlyIdempotent

List segments (named groups of contacts to target campaigns).

Scope: segments:read.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "segments_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
afterNoNext page: the last row's `id`, while `has_more` is true.
limitNoRows per page, 1–100 (default 20).
beforeNoPrevious page: the first row's `id`. Not with `after`.
archivedNoPass `true` to list archived segments.

Output Schema

NameRequiredDescriptionDefault
dataNo
hintNo
statusNo
request_idNo
retry_after_secondsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already establish readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds the concrete auth requirement (`segments:read`), which is real value beyond the annotations, though it says nothing about result size, ordering, or rate limits.

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?

Two short lines, front-loaded with the verb and a one-clause definition, then the scope constraint. No filler.

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 an output schema present, annotations covering the safety profile, and full schema coverage, the description only needs to orient the agent, which it does. It could note that archived results are excluded by default or point to segments_list_members, but nothing critical 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 all four parameters (after, limit, before, archived) are already documented with pagination semantics and mutual exclusivity. The description adds nothing about parameters, so the baseline of 3 applies.

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 ('List segments') and defines what a segment is ('named groups of contacts to target campaigns'), which disambiguates it from segment-related siblings. It does not explicitly distinguish itself from segments_get or segments_list_members, so it stops short of a 5.

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 declares the required scope `segments:read`, which implies this is the read path, but it gives no explicit when-to-use guidance or alternatives (e.g., when to use segments_list_members instead). Usage is inferred from the verb and scope only.

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