JinDaGe - mcp-lexware-office MCP Details

article

README

🚀 Lexware Office MCP 服务器

Lexware Office MCP 服务器是一个集成了 Lexware Office（前称为 Lexoffice）的 MCP 服务器实现。它通过模型上下文协议提供无缝接口，可用于管理企业的各类业务操作，为企业业务管理提供便利。

✨ 主要特性

Lexware Office 集成：能够直接与 Lexware Office API 进行集成，实现数据的交互与同步。
企业管理：可对发票、联系人和其他业务文档进行管理，不过目前仅支持只读操作。

📦 安装指南

获取 Lexware Office API 密钥

访问 https://app.lexoffice.de/addons/public-api 即可获取您的 API 密钥。

先决条件

需要安装 Node.js 22 或更高版本。

使用 Claude Desktop

将以下内容添加到 claude_desktop_config.json 文件中：

{
    "mcpServers": {
        "mcp-lexware-office": {
            "command": "docker",
            "args": ["run", "-i", "--rm", "-e", "LEXWARE_OFFICE_API_KEY", "mcp-lexware-office"],
            "env": {
                "LEXWARE_OFFICE_API_KEY": "YOUR_API_KEY_HERE"
            }
        }
    }
}

使用 NPX

{
    "mcpServers": {
        "mcp-lexware-office": {
            "command": "npx",
            "args": ["-y", "JannikWempe/mcp-lexware-office"],
            "env": {
                "LEXWARE_OFFICE_API_KEY": "YOUR_API_KEY_HERE"
            }
        }
    }
}

💻 使用示例

工具说明

以下工具可通过此 MCP 服务器使用：

get-invoices

功能：获取 Lexware Office 中的发票列表。
输入参数：
- status (字符串数组，可选)：可按状态过滤（"open", "draft", "paid", "paidoff", "voided"），默认获取所有状态的发票。
- page (数字，可选)：要获取的页码（从 0 开始），默认页码为 0。
- size (数字，可选)：每页显示的发票数量（范围为 1 - 250），默认每页显示 250 条。

get-invoice-details

功能：获取 Lexware Office 中某个发票的详细信息。
输入参数：
- id (字符串)：发票的 UUID。

get-contacts

功能：按条件获取 Lexware Office 中的联系人，支持逻辑与的多个过滤器。
输入参数：
- email (字符串，可选)：按电子邮件地址过滤（支持通配符）。
- name (字符串，可选)：按名称过滤（支持通配符）。
- number (数字，可选)：按联系人编号过滤。
- customer (布尔值，可选)：按客户角色过滤。
- vendor (布尔值，可选)：按供应商角色过滤。
- page (数字，可选)：要获取的页码（从 0 开始），默认页码为 0。
- size (数字，可选)：每页显示的联系人数量（范围为 1 - 250），默认每页显示 250 条。

list-posting-categories

功能：获取会计凭证使用的分录类别的列表。
输入参数：
- type (字符串，可选)：按类别类型过滤（"income" 或 "outgo"）。

list-countries

功能：获取 Lexware Office 中已知的国家及其税收分类信息。
输入参数：
- taxClassification (字符串，可选)：按税收分类过滤（"de" 表示德国，"intraCommunity" 表示欧盟国家，或 "thirdPartyCountry" 表示非欧盟国家）。

🔧 技术细节

项目构建

要构建此项目，请运行以下命令：

npm install

构建说明

项目依赖于 Node.js 环境。
确保安装所有所需的依赖项。

📄 许可证

请参考项目的 LICENSE 文件以获取许可详细信息。

mcp-lexware-office