Skip to main content
Glama
beel-es

BeeL MCP server

Official
by beel-es

beel_get_setup_status

Read-only

Read setup status for BeeL invoicing: get company IDs, NIFs, Live readiness blockers, default series, VeriFactu and tax defaults, and the recommended next action to resolve missing setup.

Instructions

Read-only setup status across your account, with the ids an integration needs: for each company its company_id and NIF, whether it can issue Live and exactly what is missing (issuing-readiness blockers, default series, VeriFactu, payment connection), its default series per document type (id and code), its VeriFactu status and its tax defaults, and the single recommended next action. A section that could not be read carries an error and never a default, so an unknown is never reported as ready.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
company_idNoOptional: restrict the report to a single company, by its company id (a UUID). This is not the NIF; the NIF is reported as a field of each company.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
errorNoWhy the report is incomplete: the company listing failed, a filter matched nothing, or entries were unusable. Present only when something went wrong.
accountYesThe authenticated account, or an error note if identity could not be read.
companiesYes
environmentYesWhich BeeL environment this session operates on. `live` means every invoice issued is a real fiscal document.
next_actionYesSingle recommended next action across the whole account.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.9.0
    • addedOutput schema / properties / companies / items / properties / default_series / properties / defaults
      Added value: +{
      +  "description": "The default series of each document type that has one: the series_id to send when issuing, and its code.",
      +  "items": {
      +    "properties": {
      +      "code": {
      +        "type": "string"
      +      },
      +      "document_type": {
      +        "type": "string"
      +      },
      +      "series_id": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "document_type",
      +      "series_id"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / companies / items / properties / tax_defaults
      Added value: +{
      +  "description": "The tax configuration as stored, under the API field names. A prefill the API never applies to a line on its own: every NORMAL line still sends its main_tax. allowed_irpf_rates are the IRPF rates this NIF may bear.",
      +  "properties": {
      +    "allowed_irpf_rates": {
      +      "items": {
      +        "type": "number"
      +      },
      +      "type": "array"
      +    },
      +    "apply_equivalence_surcharge": {
      +      "type": "boolean"
      +    },
      +    "apply_irpf": {
      +      "type": "boolean"
      +    },
      +    "default_equivalence_surcharge": {
      +      "type": "number"
      +    },
      +    "default_irpf_rate": {
      +      "type": "number"
      +    },
      +    "default_main_tax": {
      +      "properties": {
      +        "percentage": {
      +          "type": "number"
      +        },
      +        "regime_key": {
      +          "type": "string"
      +        },
      +        "type": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "error": {
      +      "description": "Why this section could not be read. Present only on failure.",
      +      "type": "string"
      +    },
      +    "irpf_exempt": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedOutput schema / properties / companies / items / properties / verifactu / properties / status
      Added value: +{
      +  "description": "VeriFactu state as the API derives it, e.g. ACTIVE or UNSIGNED.",
      +  "type": "string"
      +}
  2. Changed10 schema fields changedv0.5.0
    • changedInput schema / properties / company_id / description
      Previous value: -"Optional: restrict the report to a single company (NIF) id."New value: +"Optional: restrict the report to a single company, by its company id (a UUID). This is not the NIF; the NIF is reported as a field of each company."
    • addedOutput schema / properties / account / properties / error / description
      Added value: +"Why this section could not be read. Present only on failure."
    • addedOutput schema / properties / companies / items / properties / company_id / description
      Added value: +"The company id (a UUID), not the NIF."
    • addedOutput schema / properties / companies / items / properties / default_series / properties / error
      Added value: +{
      +  "description": "Why this section could not be read. Present only on failure.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / companies / items / properties / error
      Added value: +{
      +  "description": "Why this section could not be read. Present only on failure.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / companies / items / properties / payment_connection / properties / error
      Added value: +{
      +  "description": "Why this section could not be read. Present only on failure.",
      +  "type": "string"
      +}
    • changedOutput schema / properties / companies / items / properties / ready / description
      Previous value: -"Can issue Live (no blockers)."New value: +"Can issue Live (no blockers). `null` means readiness could not be read — see `error`; it does not mean not ready, and it does not mean ready."
    • changedOutput schema / properties / companies / items / properties / ready / type
      Previous value: -"boolean"New value: +[
      +  "boolean",
      +  "null"
      +]
    • addedOutput schema / properties / companies / items / properties / verifactu / properties / error
      Added value: +{
      +  "description": "Why this section could not be read. Present only on failure.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / error
      Added value: +{
      +  "description": "Why the report is incomplete: the company listing failed, a filter matched nothing, or entries were unusable. Present only when something went wrong.",
      +  "type": "string"
      +}
  3. First observedv0.3.1

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered; the description adds real behavioral value by specifying that an unreadable section carries an `error` and never a default, guaranteeing an unknown is not reported as ready. This is a genuine disclosure beyond the annotations, though it does not cover pagination or size limits.

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 payload scope is front-loaded in the opening clause, and the crucial error-vs-default rule closes the description. The middle enumeration is dense and long but each field listed maps to meaningful output, so little is wasted.

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?

An output schema exists, so return values need not be restated, yet the description's field enumeration and error semantics add useful orientation. For a single-parameter read-only status tool this is complete enough, though it omits any guidance on output size or rate behavior.

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 coverage is 100% and the single company_id parameter is fully documented in the schema (UUID, explicitly not the NIF). The description adds no additional parameter semantics, so the baseline 3 applies.

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 a specific verb and resource (read-only setup status across the account) and enumerates the exact payload an integration needs. An agent can distinguish it from overlapping siblings like beel_get_issuing_readiness or beel_get_company without opening schemas.

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 implies onboarding/setup-check usage via 'the ids an integration needs' and 'recommended next action', but never states when to prefer this over siblings such as beel_get_issuing_readiness, beel_get_company, or beel_get_default_series. Usage is inferable but no explicit conditions or alternatives are given.

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