Skip to main content
Glama

segments_list

Retrieve and list all segments in a Braze workspace using a REST API key, with optional sorting by direction and pagination.

Instructions

List all segments in the workspace.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
apiKeyNoBraze REST API key
restEndpointNoBraze REST endpoint URL
sort_directionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.6/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It says only that segments are listed, without disclosing pagination behavior, sorting defaults, authentication requirements, rate limits, or return shape. The presence of a page parameter also slightly undercuts the unqualified claim to list 'all' segments.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single front-loaded sentence with no wasted words, but it is under-specified rather than appropriately concise for a tool with four parameters and unannotated behavior.

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

Completeness2/5

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

For a list tool with no annotations, no output schema, 50% schema coverage, and undocumented pagination/sorting parameters, the description is not complete enough. An agent lacks guidance on pagination, sorting, authentication context, and how to distinguish this from segments_details or segments_analytics.

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

Parameters2/5

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

Schema description coverage is 50%: apiKey and restEndpoint are documented in the schema, but page and sort_direction are not. The description adds no parameter meaning at all, so it fails to compensate for the undocumented pagination and sorting parameters.

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?

The description gives a clear verb and resource: 'List all segments in the workspace.' It is specific enough to distinguish from non-list siblings, but it does not distinguish itself from closely related siblings like segments_details or segments_analytics.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no mention of alternatives such as segments_details for a single segment, and no indication that page/sort_direction affect how the list is retrieved. Usage is only implied by the verb 'List.'

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools