Skip to main content
Glama
BeeL MCP server

BeeL MCP server

Official
by beel-es

beel_list_customers

Read-onlyIdempotent

Retrieve a paginated list of a company's customers with optional filters for name, NIF, email, status, city, province, and sort or pagination controls to locate and manage 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.

BeeL API endpoint: GET /v1/companies/{company_id}/customers (reference: https://docs.beel.es)

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "company_id": "<company_id>"
    },
    "name": "beel_list_customers"
  }
}

Input 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. Changed2 schema fields changedv0.10.0
    • addedInput schema / properties / sort_by / type
      Added value: +"string"
    • addedInput schema / properties / sort_order / type
      Added value: +"string"
  2. Changed1 schema field changedv0.9.0
    • changedInput schema / $defs / CustomerSortBy / description
      Previous value: -"Customer field the list is ordered by."New value: +"Customer field the list is ordered by. Ties are broken by customer id, so pages are\nstable.\n\n- `legal_name`: legal name.\n- `nif`: tax identifier.\n- `email`: email address.\n- `phone`: phone number.\n- `city`: city of the address.\n- `province`: province of the address.\n- `active`: whether the customer is active.\n- `created_at`: creation instant.\n"
  3. 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."
  4. First observedv0.3.1

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is fully covered. The description adds pagination and the path-scoped visibility constraint, but says nothing about ordering stability, total counts, or the default active-only behavior (that detail lives only in the schema).

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

Conciseness4/5

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

Front-loaded verb-plus-resource sentence, followed by a short scoping note and an endpoint/docs reference. No wasted prose, though the endpoint URL line adds little for an agent that already has the tool name and schemas.

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?

With 13 parameters fully documented in the schema, rich annotations, and no output schema, the description covers what an agent needs to select and call the tool. Only minor gaps remain, such as not flagging the active=true default outside the schema.

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%, including detailed filter, pagination and sort semantics, so the schema does the heavy lifting. The description contributes only the generic notion of "optional filters" and company scoping, adding no syntax or behavioral detail beyond 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 ("Returns a paginated list of the customers") and scopes it to the company in the path, which separates it from account- or member-oriented list siblings. It does not explicitly contrast with the single-resource sibling beel_get_customer or the create/import customer tools, so it lands just short of a 5.

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?

"with optional filters" implies the use case (browse/filter a customer list), and the second sentence clarifies the scoping behavior. There is no explicit when-to-use versus when-not guidance and no pointer to beel_get_customer for single-record lookups or to beel_create_customers_bulk/search alternatives.

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