Skip to main content
Glama
BeeL MCP server

BeeL MCP server

Official
by beel-es

beel_get_setup_status

Read-onlyIdempotent

Retrieve read-only setup status for all companies or one company: IDs, issuing-readiness blockers, default series, VeriFactu state, tax defaults, and the recommended next action to enable invoicing.

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 in this session's environment (Test or Live, reported as environment) 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.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "beel_get_setup_status"
  }
}

Input 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

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. Changed2 schema fields changedv0.10.0
    • changedOutput schema / properties / companies / items / properties / missing / description
      Previous value: -"Human-readable list of what is missing to issue Live."New value: +"Human-readable list of what is missing to issue in this session's environment."
    • changedOutput schema / properties / companies / items / properties / ready / description
      Previous 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."New value: +"Can issue in this session's `environment` (no blockers). `null` means readiness could not be read — see `error`; it does not mean not ready, and it does not mean ready."
  2. 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"
      +}
  3. 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"
      +}
  4. First observedv0.3.1

TDQS

A3.7/5.0
Behavior4/5

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

The annotations already establish readOnlyHint, idempotentHint, destructiveHint=false and a closed-world surface, so the description is not carrying the safety burden. It adds genuine behavioral context beyond them: readiness is evaluated against the session's environment (Test vs Live, surfaced as `environment`), and a section that cannot be read carries an `error` and never a default, so unknowns are never reported as ready. That non-defaulting contract is exactly the kind of semantic guarantee annotations cannot express.

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?

Every clause carries information — there is no filler or repetition of the annotations. The weakness is structural: the first sentence is a single ~90-word run-on with deeply nested enumerations, which would read far better as a short lead plus a bulleted field list. Front-loading is good (read-only status and the ids come first).

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 shape need not be spelled out, yet the description usefully frames the per-company contents and the error-vs-default rule. Combined with full parameter schema coverage and rich annotations, an agent has what it needs to call and interpret this correctly. Only the sibling routing gap keeps it from a 5.

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?

There is a single optional parameter and schema description coverage is 100%, with the schema itself clarifying that company_id is a UUID and not the NIF. The description adds no filtering semantics beyond that, which is fine given the coverage, but it also never mentions that the report can be scoped to one company. Baseline 3 for high-coverage schemas.

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?

The description states a specific resource and scope: read-only setup status across the account, per company, including company_id/NIF, environment, blockers, default series, VeriFactu status, tax defaults and a recommended next action. An agent can tell this is an aggregated readiness report rather than a single-resource getter. It never names the siblings it overlaps with (beel_get_issuing_readiness, beel_get_default_series, beel_get_verifactu_configuration, beel_get_tax_configuration), so differentiation is left implicit.

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 phrase 'with the ids an integration needs' implies the onboarding/integration-setup use case, and 'the single recommended next action' implies it is a first-stop diagnostic. However, there is no explicit when-to-use or when-not-to-use statement and no routing to the narrower sibling getters. Usage is inferable but not stated.

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