Skip to content

Tool reference — `mcp_einvoicing_core (Peppol plugin)`

This file is generated from the MCP tool registry by scripts/gen_tool_reference.py. Do not edit it by hand; run the script instead.

These are the tools core contributes via register_peppol_tools; country packages mount them alongside their own national tools.

Tools: 12

check_document_type_id_in_codelist

Check whether a (scheme, value) pair is a recognized Peppol document type identifier.

Requires EINVOICING_PEPPOL_CODELIST_DIR (see list_participant_id_schemes). Searches all entries regardless of state, so a historical (deprecated or removed) document type is still reported as found.

Parameter Type Required Default Description
scheme string yes
value string yes

check_participant_id_scheme_in_codelist

Check whether a 4-digit ISO 6523 ICD code (e.g. “0208”) is a recognized Peppol scheme.

Requires EINVOICING_PEPPOL_CODELIST_DIR (see list_participant_id_schemes).

Parameter Type Required Default Description
icd string yes

check_process_id_in_codelist

Check whether a (scheme, value) pair is a recognized Peppol process identifier.

Requires EINVOICING_PEPPOL_CODELIST_DIR (see list_participant_id_schemes).

Parameter Type Required Default Description
scheme string yes
value string yes

get_peppol_codelist_version

Report the OpenPeppol eDEC code list release version(s) currently configured locally.

No parameters.

list_document_type_ids

List Peppol document type identifiers from the OpenPeppol eDEC code list.

Requires EINVOICING_PEPPOL_CODELIST_DIR (see list_participant_id_schemes).

Parameter Type Required Default Description
active_only boolean no True When True (default), omit deprecated/removed entries.

list_participant_id_schemes

List Peppol participant identifier (ICD) schemes from the OpenPeppol eDEC code list.

Requires EINVOICING_PEPPOL_CODELIST_DIR to point at a local copy of the eDEC “Participant Identifier Schemes” GeneriCode export (not bundled with this package, no confirmed redistribution rights, see mcp_einvoicing_core.peppol.codelists module docstring).

Parameter Type Required Default Description
active_only boolean no True When True (default), omit deprecated/removed entries.

list_process_ids

List Peppol process identifiers from the OpenPeppol eDEC code list.

Requires EINVOICING_PEPPOL_CODELIST_DIR (see list_participant_id_schemes).

Parameter Type Required Default Description
active_only boolean no True When True (default), omit deprecated/removed entries.

list_spis_use_case_ids

List Peppol SPIS use case identifiers from the OpenPeppol eDEC code list.

Requires EINVOICING_PEPPOL_CODELIST_DIR (see list_participant_id_schemes).

Parameter Type Required Default Description
active_only boolean no True When True (default), omit deprecated/removed entries.

peppol_get_service_endpoint

Fetch the AS4 endpoint for a Peppol participant’s document type.

Resolves the SMP hostname via DNS, then fetches service metadata for document_type_id. If the SMP returns a redirect, the result’s redirect_url is set and endpoint_url is None; callers must not follow more than one redirect hop (SMP 1.4.0 §3.2).

Parameter Type Required Default Description
identifier string yes Peppol participant ID or adaptable national identifier.
document_type_id string no 'urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1' Peppol document type identifier URN (default: BIS Billing 3.0 invoice).
environment string no 'production' “production” or “test”.

peppol_lookup_participant

Check whether a business is registered on the Peppol network.

Performs a DNS-over-HTTPS U-NAPTR lookup followed by an SMP service-group request to determine registration status and the list of supported document type identifiers.

Parameter Type Required Default Description
identifier string yes Peppol participant ID (“:”) or a bare national identifier this server knows how to adapt (e.g. a VAT number, if a national identifier adapter is configured).
environment string no 'production' “production” or “test”.

peppol_send

Send a UBL/CII invoice to a Peppol participant via AS4.

Looks up the recipient’s AS4 endpoint (SMP), builds the ebMS3/AS4 envelope, and transmits it using the supplied signing credentials.

Parameter Type Required Default Description
invoice_xml_base64 string yes Base64-encoded UBL or CII invoice XML.
recipient_identifier string yes Peppol participant ID or adaptable national identifier of the receiver.
sender_id string yes Peppol AP identifier of the sender.
certificate_path string yes Path to the PEM-encoded signing certificate.
private_key_path string yes Path to the PEM-encoded private key.
private_key_password string no '' Optional password for the private key.
document_type_id string no 'urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1' Peppol document type identifier URN (default: BIS Billing 3.0 invoice).
environment string no 'test' “production” or “test”.

resolve_peppol_dns

Resolve the SMP hostname for a Peppol participant via DNS only.

Performs the raw U-NAPTR (SML) lookup without fetching the SMP service group, useful for diagnosing whether a participant is registered in the SML independently of SMP reachability.

Parameter Type Required Default Description
identifier string yes Peppol participant ID or adaptable national identifier.
environment string no 'production' “production” or “test”.