Skip to main content
Glama
beel-es

BeeL MCP server

Official
by beel-es
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

beel_list_series

Read-onlyIdempotent

Fetch invoice series for a company, with filters for active status and document type, and optional pagination to manage fiscal numbering efficiently.

Instructions

Returns the invoice series of a company.

  • Filters: active restricts to active or inactive series — omit it and you get all of them. document_type filters by type and always includes the UNASSIGNED series, which are compatible with any type.

  • Pagination (opt-in): send page and/or limit to receive a single page plus a data.pagination block with the totals. Omit both and the response carries the full list in data.series and no pagination block.

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

⚠️ Fiscal guardrails — read before calling:

  • How invoice numbers are formed, and why numbering can never be rewritten. (resource: beel://guardrails/series-and-numbering)

For the exhaustive rules and worked examples, call beel_docs_search.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (starts at 1). Omit for the full, unpaginated list.
limitNoItems per page. Omit for the full, unpaginated list.
activeNoFilters by activity: `true` returns only active series, `false` only inactive ones. Omit it and you get **all** the series, active and inactive.
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.
document_typeNoFilter by document type (UNASSIGNED series are always included)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.5.0
    • 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/5.0
Behavior5/5

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

Annotations already establish read-only, idempotent, and non-destructive behavior; the description adds meaningful behavioral detail beyond that: UNASSIGNED series are always included, pagination is opt-in and changes the response shape, and there is a fiscal guardrail resource to read before calling. No contradiction with annotations.

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?

Well-structured and front-loaded: the core purpose appears first, then filters, pagination, endpoint, and safety notes. Each bullet and sentence earns its place with no filler or repetition.

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 no output schema, the description covers selection, filtering behavior, pagination results, endpoint, and related guardrails. An agent has enough information to select and invoke this tool correctly without further documentation.

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

Parameters4/5

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

Schema coverage is 100% and the schema descriptions are already detailed, so the baseline is 3. The description adds integration-level semantics such as 'omit active and you get all of them,' 'document_type always includes UNASSIGNED,' and the differing response shape for paginated vs. full-list calls. This is additive, though partly redundant with schema text.

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?

Opens with a specific verb and resource: 'Returns the invoice series of a company.' It then clarifies list semantics through filters and pagination, making clear this is the plural list operation rather than a singular get, create, patch, or delete series tool.

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?

Provides good operational context: when to use filters, when to opt into pagination vs. receive the full list, and when to consult guardrails. However, it never explicitly differentiates this tool from siblings like beel_get_series or beel_create_series; the only alternative mentioned is beel_docs_search for exhaustive rules.

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