Skip to main content
Glama
beel-es

BeeL MCP server

Official
by beel-es
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

beel_list_customers

Read-onlyIdempotent

List company customers with pagination, sorting, and filters for NIF, name, email, phone, city, province, or active status to locate specific customer records.

Instructions

Returns a paginated list of the customers of this company, with optional filters. Only the customers of the company in the path are returned.

Endpoint: GET /v1/companies/{company_id}/customers

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nifNoFilter by NIF (partial search)
cityNoFilter by city
pageNoPage number, starting at 1. The response echoes it back as `pagination.current_page`.
emailNoFilter by email (partial search)
limitNoHow many items to return per page. The response echoes it back as `pagination.items_per_page`.
phoneNoFilter by phone (partial search)
activeNoFilter by active/inactive status. Defaults to `true`, so inactive customers must be requested explicitly with `active=false`. Deleted customers are never returned by either value.
searchNoGlobal search by name, NIF or email
sort_byNoField to sort by. Results are always tie-broken by a stable internal key, so paging through the collection never repeats or skips a customer.legal_name
provinceNoFilter by province
company_idYesUnique identifier (UUID) of the company the operation acts on — its identifier, not its NIF. It is the only source of context: the account that owns it is derived from it, and the `BeeL-Active-Company` header plays no part. A company you do not reach answers `403`, and so does a company that does not exist, so the existence of a company in another account is never disclosed.
legal_nameNoFilter by legal name (partial search case-insensitive)
sort_orderNoSort order directionasc

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.5.0
    • removedInput schema / $defs / CustomerSortBy / example
      Removed value: -"legal_name"
    • removedInput schema / $defs / SortOrder / example
      Removed value: -"desc"
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / company_id / description
      Previous value: -"NIF (company) the operation acts on. It is the only source of context: the account that owns it is derived from it, and the `BeeL-Active-Company` header plays no part. A NIF you do not reach answers `403`, and so does a NIF that does not exist, so the existence of a NIF in another account is never disclosed."New value: +"Unique identifier (UUID) of the company the operation acts on — its identifier, not its NIF. It is the only source of context: the account that owns it is derived from it, and the `BeeL-Active-Company` header plays no part. A company you do not reach answers `403`, and so does a company that does not exist, so the existence of a company in another account is never disclosed."
  2. First observedv0.3.1

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false. The description adds useful behavioral context beyond that: the result is paginated and strictly limited to the company in the path. It does not repeat safety traits, avoiding redundancy.

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 compact and front-loaded: the core action, resource, and pagination appear in the first sentence. The scoping constraint and endpoint line each earn their place without unnecessary elaboration.

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 rich schema descriptions and safety annotations, the description covers the essential invocation context: scope, pagination, and optional filters. The absence of an output schema means the return structure is only broadly described as a paginated list, but this is acceptable given the tool's simplicity and the openWorldHint annotation.

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 fully documents all 13 parameters and their filters, defaults, and constraints. The description only says 'with optional filters' and does not add parameter-level meaning beyond what the schema already provides, which matches the baseline for full coverage.

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 clearly states the operation: returning a paginated list of customers for a specific company, with optional filters. It emphasizes scope ('Only the customers of the company in the path are returned'), which distinguishes it from company-level or global list tools.

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 establishes clear context: it is a list operation scoped to one company. However, it does not explicitly say when to prefer this tool over siblings like beel_get_customer for a single customer or other list endpoints, and it provides no exclusion criteria.

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