e-invoice-api-mcp
v1.24.1
Published
The official MCP Server for the e-invoice.be Peppol API
Readme
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@latestVia 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"
}
}
}
}Cursor
If you use Cursor, you can install the MCP server by using the button below. You will need to set your environment variables
in Cursor's mcp.json, which can be found in Cursor Settings > Tools & MCP > New MCP Server.
VS Code
If you use MCP, you can install the MCP server by clicking the link below. You will need to set your environment variables
in VS Code's mcp.json, which can be found via Command Palette > MCP: Open User Configuration.
Claude Code
If you use Claude Code, you can install the MCP server by running the command below in your terminal. You will need to set your
environment variables in Claude Code's .claude.json, which can be found in your home directory.
claude mcp add --transport stdio e_invoice_api_api --env E_INVOICE_API_KEY="Your E_INVOICE_API_KEY here." -- npx -y e-invoice-api-mcpExposing endpoints to your MCP Client
There are three ways to expose endpoints as tools in the MCP server:
- Exposing one tool per endpoint, and filtering as necessary
- Exposing a set of tools to dynamically discover and invoke endpoints from the API
- Exposing a docs search tool and a code execution tool, allowing the client to write code to be executed against the TypeScript client
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:
--toolincludes a specific tool by name--resourceincludes all tools under a specific resource, and can have wildcards, e.g.my.resource*--operationincludes 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:
list_api_endpoints- Discovers available endpoints, with optional filtering by search queryget_api_endpoint_schema- Gets detailed schema information for a specific endpointinvoke_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.
Code execution
If you specify --tools=code to the MCP server, it will expose just two tools:
search_docs- Searches the API documentation and returns a list of markdown resultsexecute- Runs code against the TypeScript client
This allows the LLM to implement more complex logic by chaining together many API calls without loading intermediary results into its context window.
The code execution itself happens in a Deno sandbox that has network access only to the base URL for the API.
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
- Valid values:
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 schemasvalid-json: Enable JSON string parsing for argumentsrefs: Enable support for $ref pointers in schemasunions: Enable support for union types (anyOf) in schemasformats: 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
- Available capabilities:
Examples
- Filter for read operations on cards:
--resource=cards --operation=read- Exclude specific tools while including others:
--resource=cards --no-tool=create_cards- Configure for Cursor client with custom max tool name length:
--client=cursor --capability=tool-name-length=40- Complex filtering with multiple criteria:
--resource=cards,accounts --operation=read --tag=kyc --no-tool=create_cardsRunning remotely
Launching the client with --transport=http launches the server as a remote server using Streamable HTTP transport. The --port setting can choose the port it will run on, and the --socket setting allows it to run on a Unix socket.
Authorization can be provided via the Authorization header using the Bearer scheme.
Additionally, authorization can be provided via the following headers:
| Header | Equivalent client option | Security scheme |
| --------------------- | ------------------------ | --------------- |
| x-e-invoice-api-key | apiKey | HTTPBearer |
A configuration JSON for this server might look like this, assuming the server is hosted at http://localhost:3000:
{
"mcpServers": {
"e_invoice_api_api": {
"url": "http://localhost:3000",
"headers": {
"Authorization": "Bearer <auth value>"
}
}
}
}The command-line arguments for filtering tools and specifying clients can also be used as query parameters in the URL. For example, to exclude specific tools while including others, use the URL:
http://localhost:3000?resource=cards&resource=accounts&no_tool=create_cardsOr, to configure for the Cursor client, with a custom max tool name length, use the URL:
http://localhost:3000?client=cursor&capability=tool-name-length%3D40Importing 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 noteretrieve_documents(read): Get an invoice or credit note by IDdelete_documents(write): Delete an invoice or credit notecreate_from_pdf_documents(write): Create a new invoice or credit note from a PDF file. If the 'ubl_document' field is set in the response, it indicates that sufficient details were extracted from the PDF to automatically generate a valid UBL document ready for sending. If 'ubl_document' is not set, human intervention may be required to ensure compliance.send_documents(write): Send an invoice or credit note via Peppolvalidate_documents(write): Validate a UBL document according to Peppol BIS Billing 3.0
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 notedelete_documents_attachments(write): Delete an attachment from an invoice or credit noteadd_documents_attachments(write): Add a new attachment to an invoice or credit note
Resource documents.ubl:
create_from_ubl_documents_ubl(write): Create a new invoice or credit note from a UBL fileget_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 including state, type, sender, date range, and text search.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 sent documents with filtering options including state, type, sender, date range, and text search.
Resource validate:
validate_json_validate(write): Validate if the JSON document can be converted to a valid UBL documentvalidate_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 is0208: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 is0208:0123456789(where 0208 is the scheme for Belgian enterprises, followed by the 10 digits of the official BTW / KBO number).retrieve_participants_lookup(read): Lookup Peppol participants by name or other identifiers. You can limit the search to a specific country by providing the country code.
Resource me:
retrieve_me(read): Retrieve information about your account.
Resource webhooks:
create_webhooks(write): Create a new webhookretrieve_webhooks(read): Get a webhook by IDupdate_webhooks(write): Update a webhook by IDlist_webhooks(read): Get all webhooks for the current tenantdelete_webhooks(write): Delete a webhook
