Skip to main content
Glama
BeeL MCP server

BeeL MCP server

Official
by beel-es

beel_get_payment_event

Read-onlyIdempotent

Retrieve a single payment event for a NIF connection to check its automatic invoicing outcome and, if it failed, get the stable failure code to act on.

Instructions

Retrieves a single payment event of the NIF's connection, including the outcome of its automatic invoicing and, when it failed, the stable failure code you can act on.

  • Not found: an event that does not belong to this NIF's connection returns 404, the same answer an event that does not exist gets, so an event of another NIF is never disclosed.

BeeL API endpoint: GET /v1/companies/{company_id}/payment-connections/{connection_id}/events/{event_id} (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>",
      "connection_id": "<connection_id>",
      "event_id": "<event_id>"
    },
    "name": "beel_get_payment_event"
  }
}

Input Schema

NameRequiredDescriptionDefault
event_idYesIdentifier of the payment event, as returned by the list operation.
company_idYesUnique identifier (UUID) of the company the events belong to — 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.
connection_idYesUnique identifier (UUID) of the payment connection the operation acts on, as returned by `GET /v1/companies/{company_id}/payment-connections`. A NIF can hold several connections of the same provider, so the provider slug alone does not name one. A connection of another NIF answers `404`, exactly like one that does not exist.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.9.0
    • addedInput schema / properties / connection_id
      Added value: +{
      +  "description": "Unique identifier (UUID) of the payment connection the operation acts on, as returned by `GET /v1/companies/{company_id}/payment-connections`. A NIF can hold several connections of the same provider, so the provider slug alone does not name one. A connection of another NIF answers `404`, exactly like one that does not exist.",
      +  "format": "uuid",
      +  "type": "string"
      +}
    • removedInput schema / properties / provider
      Removed value: -{
      -  "description": "Payment provider slug in **lowercase**. Currently only `stripe` (Stripe Connect) is\noperative; `woocommerce` and `shopify` are reserved for future providers.\n",
      -  "enum": [
      -    "stripe"
      -  ],
      -  "type": "string"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "company_id",
      -  "provider",
      -  "event_id"
      -]New value: +[
      +  "company_id",
      +  "connection_id",
      +  "event_id"
      +]
  2. Changed2 schema fields changedv0.5.0
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / company_id / description
      Previous value: -"NIF (company) the events belong to. 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 events belong to — 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

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds real value beyond that by disclosing the deliberate 404-not-403 masking of cross-NIF events and by telling the agent the response carries an actionable failure code — behavior not derivable from annotations or 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?

The core purpose is front-loaded and the not-found rule is called out separately. However, the 404 masking rule is partially duplicated with the company_id/connection_id schema descriptions, and the raw endpoint plus docs URL occupy space that could carry routing guidance instead.

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 three required, fully documented parameters and no output schema, the description covers what an agent needs: what the call returns (invoicing outcome and failure code) and how errors are surfaced. It stops short of linking the returned failure code to the remediation tools (retry/resolve/discard), which would complete the picture.

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% and each of the three UUID parameters is documented thoroughly in the schema itself, including the 403/404 semantics. The description adds no parameter-level guidance beyond restating the endpoint path, so the baseline of 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?

The first sentence states a specific verb and resource ('Retrieves a single payment event of the NIF's connection') and adds the payload scope (invoicing outcome, stable failure code). The word 'single' plus the endpoint path makes it clearly distinct from beel_list_payment_events without needing to open either schema.

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 usage (fetch one event, presumably after listing) but never states when to choose this over beel_list_payment_events or the action siblings like beel_resolve_payment_event, beel_retry_payment_event, or beel_discard_payment_event. There are no explicit when-not conditions or alternatives named, so an agent must infer routing from the tool names alone.

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