e-invoice-api-mcp
TypeScript icon, indicating that this package has built-in type declarations

1.4.2 • Public • Published

e-invoice.be Peppol MCP Server

It is generated with Stainless.

Installation

Direct invocation

You can run the MCP Server directly via npx:

export E_INVOICE_API_KEY="My API Key"
npx -y e-invoice-api-mcp@latest

Via MCP Client

There is a partial list of existing clients at modelcontextprotocol.io. If you already have a client, consult their documentation to install the MCP server.

For clients with a configuration JSON, it might look something like this:

{
  "mcpServers": {
    "e_invoice_api_api": {
      "command": "npx",
      "args": ["-y", "e-invoice-api-mcp", "--client=claude", "--tools=dynamic"],
      "env": {
        "E_INVOICE_API_KEY": "My API Key"
      }
    }
  }
}

Exposing endpoints to your MCP Client

There are two ways to expose endpoints as tools in the MCP server:

  1. Exposing one tool per endpoint, and filtering as necessary
  2. Exposing a set of tools to dynamically discover and invoke endpoints from the API

Filtering endpoints and tools

You can run the package on the command line to discover and filter the set of tools that are exposed by the MCP Server. This can be helpful for large APIs where including all endpoints at once is too much for your AI's context window.

You can filter by multiple aspects:

  • --tool includes a specific tool by name
  • --resource includes all tools under a specific resource, and can have wildcards, e.g. my.resource*
  • --operation includes just read (get/list) or just write operations

Dynamic tools

If you specify --tools=dynamic to the MCP server, instead of exposing one tool per endpoint in the API, it will expose the following tools:

  1. list_api_endpoints - Discovers available endpoints, with optional filtering by search query
  2. get_api_endpoint_schema - Gets detailed schema information for a specific endpoint
  3. invoke_api_endpoint - Executes any endpoint with the appropriate parameters

This allows you to have the full set of API endpoints available to your MCP Client, while not requiring that all of their schemas be loaded into context at once. Instead, the LLM will automatically use these tools together to search for, look up, and invoke endpoints dynamically. However, due to the indirect nature of the schemas, it can struggle to provide the correct properties a bit more than when tools are imported explicitly. Therefore, you can opt-in to explicit tools, the dynamic tools, or both.

See more information with --help.

All of these command-line options can be repeated, combined together, and have corresponding exclusion versions (e.g. --no-tool).

Use --list to see the list of available tools, or see below.

Specifying the MCP Client

Different clients have varying abilities to handle arbitrary tools and schemas.

You can specify the client you are using with the --client argument, and the MCP server will automatically serve tools and schemas that are more compatible with that client.

  • --client=<type>: Set all capabilities based on a known MCP client

    • Valid values: openai-agents, claude, claude-code, cursor
    • Example: --client=cursor

Additionally, if you have a client not on the above list, or the client has gotten better over time, you can manually enable or disable certain capabilities:

  • --capability=<name>: Specify individual client capabilities
    • Available capabilities:
      • top-level-unions: Enable support for top-level unions in tool schemas
      • valid-json: Enable JSON string parsing for arguments
      • refs: Enable support for $ref pointers in schemas
      • unions: Enable support for union types (anyOf) in schemas
      • formats: Enable support for format validations in schemas (e.g. date-time, email)
      • tool-name-length=N: Set maximum tool name length to N characters
    • Example: --capability=top-level-unions --capability=tool-name-length=40
    • Example: --capability=top-level-unions,tool-name-length=40

Examples

  1. Filter for read operations on cards:
--resource=cards --operation=read
  1. Exclude specific tools while including others:
--resource=cards --no-tool=create_cards
  1. Configure for Cursor client with custom max tool name length:
--client=cursor --capability=tool-name-length=40
  1. Complex filtering with multiple criteria:
--resource=cards,accounts --operation=read --tag=kyc --no-tool=create_cards

Importing the tools and server individually

// Import the server, generated endpoints, or the init function
import { server, endpoints, init } from "e-invoice-api-mcp/server";

// import a specific tool
import createDocuments from "e-invoice-api-mcp/tools/documents/create-documents";

// initialize the server and all endpoints
init({ server, endpoints });

// manually start server
const transport = new StdioServerTransport();
await server.connect(transport);

// or initialize your own server with specific tools
const myServer = new McpServer(...);

// define your own endpoint
const myCustomEndpoint = {
  tool: {
    name: 'my_custom_tool',
    description: 'My custom tool',
    inputSchema: zodToJsonSchema(z.object({ a_property: z.string() })),
  },
  handler: async (client: client, args: any) => {
    return { myResponse: 'Hello world!' };
  })
};

// initialize the server with your custom endpoints
init({ server: myServer, endpoints: [createDocuments, myCustomEndpoint] });

Available Tools

The following tools are available in this MCP server.

Resource documents:

  • create_documents (write): Create a new invoice or credit note
  • retrieve_documents (read): Get an invoice or credit note by ID
  • delete_documents (write): Delete an invoice or credit note
  • send_documents (write): Send an invoice or credit note via Peppol

Resource documents.attachments:

  • retrieve_documents_attachments (read): Get attachment details with for an invoice or credit note with link to download file (signed URL, valid for 1 hour)
  • list_documents_attachments (read): Get all attachments for an invoice or credit note
  • delete_documents_attachments (write): Delete an attachment from an invoice or credit note
  • add_documents_attachments (write): Add a new attachment to an invoice or credit note

Resource documents.ubl:

  • get_documents_ubl (read): Get the UBL for an invoice or credit note

Resource inbox:

  • list_inbox (read): Retrieve a paginated list of received documents with filtering options.
  • list_credit_notes_inbox (read): Retrieve a paginated list of received credit notes with filtering options.
  • list_invoices_inbox (read): Retrieve a paginated list of received invoices with filtering options.

Resource outbox:

  • list_draft_documents_outbox (read): Retrieve a paginated list of draft documents with filtering options.
  • list_received_documents_outbox (read): Retrieve a paginated list of received documents with filtering options.

Resource validate:

  • validate_json_validate (write): Validate if the JSON document can be converted to a valid UBL document
  • validate_peppol_id_validate (read): Validate if a Peppol ID exists in the Peppol network and retrieve supported document types. The peppol_id must be in the form of <scheme>:<id>. The scheme is a 4-digit code representing the identifier scheme, and the id is the actual identifier value. For example, for a Belgian company it is 0208:0123456789 (where 0208 is the scheme for Belgian enterprises, followed by the 10 digits of the official BTW / KBO number).
  • validate_ubl_validate (write): Validate the correctness of a UBL document

Resource lookup:

  • retrieve_lookup (read): Lookup Peppol ID. The peppol_id must be in the form of <scheme>:<id>. The scheme is a 4-digit code representing the identifier scheme, and the id is the actual identifier value. For example, for a Belgian company it is 0208:0123456789 (where 0208 is the scheme for Belgian enterprises, followed by the 10 digits of the official BTW / KBO number).

Resource webhooks:

  • create_webhooks (write): Create a new webhook
  • retrieve_webhooks (read): Get a webhook by ID
  • update_webhooks (write): Update a webhook by ID
  • list_webhooks (read): Get all webhooks for the current tenant
  • delete_webhooks (write): Delete a webhook

Readme

Keywords

none

Package Sidebar

Install

npm i e-invoice-api-mcp

Weekly Downloads

199

Version

1.4.2

License

Apache-2.0

Unpacked Size

593 kB

Total Files

303

Last publish

Collaborators

  • willemdg