Skip to main content
Glama
beel-es

BeeL MCP server

Official
by beel-es
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

beel_list_products

Read-onlyIdempotent

Retrieve a paginated list of a company's products or services with optional filters for name, code, category, price, status, and sorting. Use it to search, filter, and page through catalog data.

Instructions

Returns a paginated list of the products/services of this company, with optional filters.

  • q: searching is done on this collection, there is no separate search path. q matches the name, the code and the description, so it returns at least everything the withdrawn GET /v1/products/search returned, in the paginated envelope of this list.

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoSearch by name, code or description
codeNoFilter by code (partial search)
nameNoFilter by name (partial search case-insensitive)
pageNoPage number, starting at 1. The response echoes it back as `pagination.current_page`.
limitNoHow many items to return per page. The response echoes it back as `pagination.items_per_page`.
activeNoFilter by active/inactive status
sort_byNoField to sort byname
categoryNoFilter by product category
max_priceNoMaximum price
min_priceNoMinimum price
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.
sort_orderNoSort order directionasc

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.9.0
    • changedInput schema / $defs / ProductSortBy / description
      Previous value: -"Product field the list is ordered by."New value: +"Product field the list is ordered by.\n\n- `name`: product name.\n- `code`: product code.\n- `category`: product category.\n- `default_price`: default unit price.\n- `created_at`: creation instant.\n"
  2. Changed5 schema fields changedv0.5.0
    • removedInput schema / $defs / ProductCategory / example
      Removed value: -"CONSULTING"
    • removedInput schema / $defs / ProductSortBy / example
      Removed value: -"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."
  3. First observedv0.3.1

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered structurally. The description adds the paginated-envelope behavior and the field-matching scope of `q`, but says nothing about auth requirements, rate limits, or result-set ordering behavior beyond what the schema states.

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?

The core purpose is front-loaded in a single sentence, and the endpoint is clearly stated at the end. The `q` bullet is somewhat verbose with its historical note about the withdrawn search endpoint, but every sentence carries routing value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Without an output schema, the description should carry more of the return-shape burden; it mentions only a 'paginated envelope' while the concrete pagination fields are described in the parameter docs. For a 12-param filtered list tool, this is adequate but leaves the response contract thin.

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% across all 12 params, so the schema already documents each filter, default, and bound. The description's `q` explanation ('matches the name, the code and the description') largely restates the schema's 'Search by name, code or description', adding no new syntax or disambiguation between overlapping filters.

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 (returns a paginated list) and resource (products/services of this company) with optional filters, plus the underlying endpoint. It is clear what the tool does, though it never explicitly contrasts itself with siblings like beel_get_product or beel_list_customers, leaving that distinction to inference.

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 `q` note is genuinely useful routing guidance: it says `q` is the sole search path because `GET /v1/products/search` was withdrawn, which steers an agent away from a non-existent endpoint. However, it gives no guidance on when to prefer `q` over the overlapping `name`/`code` filters, nor any when-not conditions.

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