Skip to main content
Glama

list_customers

Fetch paginated customers from your Plane workspace. Filter by name, set page size, and follow the cursor to retrieve every matching customer.

Instructions

List customers in the workspace (paginated).

Args: query: Filter to customers whose name contains this text. cursor: Prior response's next_cursor; omit for first page. per_page: Results per page (1-1000, default 1000).

Returns: Paginated envelope: results + total_count, next_cursor, next_page_results (page again while next_page_results is true).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryNo
cursorNo
per_pageNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
countYes
resultsYes
grouped_byNo
extra_statsNo
next_cursorYes
prev_cursorYes
total_countYes
total_pagesYes
total_resultsYes
sub_grouped_byNo
next_page_resultsYes
prev_page_resultsYes
Behavior5/5

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

With no annotations provided, the description fully carries behavioral disclosure. It thoroughly documents pagination behavior (cursor, per_page, next_cursor, next_page_results), the default per_page value, the response envelope, and query semantics (name contains). This goes well beyond what the schema alone offers.

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?

The description is a well-structured docstring: a one-sentence summary followed by an Args list and Returns list. Every line carries necessary information about pagination and filtering, with no fluff. The front-loaded purpose ensures quick understanding.

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?

For a list tool with three optional parameters and pagination, the description covers the essential use cases: fetching all customers, filtering by name, and advancing through pages. It also explains the return envelope and the loop condition. Even with an output schema present, the description adds clarity without being excessive.

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

Parameters5/5

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

The input schema has 0% description coverage, yet the description explains each parameter in plain language: query as a name substring filter, cursor for pagination (omit on first page), and per_page with range and default. This adds rich semantic meaning that the schema lacks.

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?

The description opens with a specific verb+resource statement: 'List customers in the workspace (paginated).' This clearly distinguishes it from sibling tools like retrieve_customer (single customer), list_customer_properties, or list_customer_requests. The pagination qualifier adds useful scope.

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 implies its use for fetching a paginated collection of customers and provides guidance on pagination and filtering, but it does not explicitly state when to choose this over alternatives like retrieve_customer or list_customer_requests. No exclusions or alternative tool names are mentioned.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/leigangzhang/plane-mcp-server-adapter'

If you have feedback or need assistance with the MCP directory API, please join our Discord server