Skip to main content
Glama

List Segments Tool

list-segments-tool
Read-onlyIdempotent

List the segments configured for a project, newest first. Returns up to 50 per page; follow nextCursor to fetch additional pages. Optionally pass include to load the parent project chain.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cursorNoOpaque pagination cursor. Omit on the first call; pass the `nextCursor` value from the previous response to fetch the next page.
includeNoOptional comma-separated related resources to include in the response. Whitelisted: `project`, `project.organization`.
project_idYesThe numeric id of the project whose segments should be listed.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, closed-world, non-destructive, so the safety profile is covered. The description adds genuinely new behavior: page size cap of 50, the nextCursor paging contract, newest-first ordering, and that `include` expands the parent project chain.

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?

Three short sentences, no filler, with the core purpose front-loaded and pagination details following. Every sentence carries distinct information.

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 the description correctly compensates by describing the paginated return shape (50 per page, nextCursor) and the include-driven response expansion. An agent can call this correctly without further guessing.

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 100%, so the baseline is 3, but the description adds meaning beyond the schema by characterizing the output ordering and clarifying that `include` loads the parent chain rather than just naming resources. The cursor explanation largely duplicates the schema.

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 the segments configured for a project') plus a scope detail (newest first), which cleanly separates it from get-segment-tool and the create/update/delete siblings. It stops short of naming the alternative list tools explicitly, so it's clear but not sibling-differentiating in the strongest sense.

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?

Gives practical calling guidance (up to 50 per page, follow `nextCursor` for more) and marks `include` as optional, which is implied usage context. It never states when to prefer this over get-segment-tool for a single segment or list-projects for the parent chain, so exclusions are absent.

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