Skip to main content
Glama

List profiles (booking pages)

list_profiles
Read-only

List all profiles (booking pages) on the account. YCBM API: GET /v1/profiles. A profile is a bookable page with its own subdomain, appointment types, team members, and locations. Use fields to select fields (e.g. "id,title,subdomain"). Paginated via page (0-based) + maxResults. Returns a JSON array of profiles.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPagination page number, 0-based (offset-based paging). Use with maxResults.
fieldsNoComma-separated field paths to return (e.g. "id,title,startsAt"). Supports dotted paths for nested objects. Omit to get the default field set.
paramsNoAdditional documented query-string filters to send verbatim (merged with the typed params above).
maxResultsNoMaximum records per page (page size). Defaults to the API's own default when omitted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

The readOnlyHint=true annotation already signals a safe read operation; the description adds value by disclosing the exact endpoint (GET /v1/profiles), that it returns a JSON array of profiles, and that it is paginated via page + maxResults. No rate-limit or error-shape details are provided, but the core behavior is well covered.

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 four focused sentences: purpose, API endpoint, domain definition, and pagination/fields/return behavior. No filler; each sentence contributes useful information, and the most important purpose statement is front-loaded.

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?

For a read-only list tool with four optional parameters and no output schema, the description covers the endpoint, return type, pagination model, and field projection—sufficient for correct invocation. Minor omissions like explicit alternative routing and default-value edge cases are acceptable given the schema already documents defaults.

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 the schema already documents page, fields, params, and maxResults in detail. The description mostly restates schema content ('Use fields...', 'page (0-based) + maxResults'), adding only a minor example without substantive new parameter meaning.

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?

States 'List all profiles (booking pages) on the account' with a specific verb and resource, and defines what a profile is (a bookable page with subdomain, appointment types, team members, locations). This clearly differentiates the tool from get_profile and other list_* siblings.

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

Usage Guidelines4/5

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

The description gives clear context for when to use the tool: when listing all profiles on the account, with pagination and field-selection behavior spelled out. It does not explicitly name alternatives like get_profile for single-profile lookups, so it stops short of full when-not/exclusion guidance.

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.