[{"_1":2,"_356":-5,"_357":-5},"loaderData",{"_3":4,"_22":23,"_24":25,"_293":294},"root",{"_5":6,"_7":8},"toasts",[],"visitor",{"_9":10,"_11":12},"viewportWidth",1280,"visitorSession",{"_13":14,"_16":17,"_18":-5,"_19":20,"_21":-5},"attributes",[15],"bot","id",10593752,"membership","referenceId","01987e07-4c20-748c-bd05-d570dbf6aa64","userAccount","routes/_public/_layout",{},"routes/_public/mcp/servers/~namespace/~slug/_pages/_layout",{"_26":27,"_80":-5,"_81":40,"_29":82,"_210":211,"_292":174},"availableLocales",[28,40,46,53,60,67,73],{"_29":30,"_33":37,"_38":39},"mcpServer",{"_31":32,"_33":34,"_35":36},"description","Ein Toolkit, das es KI-Assistenten ermöglicht, Feishu/Lark-API-Schnittstellen für Automatisierungsszenarien wie Dokumentenverarbeitung, Konversationsverwaltung und Kalenderplanung direkt aufzurufen.","name","Feishu/Lark OpenAPI MCP","readme","# Feishu/Lark OpenAPI MCP\n\n[![npm-Version](https://img.shields.io/npm/v/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![npm-Downloads](https://img.shields.io/npm/dm/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![Node.js-Version](https://img.shields.io/node/v/@larksuiteoapi/lark-mcp.svg)](https://nodejs.org/)\n\nEnglisch |[中文](./README_ZH.md)\n\n[Abruf der Entwicklerdokumentation MCP](./README_RECALL.md) | [Offizielles Dokument](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/mcp_introduction)\n\n> **⚠️ Hinweis zur Beta-Version** : Dieses Tool befindet sich derzeit in der Beta-Phase. Funktionen und APIs können sich ändern. Bleiben Sie daher über die neuesten Versionen auf dem Laufenden.\n\nDies ist das offizielle OpenAPI MCP-Tool (Model Context Protocol) von Feishu/Lark. Es ermöglicht Benutzern eine schnelle Verbindung zur Feishu/Lark-Plattform und ermöglicht eine effiziente Zusammenarbeit zwischen KI-Agenten und Feishu/Lark. Das Tool kapselt die API-Schnittstellen der Feishu/Lark Open Platform als MCP-Tools. KI-Assistenten können diese Schnittstellen direkt aufrufen und verschiedene Automatisierungsszenarien wie Dokumentenverarbeitung, Konversationsmanagement, Kalenderplanung und mehr implementieren.\n\n## Merkmale\n\n* **Komplettes Feishu/Lark API-Toolkit:** Kapselt fast alle Feishu/Lark API-Schnittstellen, einschließlich Nachrichtenverwaltung, Gruppenverwaltung, Dokumentvorgänge, Kalenderereignisse, Bitable und andere zentrale Funktionsbereiche.\n\n* **Unterstützung für doppelte Authentifizierung:**\n\n * Unterstützt App Access Token-Authentifizierung\n * Unterstützt die Benutzerzugriffstoken-Authentifizierung\n\n* **Flexible Kommunikationsprotokolle:**\n\n * Unterstützt den Standard-Eingabe-/Ausgabe-Stream-Modus (stdio), geeignet für die Integration mit KI-Tools wie Trae/Cursor/Claude\n * Unterstützt den Server-Sent Events (SSE)-Modus und bietet HTTP-basierte Schnittstellen\n\n* Unterstützt mehrere Konfigurationsmethoden und passt sich an unterschiedliche Nutzungsszenarien an\n\n## Werkzeugliste\n\nEine vollständige Liste aller unterstützten Feishu/Lark-Tools finden Sie in [tools.md](./docs/tools-en.md) , wo die Tools nach Projekt und Version mit Beschreibungen kategorisiert sind.\n\n## Vorbereitung\n\n### Erstellen einer Feishu/Lark-Anwendung\n\nBevor Sie das Lark-MCP-Tool verwenden, müssen Sie eine Feishu/Lark-Anwendung erstellen:\n\n1. Besuchen Sie die [Feishu Open Platform](https://open.feishu.cn/) oder [Lark Open Platform](https://open.larksuite.com/) und melden Sie sich an\n2. Klicken Sie auf „Konsole“ und erstellen Sie eine neue Anwendung\n3. Erhalten Sie die App-ID und das App-Geheimnis, die für die API-Authentifizierung verwendet werden\n4. Fügen Sie die erforderlichen Berechtigungen für Ihre Anwendung basierend auf Ihrem Nutzungsszenario hinzu\n5. Wenn Sie als Benutzer APIs aufrufen müssen, richten Sie OAuth 2.0-Umleitungs-URLs ein und erhalten Sie Benutzerzugriffstoken\n\nAusführliche Richtlinien zur Anwendungserstellung und -konfiguration finden Sie in der [Feishu Open Platform-Dokumentation – Erstellen einer Anwendung](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0) oder in der [Lark Open Platform-Dokumentation](https://open.larksuite.com/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0) .\n\n### Installieren von Node.js\n\nBevor Sie das Tool Lark-MCP verwenden, müssen Sie die Node.js-Umgebung installieren.\n\n#### Installieren von Node.js unter macOS\n\n1. **Verwendung von Homebrew (empfohlen)** :\n\n ```bash\n brew install node\n ```\n\n2. **Verwenden des offiziellen Installationsprogramms** :\n\n * Besuchen Sie die [Node.js-Website](https://nodejs.org/)\n\n * Laden Sie die LTS-Version herunter und installieren Sie sie\n\n * Überprüfen Sie nach der Installation im Terminal:\n\n ```bash\n node -v\n npm -v\n ```\n\n#### Installieren von Node.js unter Windows\n\n1. **Verwenden des offiziellen Installationsprogramms** :\n\n * Besuchen Sie die [Node.js-Website](https://nodejs.org/)\n\n * Laden Sie das Windows-Installationsprogramm (MSI-Datei) herunter und führen Sie es aus.\n\n * Folgen Sie dem Installationsassistenten, um die Installation abzuschließen\n\n * Überprüfen Sie nach der Installation in der Eingabeaufforderung:\n\n ```bash\n node -v\n npm -v\n ```\n\n2. **Verwenden von nvm-windows** :\n\n * [nvm-windows](https://github.com/coreybutler/nvm-windows/releases) herunterladen\n\n * Installieren Sie nvm-windows\n\n * Verwenden Sie nvm, um Node.js zu installieren:\n\n ```bash\n nvm install latest\n nvm use \n ```\n\n## Installation\n\nInstallieren Sie das Tool Lark-MCP global:\n\n```bash\nnpm install -g @larksuiteoapi/lark-mcp\n```\n\n## Benutzerhandbuch\n\n### Verwendung mit Trae/Cursor/Claude\n\nUm die Feishu/Lark-Funktionalität in KI-Tools wie Trae，Cursor oder Claude zu integrieren, fügen Sie Ihrer Konfigurationsdatei Folgendes hinzu:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\"\n ]\n }\n }\n}\n```\n\nUm mit der Benutzeridentität auf APIs zuzugreifen, können Sie ein Benutzerzugriffstoken hinzufügen:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\",\n \"-u\",\n \"\"\n ]\n }\n }\n}\n```\n\n### Benutzerdefinierte API-Konfiguration\n\nStandardmäßig aktiviert der MCP-Dienst allgemeine APIs. Um andere Tools oder nur bestimmte APIs oder Voreinstellungen zu aktivieren, können Sie diese mit dem Parameter `-t` (durch Kommas getrennt) angeben:\n\n```bash\nlark-mcp mcp -a -s -t im.v1.message.create,im.v1.message.list,im.v1.chat.create,preset.calendar.default\n```\n\n#### Voreingestellte Werkzeugsammlungen im Detail\n\nIn der folgenden Tabelle sind die einzelnen API-Tools und ihre Einbindung in die verschiedenen Vorgabesammlungen detailliert aufgeführt. So können Sie die passende Vorgabe für Ihre Anforderungen auswählen:\n\n| Werkzeugname | Funktionsbeschreibung | preset.default (Standard) | Vorgabe.im.default | Vorgabe.Basis.Standard | Vorgabe.Basis.Batch | voreingestellt.doc.default | voreingestellt.task.default | Vorgabe.Kalender.Standard |\n| ------------------------------------- | ------------------------------------------------------------------- | :-----------------------: | :----------------: | :--------------------: | :-----------------: | :------------------------: | :-------------------------: | :-----------------------: |\n| im.v1.chat.create | Erstellen eines Gruppenchats | ✓ | ✓ | | | | | |\n| im.v1.chat.list | Gruppenchatliste abrufen | ✓ | ✓ | | | | | |\n| im.v1.chatMembers.get | Gruppenmitglieder abrufen | ✓ | ✓ | | | | | |\n| im.v1.message.create | Nachrichten senden | ✓ | ✓ | | | | | |\n| im.v1.message.list | Nachrichtenliste abrufen | ✓ | ✓ | | | | | |\n| bitable.v1.app.create | Basis erstellen | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.create | Basisdatentabelle erstellen | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.list | Holen Sie sich die Basisdatentabellenliste | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableField.list | Holen Sie sich die Feldliste der Basisdatentabelle | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.search | Suchen Sie nach Datensätzen in der Basisdatentabelle | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.create | Erstellen von Basisdatentabellendatensätzen | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchCreate | Erstellen Sie im Stapelbetrieb Datensätze aus der Basisdatentabelle | | | | ✓ | | | |\n| bitable.v1.appTableRecord.update | Aktualisieren der Datensätze der Basisdatentabelle | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchUpdate | Stapelaktualisierung der Datensätze der Basisdatentabelle | | | | ✓ | | | |\n| docx.v1.document.rawContent | Dokumentinhalte abrufen | ✓ | | | | ✓ | | |\n| docx.builtin.import | Dokumente importieren | ✓ | | | | ✓ | | |\n| docx.builtin.search | Dokumente suchen | ✓ | | | | ✓ | | |\n| drive.v1.permissionMember.create | Berechtigungen für Mitarbeiter hinzufügen | ✓ | | | | ✓ | | |\n| wiki.v2.space.getNode | Wiki-Knoten abrufen | ✓ | | | | ✓ | | |\n| wiki.v1.node.search | Wiki-Knoten durchsuchen | ✓ | | | | ✓ | | |\n| contact.v3.user.batchGetId | Batch-Abruf von Benutzer-IDs | ✓ | | | | | | |\n| task.v2.task.create | Aufgabe erstellen | | | | | | ✓ | |\n| task.v2.task.patch | Aufgabe ändern | | | | | | ✓ | |\n| task.v2.task.addMembers | Aufgabenmitglieder hinzufügen | | | | | | ✓ | |\n| task.v2.task.addReminders | Aufgabenerinnerungen hinzufügen | | | | | | ✓ | |\n| calendar.v4.calendarEvent.create | Kalenderereignis erstellen | | | | | | | ✓ |\n| calendar.v4.calendarEvent.patch | Kalenderereignis ändern | | | | | | | ✓ |\n| calendar.v4.calendarEvent.get | Kalenderereignis abrufen | | | | | | | ✓ |\n| calendar.v4.freebusy.list | Frei/Gebucht-Status abfragen | | | | | | | ✓ |\n| calendar.v4.calendar.primary | Primärkalender abrufen | | | | | | | ✓ |\n\n> **Hinweis** : In der Tabelle zeigt „✓“ an, dass das Werkzeug in dieser Voreinstellung enthalten ist. Mit `-t preset.xxx` werden nur die Werkzeuge aktiviert, die in der entsprechenden Spalte mit „✓“ gekennzeichnet sind.\n\n### Erweiterte Konfiguration\n\n#### Befehlszeilenparameter\n\nDas `lark-mcp mcp` bietet verschiedene Befehlszeilenparameter für eine flexible MCP-Dienstkonfiguration:\n\n| Parameter | Kurz | Beschreibung | Beispiel |\n| --------------------- | ---- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------- |\n| `--app-id` | `-a` | App-ID der Feishu/Lark-Anwendung | `-a cli_xxxx` |\n| `--app-secret` | `-s` | App-Geheimnis der Feishu/Lark-Anwendung | `-s xxxx` |\n| `--domain` | `-d` | Feishu/Lark API-Domäne, Standard ist | `-d https://open.larksuite.com` |\n| `--tools` | `-t` | Liste der zu aktivierenden API-Tools, durch Kommas getrennt | `-t im.v1.message.create,im.v1.chat.create` |\n| `--tool-name-case` | `-c` | Werkzeugnamenformat, Optionen sind Schlange, Kamel, Punkt oder Kebab, Standard ist Schlange | `-c camel` |\n| `--language` | `-l` | Sprache der Tools, Optionen sind zh oder en, Standard ist en | `-l zh` |\n| `--user-access-token` | `-u` | Benutzerzugriffstoken zum Aufrufen von APIs als Benutzer | `-u u-xxxx` |\n| `--token-mode` | | API-Token-Typ, Optionen sind „auto“, „tenant\\_access\\_token“ oder „user\\_access\\_token“, Standard ist „auto“ | `--token-mode user_access_token` |\n| `--mode` | `-m` | Transportmodus, Optionen sind stdio oder sse, Standard ist stdio | `-m sse` |\n| `--host` | | Listening-Host im SSE-Modus, Standard ist localhost | `--host 0.0.0.0` |\n| `--port` | `-p` | Abhörport im SSE-Modus, Standard ist 3000 | `-p 3000` |\n| `--config` | | Konfigurationsdateipfad, unterstützt JSON-Format | `--config ./config.json` |\n| `--version` | `-V` | Versionsnummer anzeigen | `-V` |\n| `--help` | `-h` | Hilfeinformationen anzeigen | `-h` |\n\n#### Beispiele für die Parameterverwendung\n\n1. **Grundlegende Verwendung** (unter Verwendung der Anwendungsidentität):\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy\n ```\n\n2. **Verwenden der Benutzeridentität** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -u u-zzzz\n ```\n\n > **Hinweis** : Benutzerzugriffstoken können über den [Autorisierungsprozess der Feishu Open Platform](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/authentication-management/access-token/get-user-access-token) oder [der Lark Open Platform](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create) oder über die API-Debugging-Konsole abgerufen werden. Nach Verwendung eines Benutzerzugriffstokens werden API-Aufrufe mit der Identität dieses Benutzers ausgeführt.\n\n3. **Festlegen eines bestimmten Token-Modus** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy --token-mode user_access_token\n ```\n\n > **Hinweis** : Mit dieser Option können Sie explizit angeben, welcher Token-Typ beim Aufruf von APIs verwendet werden soll. Der `auto` Modus (Standard) wird vom LLM beim Aufruf der API festgelegt.\n\n4. **Angeben von Lark- oder KA-Domänen** :\n\n ```bash\n # Lark international version\n lark-mcp mcp -a -s -d https://open.larksuite.com\n\n # Custom domain (KA domain)\n lark-mcp mcp -a -s -d https://open.your-ka-domain.com\n ```\n\n5. **Aktivieren nur bestimmter API-Tools oder anderer API-Tools** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -t im.v1.chat.create,im.v1.message.create\n ```\n\n > **Hinweis** : Der Parameter `-t` unterstützt die folgenden voreingestellten Werkzeugsammlungen:\n >\n > * `preset.default` – Standard-Werkzeugsatz mit allen voreingestellten Werkzeugen\n > * `preset.im.default` – Tools für Instant Messaging, wie Gruppenverwaltung, Nachrichtenversand usw.\n > * `preset.bitable.default` – Bitable-bezogene Tools, wie Tabellenerstellung, Datensatzverwaltung usw.\n > * `preset.bitable.batch` – Bitable-Batchoperationstools, einschließlich Batch-Erstellungs- und Aktualisierungsfunktionen für Datensätze\n > * `preset.doc.default` – Dokumentbezogene Tools, wie z. B. Lesen von Dokumentinhalten, Berechtigungsverwaltung usw.\n > * `preset.task.default` – Tools zur Aufgabenverwaltung, wie Aufgabenerstellung, Mitgliederverwaltung usw.\n > * `preset.calendar.default` – Tools zur Verwaltung von Kalenderereignissen, z. B. Erstellen von Kalenderereignissen, Abfragen des Frei/Gebucht-Status usw.\n\n6. **Verwenden des SSE-Modus mit bestimmtem Port und Host** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -m sse --host 0.0.0.0 -p 3000\n ```\n\n7. **Einstellen der Werkzeugsprache auf Chinesisch** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -l zh\n ```\n\n > **Hinweis** : Wenn Sie die Sprache auf Chinesisch ( `-l zh` ) einstellen, werden möglicherweise mehr Token verbraucht. Sollten bei der Integration großer Sprachmodelle Probleme mit der Token-Begrenzung auftreten, sollten Sie die englische Standardeinstellung ( `-l en` ) verwenden.\n\n8. **Festlegen des Toolnamenformats auf Camel Case** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -c camel\n ```\n\n > **Hinweis** : Durch Festlegen des Werkzeugnamenformats können Sie die Anzeige von Werkzeugnamen im MCP ändern. Beispiel: `im.v1.message.create` in verschiedenen Formaten:\n >\n > * Snake-Format (Standard): `im_v1_message_create`\n > * Kamelformat: `imV1MessageCreate`\n > * Kebab-Format: `im-v1-message-create`\n > * Punktformat: `im.v1.message.create`\n\n9. **Verwenden von Umgebungsvariablen anstelle von Befehlszeilenparametern** :\n\n ```bash\n # Set environment variables\n export APP_ID=cli_xxxx\n export APP_SECRET=yyyyy\n\n # Start the service (no need to specify -a and -s parameters)\n lark-mcp mcp\n ```\n\n10. **Konfigurationsdatei verwenden** :\n\nNeben Befehlszeilenparametern können Sie zum Festlegen von Parametern auch eine Konfigurationsdatei im JSON-Format verwenden:\n\n```bash\nlark-mcp mcp --config ./config.json\n```\n\nBeispiel einer Konfigurationsdatei (config.json):\n\n```json\n{\n \"appId\": \"cli_xxxx\",\n \"appSecret\": \"xxxx\",\n \"domain\": \"https://open.feishu.cn\",\n \"tools\": [\"im.v1.message.create\",\"im.v1.chat.create\"],\n \"toolNameCase\": \"snake\",\n \"language\": \"zh\",\n \"userAccessToken\": \"\",\n \"tokenMode\": \"auto\",\n \"mode\": \"stdio\",\n \"host\": \"localhost\",\n \"port\": \"3000\"\n}\n```\n\n> **Hinweis** : Befehlszeilenparameter haben eine höhere Priorität als die Konfigurationsdatei. Wenn Sie sowohl Befehlszeilenparameter als auch eine Konfigurationsdatei verwenden, überschreiben die Befehlszeilenparameter die entsprechenden Einstellungen in der Konfigurationsdatei.\n\n11. **Transportarten** :\n\nlark-mcp unterstützt zwei Transportmodi:\n\n1. **stdio-Modus (Standard/Empfohlen)** : Geeignet für die Integration mit KI-Tools wie Trae/Cursor oder Claude, die über standardmäßige Eingabe-/Ausgabestreams kommunizieren.\n\n```bash\nlark-mcp mcp -a -s -m stdio\n```\n\n2. **SSE-Modus** : Bietet eine HTTP-Schnittstelle basierend auf vom Server gesendeten Ereignissen, geeignet für Szenarien, in denen eine lokale Ausführung nicht möglich ist.\n\n```bash\n# Default listens only on localhost\nlark-mcp mcp -a -s -m sse -p 3000\n\n# Listen on all network interfaces (allowing remote access)\nlark-mcp mcp -a -s -m sse --host 0.0.0.0 -p 3000\n```\n\nNach dem Start ist der SSE-Endpunkt unter `http://:/sse` erreichbar.\n\n## Häufig gestellte Fragen\n\n* **Problem** : Keine Verbindung zur Feishu/Lark API möglich. **Lösung** : Überprüfen Sie Ihre Netzwerkverbindung und stellen Sie sicher, dass Ihre APP\\_ID und Ihr APP\\_SECRET korrekt sind. Stellen Sie sicher, dass Sie auf die Feishu/Lark Open Platform API zugreifen können. Möglicherweise müssen Sie einen Proxy konfigurieren.\n\n* **Problem** : Fehler bei der Verwendung des Benutzerzugriffstokens. **Lösung** : Prüfen Sie, ob das Token abgelaufen ist. Das Benutzerzugriffstoken hat in der Regel eine Gültigkeitsdauer von zwei Stunden und muss regelmäßig aktualisiert werden. Sie können einen automatischen Token-Aktualisierungsmechanismus implementieren.\n\n* **Problem** : Nach dem Start des MCP-Dienstes können bestimmte APIs nicht aufgerufen werden, da Fehlermeldungen wegen unzureichender Berechtigungen auftreten. **Lösung** : Prüfen Sie, ob Ihre Anwendung über die entsprechenden API-Berechtigungen verfügt. Einige APIs erfordern zusätzliche Berechtigungen auf höherer Ebene, die in der [Entwicklerkonsole](https://open.feishu.cn/app) oder [der Lark-Entwicklerkonsole](https://open.larksuite.com/app) konfiguriert werden können. Stellen Sie sicher, dass die Berechtigungen genehmigt wurden.\n\n* **Problem** : API-Aufrufe für den Upload/Download von Bildern oder Dateien schlagen fehl. **Lösung** : Die aktuelle Version unterstützt die Upload-/Download-Funktion für Dateien und Bilder nicht. Diese APIs werden in zukünftigen Versionen unterstützt.\n\n* **Problem** : Die Befehlszeile zeigt in der Windows-Umgebung unleserliche Zeichen an. **Lösung** : Ändern Sie die Befehlszeilenkodierung in UTF-8, indem Sie in der Eingabeaufforderung `chcp 65001` ausführen. Bei Verwendung von PowerShell müssen Sie möglicherweise die Terminalschriftart oder die PowerShell-Konfiguration ändern.\n\n* **Problem** : Berechtigungsfehler während der Installation. **Lösung** : Verwenden Sie unter macOS/Linux `sudo npm install -g @larksuiteoapi/lark-mcp` für die Installation oder ändern Sie die Berechtigungen des globalen npm-Installationspfads. Windows-Benutzer können versuchen, die Eingabeaufforderung als Administrator auszuführen.\n\n* **Problem** : Token-Limit nach dem Starten des MCP-Dienstes überschritten. **Lösung** : Versuchen Sie, mit `-t` die Anzahl der aktivierten APIs zu reduzieren, oder verwenden Sie ein Modell, das größere Token unterstützt (z. B. claude3.7).\n\n* **Problem** : Im SSE-Modus kann keine Verbindung hergestellt oder Nachrichten empfangen werden. **Lösung** : Überprüfen Sie, ob der Port bereits verwendet wird, und versuchen Sie, zu einem anderen Port zu wechseln. Stellen Sie sicher, dass der Client korrekt mit dem SSE-Endpunkt verbunden ist und den Ereignisdatenstrom verarbeitet.\n\n## Weiterführende Links\n\n* [Offene Feishu-Plattform](https://open.feishu.cn/)\n* [Lark International Offene Plattform](https://open.larksuite.com/)\n* [Feishu Open Platform API-Dokumentation](https://open.feishu.cn/document/home/index)\n* [Lark Open Platform API-Dokumentation](https://open.larksuite.com/document/home/index)\n* [Node.js-Website](https://nodejs.org/)\n* [npm-Dokumentation](https://docs.npmjs.com/)\n\n## Rückmeldung\n\nWir freuen uns über Ihre Rückmeldungen, um dieses Tool zu verbessern. Wenn Sie Fragen oder Anregungen haben, stellen Sie diese bitte im GitHub-Repository.","German","tag","de-DE",{"_29":41,"_33":44,"_38":45},{"_31":42,"_33":34,"_35":43},"A toolkit that enables AI assistants to directly call Feishu/Lark API interfaces for automation scenarios like document processing, conversation management, and calendar scheduling.","# Feishu/Lark OpenAPI MCP\n\n[![npm version](https://img.shields.io/npm/v/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp)\n[![npm downloads](https://img.shields.io/npm/dm/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp)\n[![Node.js Version](https://img.shields.io/node/v/@larksuiteoapi/lark-mcp.svg)](https://nodejs.org/)\n\nEnglish | [中文](./README_ZH.md)\n\n[Developer Documentation Retrieval MCP](./README_RECALL.md) | [Official Document](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/mcp_introduction)\n\n> **⚠️ Beta Version Notice**: This tool is currently in Beta stage. Features and APIs may change, so please stay updated with version releases.\n\nThis is the Feishu/Lark official OpenAPI MCP (Model Context Protocol) tool designed to help users quickly connect to the Feishu/Lark platform and enable efficient collaboration between AI Agents and Feishu/Lark. The tool encapsulates Feishu/Lark Open Platform API interfaces as MCP tools, allowing AI assistants to directly call these interfaces and implement various automation scenarios such as document processing, conversation management, calendar scheduling, and more.\n\n## Features\n\n- **Complete Feishu/Lark API Toolkit:** Encapsulates almost all Feishu/Lark API interfaces, including message management, group management, document operations, calendar events, Bitable, and other core functional areas.\n- **Dual Authentication Support:**\n - Supports App Access Token authentication\n - Supports User Access Token authentication\n- **Flexible Communication Protocols:**\n - Supports standard input/output stream (stdio) mode, suitable for integration with AI tools like Trae/Cursor/Claude\n - Supports Server-Sent Events (SSE) mode, providing HTTP-based interfaces\n\n- Supports multiple configuration methods, adapting to different usage scenarios\n\n## Tool List\n\nA complete list of all supported Feishu/Lark tools can be found in [tools.md](./docs/tools-en.md), where tools are categorized by project and version with descriptions.\n\n## Preparation\n\n### Creating a Feishu/Lark Application\n\nBefore using the lark-mcp tool, you need to create a Feishu/Lark application:\n\n1. Visit the [Feishu Open Platform](https://open.feishu.cn/) or [Lark Open Platform](https://open.larksuite.com/) and log in\n2. Click \"Console\" and create a new application\n3. Obtain the App ID and App Secret, which will be used for API authentication\n4. Add the necessary permissions for your application based on your usage scenario\n5. If you need to call APIs as a user, set up OAuth 2.0 redirect URLs and obtain user access tokens\n\nFor detailed application creation and configuration guidelines, please refer to the [Feishu Open Platform Documentation - Creating an Application](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0) or the [Lark Open Platform Documentation](https://open.larksuite.com/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0).\n\n### Installing Node.js\n\nBefore using the lark-mcp tool, you need to install the Node.js environment.\n\n#### Installing Node.js on macOS\n\n1. **Using Homebrew (Recommended)**:\n\n ```bash\n brew install node\n ```\n\n2. **Using the Official Installer**:\n - Visit the [Node.js website](https://nodejs.org/)\n - Download and install the LTS version\n - After installation, verify in the terminal:\n ```bash\n node -v\n npm -v\n ```\n\n#### Installing Node.js on Windows\n\n1. **Using the Official Installer**:\n\n - Visit the [Node.js website](https://nodejs.org/)\n - Download and run the Windows installer (.msi file)\n - Follow the installation wizard to complete the installation\n - After installation, verify in the command prompt:\n ```bash\n node -v\n npm -v\n ```\n\n2. **Using nvm-windows**:\n - Download [nvm-windows](https://github.com/coreybutler/nvm-windows/releases)\n - Install nvm-windows\n - Use nvm to install Node.js:\n ```bash\n nvm install latest\n nvm use \n ```\n\n## Installation\n\nInstall the lark-mcp tool globally:\n\n```bash\nnpm install -g @larksuiteoapi/lark-mcp\n```\n\n## Usage Guide\n\n### Using with Trae/Cursor/Claude\n\nTo integrate Feishu/Lark functionality in AI tools like Trae，Cursor or Claude, add the following to your configuration file:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\"\n ]\n }\n }\n}\n```\n\nTo access APIs with user identity, you can add a user access token:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\",\n \"-u\",\n \"\"\n ]\n }\n }\n}\n```\n\n### Custom API Configuration\n\nBy default, the MCP service enables common APIs. To enable other tools or only specific APIs or presets, you can specify them using the `-t` parameter (separated by commas):\n\n```bash\nlark-mcp mcp -a -s -t im.v1.message.create,im.v1.message.list,im.v1.chat.create,preset.calendar.default\n```\n\n#### Preset Tool Collections in Detail\n\nThe following table details each API tool and its inclusion in different preset collections, helping you choose the appropriate preset for your needs:\n\n| Tool Name | Function Description | preset.default (Default) | preset.im.default | preset.base.default | preset.base.batch | preset.doc.default | preset.task.default | preset.calendar.default |\n| --- | --- | :---: | :---: | :---: | :---: | :---: | :---: | :---: |\n| im.v1.chat.create | Create a group chat | ✓ | ✓ | | | | | |\n| im.v1.chat.list | Get group chat list | ✓ | ✓ | | | | | |\n| im.v1.chatMembers.get | Get group members | ✓ | ✓ | | | | | |\n| im.v1.message.create | Send messages | ✓ | ✓ | | | | | |\n| im.v1.message.list | Get message list | ✓ | ✓ | | | | | |\n| bitable.v1.app.create | Create base | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.create | Create base data table | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.list | Get base data table list | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableField.list | Get base data table field list | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.search | Search base data table records | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.create | Create base data table records | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchCreate | Batch create base data table records | | | | ✓ | | | |\n| bitable.v1.appTableRecord.update | Update base data table records | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchUpdate | Batch update base data table records | | | | ✓ | | | |\n| docx.v1.document.rawContent | Get document content | ✓ | | | | ✓ | | |\n| docx.builtin.import | Import documents | ✓ | | | | ✓ | | |\n| docx.builtin.search | Search documents | ✓ | | | | ✓ | | |\n| drive.v1.permissionMember.create | Add collaborator permissions | ✓ | | | | ✓ | | |\n| wiki.v2.space.getNode | Get Wiki node | ✓ | | | | ✓ | | |\n| wiki.v1.node.search | Search Wiki nodes | ✓ | | | | ✓ | | |\n| contact.v3.user.batchGetId | Batch get user IDs | ✓ | | | | | | |\n| task.v2.task.create | Create task | | | | | | ✓ | |\n| task.v2.task.patch | Modify task | | | | | | ✓ | |\n| task.v2.task.addMembers | Add task members | | | | | | ✓ | |\n| task.v2.task.addReminders | Add task reminders | | | | | | ✓ | |\n| calendar.v4.calendarEvent.create | Create calendar event | | | | | | | ✓ |\n| calendar.v4.calendarEvent.patch | Modify calendar event | | | | | | | ✓ |\n| calendar.v4.calendarEvent.get | Get calendar event | | | | | | | ✓ |\n| calendar.v4.freebusy.list | Query free/busy status | | | | | | | ✓ |\n| calendar.v4.calendar.primary | Get primary calendar | | | | | | | ✓ |\n\n> **Note**: In the table, \"✓\" indicates the tool is included in that preset. Using `-t preset.xxx` will only enable tools marked with \"✓\" in the corresponding column.\n\n### Advanced Configuration\n\n#### Command Line Parameters\n\nThe `lark-mcp mcp` tool provides various command line parameters for flexible MCP service configuration:\n\n| Parameter | Short | Description | Example |\n|------|------|------|------|\n| `--app-id` | `-a` | Feishu/Lark application App ID | `-a cli_xxxx` |\n| `--app-secret` | `-s` | Feishu/Lark application App Secret | `-s xxxx` |\n| `--domain` | `-d` | Feishu/Lark API domain, default is https://open.feishu.cn | `-d https://open.larksuite.com` |\n| `--tools` | `-t` | List of API tools to enable, separated by commas | `-t im.v1.message.create,im.v1.chat.create` |\n| `--tool-name-case` | `-c` | Tool name format, options are snake, camel, dot, or kebab, default is snake | `-c camel` |\n| `--language` | `-l` | Tools language, options are zh or en, default is en | `-l zh` |\n| `--user-access-token` | `-u` | User access token for calling APIs as a user | `-u u-xxxx` |\n| `--token-mode` | | API token type, options are auto, tenant_access_token, or user_access_token, default is auto | `--token-mode user_access_token` |\n| `--mode` | `-m` | Transport mode, options are stdio or sse, default is stdio | `-m sse` |\n| `--host` | | Listening host in SSE mode, default is localhost | `--host 0.0.0.0` |\n| `--port` | `-p` | Listening port in SSE mode, default is 3000 | `-p 3000` |\n| `--config` | | Configuration file path, supports JSON format | `--config ./config.json` |\n| `--version` | `-V` | Display version number | `-V` |\n| `--help` | `-h` | Display help information | `-h` |\n\n#### Parameter Usage Examples\n\n1. **Basic Usage** (using application identity):\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy\n ```\n\n2. **Using User Identity**:\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -u u-zzzz\n ```\n\n > **Note**: User access tokens can be obtained through the [Feishu Open Platform's authorization process](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/authentication-management/access-token/get-user-access-token) or [Lark Open Platform's authorization process](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create), or you can use the API debugging console to obtain them. After using a user access token, API calls will be made with that user's identity.\n\n3. **Setting Specific Token Mode**:\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy --token-mode user_access_token\n ```\n \n > **Note**: This option allows you to explicitly specify which token type to use when calling APIs. The `auto` mode (default) will be determined by the LLM when calling the API.\n\n4. **Specifying Lark or KA Domains**:\n ```bash\n # Lark international version\n lark-mcp mcp -a -s -d https://open.larksuite.com\n\n # Custom domain (KA domain)\n lark-mcp mcp -a -s -d https://open.your-ka-domain.com\n ```\n\n5. **Enabling Only Specific API Tools or Other API Tools**:\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -t im.v1.chat.create,im.v1.message.create\n ```\n\n > **Note**: The `-t` parameter supports the following preset tool collections:\n > - `preset.default` - Default tool set containing all preset tools\n > - `preset.im.default` - Instant messaging related tools, such as group management, message sending, etc.\n > - `preset.bitable.default` - Bitable related tools, such as table creation, record management, etc.\n > - `preset.bitable.batch` - Bitable batch operation tools, including batch create and update record functions\n > - `preset.doc.default` - Document related tools, such as document content reading, permission management, etc.\n > - `preset.task.default` - Task management related tools, such as task creation, member management, etc.\n > - `preset.calendar.default` - Calendar event management tools, such as creating calendar events, querying free/busy status, etc.\n\n6. **Using SSE Mode with Specific Port and Host**:\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -m sse --host 0.0.0.0 -p 3000\n ```\n\n7. **Setting Tools Language to Chinese**:\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -l zh\n ```\n \n > **Note**: Setting the language to Chinese (`-l zh`) may consume more tokens. If you encounter token limit issues when integrating with large language models, consider using the default English setting (`-l en`).\n\n8. **Setting Tool Name Format to Camel Case**:\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -c camel\n ```\n \n > **Note**: By setting the tool name format, you can change how tool names appear in the MCP. For example, `im.v1.message.create` in different formats:\n > - snake format (default): `im_v1_message_create`\n > - camel format: `imV1MessageCreate`\n > - kebab format: `im-v1-message-create`\n > - dot format: `im.v1.message.create`\n\n9. **Using Environment Variables Instead of Command Line Parameters**:\n ```bash\n # Set environment variables\n export APP_ID=cli_xxxx\n export APP_SECRET=yyyyy\n \n # Start the service (no need to specify -a and -s parameters)\n lark-mcp mcp\n ```\n\n10. **Using Configuration File**:\n\n Besides command line parameters, you can also use a JSON format configuration file to set parameters:\n\n ```bash\n lark-mcp mcp --config ./config.json\n ```\n\n Configuration file example (config.json):\n\n ```json\n {\n \"appId\": \"cli_xxxx\",\n \"appSecret\": \"xxxx\",\n \"domain\": \"https://open.feishu.cn\",\n \"tools\": [\"im.v1.message.create\",\"im.v1.chat.create\"],\n \"toolNameCase\": \"snake\",\n \"language\": \"zh\",\n \"userAccessToken\": \"\",\n \"tokenMode\": \"auto\",\n \"mode\": \"stdio\",\n \"host\": \"localhost\",\n \"port\": \"3000\"\n }\n ```\n\n > **Note**: Command line parameters have higher priority than configuration file. When using both command line parameters and configuration file, command line parameters will override corresponding settings in the configuration file.\n\n11. **Transport Modes**:\n\n lark-mcp supports two transport modes:\n\n 1. **stdio mode (Default/Recommended)**: Suitable for integration with AI tools like Trae/Cursor or Claude, communicating through standard input/output streams.\n ```bash\n lark-mcp mcp -a -s -m stdio\n ```\n\n 2. **SSE mode**: Provides an HTTP interface based on Server-Sent Events, suitable for scenarios where local execution is not possible.\n \n ```bash\n # Default listens only on localhost\n lark-mcp mcp -a -s -m sse -p 3000\n \n # Listen on all network interfaces (allowing remote access)\n lark-mcp mcp -a -s -m sse --host 0.0.0.0 -p 3000\n ```\n \n After startup, the SSE endpoint will be accessible at `http://:/sse`.\n\n## FAQ\n\n- **Issue**: Unable to connect to Feishu/Lark API\n **Solution**: Check your network connection and ensure your APP_ID and APP_SECRET are correct. Verify that you can access the Feishu/Lark Open Platform API; you may need to configure a proxy.\n\n- **Issue**: Error when using user_access_token\n **Solution**: Check if the token has expired. user_access_token usually has a validity period of 2 hours and needs to be refreshed periodically. You can implement an automatic token refresh mechanism.\n\n- **Issue**: Unable to call certain APIs after starting the MCP service, with insufficient permissions errors\n **Solution**: Check if your application has obtained the corresponding API permissions. Some APIs require additional high-level permissions, which can be configured in the [Developer Console](https://open.feishu.cn/app) or [Lark Developer Console](https://open.larksuite.com/app). Ensure that permissions have been approved.\n\n- **Issue**: Image or file upload/download related API calls fail\n **Solution**: The current version does not support file and image upload/download functionality. These APIs will be supported in future versions.\n\n- **Issue**: Command line displays garbled characters in Windows environment\n **Solution**: Change the command line encoding to UTF-8 by executing `chcp 65001` in the command prompt. If using PowerShell, you may need to change the terminal font or PowerShell configuration.\n\n- **Issue**: Permission errors during installation\n **Solution**: On macOS/Linux, use `sudo npm install -g @larksuiteoapi/lark-mcp` for installation, or modify the permissions of the npm global installation path. Windows users can try running the command prompt as administrator.\n\n- **Issue**: Token limit exceeded after starting the MCP service\n **Solution**: Try using `-t` to reduce the number of enabled APIs, or use a model that supports larger tokens (such as claude3.7).\n\n- **Issue**: Unable to connect or receive messages in SSE mode\n **Solution**: Check if the port is already in use and try changing to a different port. Ensure that the client is correctly connected to the SSE endpoint and is handling the event stream.\n\n## Related Links\n\n- [Feishu Open Platform](https://open.feishu.cn/)\n- [Lark International Open Platform](https://open.larksuite.com/)\n- [Feishu Open Platform API Documentation](https://open.feishu.cn/document/home/index)\n- [Lark Open Platform API Documentation](https://open.larksuite.com/document/home/index)\n- [Node.js Website](https://nodejs.org/)\n- [npm Documentation](https://docs.npmjs.com/)\n\n## Feedback\n\nIssues are welcome to help improve this tool. If you have any questions or suggestions, please raise them in the GitHub repository. ","English","en-US",{"_29":47,"_33":51,"_38":52},{"_31":48,"_33":49,"_35":50},"Un kit de herramientas que permite a los asistentes de IA llamar directamente a las interfaces API de Feishu/Lark para escenarios de automatización como procesamiento de documentos, gestión de conversaciones y programación de calendario.","MCP de OpenAPI de Feishu/Lark","# MCP de OpenAPI de Feishu/Lark\n\n[![versión npm](https://img.shields.io/npm/v/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![Descargas de npm](https://img.shields.io/npm/dm/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![Versión de Node.js](https://img.shields.io/node/v/@larksuiteoapi/lark-mcp.svg)](https://nodejs.org/)\n\ninglés |[中文](./README_ZH.md)\n\n[Recuperación de documentación para desarrolladores (MCP)](./README_RECALL.md) | [Documento oficial](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/mcp_introduction)\n\n> **Aviso de la versión beta** : Esta herramienta se encuentra actualmente en fase beta. Las funciones y API pueden cambiar, así que manténgase al tanto de las nuevas versiones.\n\nEsta es la herramienta oficial de Feishu/Lark para el Protocolo de Contexto de Modelo (MCP) de OpenAPI, diseñada para ayudar a los usuarios a conectarse rápidamente a la plataforma Feishu/Lark y facilitar la colaboración eficiente entre los agentes de IA y Feishu/Lark. Esta herramienta encapsula las interfaces de la API de Plataforma Abierta de Feishu/Lark como herramientas MCP, lo que permite a los asistentes de IA llamar directamente a estas interfaces e implementar diversos escenarios de automatización, como el procesamiento de documentos, la gestión de conversaciones, la programación de calendarios y más.\n\n## Características\n\n* **Kit de herramientas API completo de Feishu/Lark:** encapsula casi todas las interfaces API de Feishu/Lark, incluidas la gestión de mensajes, la gestión de grupos, las operaciones de documentos, los eventos de calendario, Bitable y otras áreas funcionales centrales.\n\n* **Soporte de autenticación dual:**\n\n * Admite autenticación mediante token de acceso a la aplicación\n * Admite autenticación de token de acceso de usuario\n\n* **Protocolos de comunicación flexibles:**\n\n * Admite el modo de flujo de entrada/salida estándar (stdio), adecuado para la integración con herramientas de IA como Trae/Cursor/Claude\n * Admite el modo de eventos enviados por el servidor (SSE), lo que proporciona interfaces basadas en HTTP\n\n* Admite múltiples métodos de configuración, adaptándose a diferentes escenarios de uso.\n\n## Lista de herramientas\n\nPuede encontrar una lista completa de todas las herramientas Feishu/Lark compatibles en [tools.md](./docs/tools-en.md) , donde las herramientas están categorizadas por proyecto y versión con descripciones.\n\n## Preparación\n\n### Creación de una aplicación Feishu/Lark\n\nAntes de utilizar la herramienta lark-mcp, debe crear una aplicación Feishu/Lark:\n\n1. Visita la [Plataforma Abierta Feishu](https://open.feishu.cn/) o [la Plataforma Abierta Lark](https://open.larksuite.com/) e inicia sesión\n2. Haga clic en \"Consola\" y cree una nueva aplicación\n3. Obtenga el ID de la aplicación y el secreto de la aplicación, que se utilizarán para la autenticación de la API\n4. Agregue los permisos necesarios para su aplicación según su escenario de uso\n5. Si necesita llamar a las API como usuario, configure las URL de redireccionamiento de OAuth 2.0 y obtenga tokens de acceso de usuario\n\nPara obtener pautas detalladas sobre la creación y configuración de aplicaciones, consulte la [Documentación de la plataforma abierta Feishu: Creación de una aplicación](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0) o la [Documentación de la plataforma abierta Lark](https://open.larksuite.com/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0) .\n\n### Instalación de Node.js\n\nAntes de utilizar la herramienta lark-mcp, debe instalar el entorno Node.js.\n\n#### Instalación de Node.js en macOS\n\n1. **Usando Homebrew (Recomendado)** :\n\n ```bash\n brew install node\n ```\n\n2. **Usando el instalador oficial** :\n\n * Visita el [sitio web de Node.js](https://nodejs.org/)\n\n * Descargue e instale la versión LTS\n\n * Luego de la instalación, verificar en la terminal:\n\n ```bash\n node -v\n npm -v\n ```\n\n#### Instalación de Node.js en Windows\n\n1. **Usando el instalador oficial** :\n\n * Visita el [sitio web de Node.js](https://nodejs.org/)\n\n * Descargue y ejecute el instalador de Windows (archivo .msi)\n\n * Siga el asistente de instalación para completar la instalación.\n\n * Después de la instalación, verifique en el símbolo del sistema:\n\n ```bash\n node -v\n npm -v\n ```\n\n2. **Usando nvm-windows** :\n\n * Descargar [nvm-windows](https://github.com/coreybutler/nvm-windows/releases)\n\n * Instalar nvm-windows\n\n * Utilice nvm para instalar Node.js:\n\n ```bash\n nvm install latest\n nvm use \n ```\n\n## Instalación\n\nInstalar la herramienta lark-mcp globalmente:\n\n```bash\nnpm install -g @larksuiteoapi/lark-mcp\n```\n\n## Guía de uso\n\n### Uso con Trae/Cursor/Claude\n\nPara integrar la funcionalidad de Feishu/Lark en herramientas de IA como Trae, Cursor o Claude, agregue lo siguiente a su archivo de configuración:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\"\n ]\n }\n }\n}\n```\n\nPara acceder a las API con identidad de usuario, puede agregar un token de acceso de usuario:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\",\n \"-u\",\n \"\"\n ]\n }\n }\n}\n```\n\n### Configuración de API personalizada\n\nDe forma predeterminada, el servicio MCP habilita las API comunes. Para habilitar otras herramientas o solo API o ajustes preestablecidos específicos, puede especificarlos mediante el parámetro `-t` (separados por comas):\n\n```bash\nlark-mcp mcp -a -s -t im.v1.message.create,im.v1.message.list,im.v1.chat.create,preset.calendar.default\n```\n\n#### Colecciones de herramientas preestablecidas en detalle\n\nLa siguiente tabla detalla cada herramienta API y su inclusión en diferentes colecciones de ajustes preestablecidos, lo que le ayudará a elegir el ajuste preestablecido adecuado para sus necesidades:\n\n| Nombre de la herramienta | Descripción de la función | preset.default (Predeterminado) | preset.im.default | preset.base.default | lote base preestablecido | preset.doc.default | tarea predefinida.predeterminada | calendario preestablecido.predeterminado |\n| ---------------------------------------- | -------------------------------------------------------------- | :-----------------------------: | :---------------: | :-----------------: | :----------------------: | :----------------: | :------------------------------: | :--------------------------------------: |\n| im.v1.chat.crear | Crear un chat grupal | ✓ | ✓ | | | | | |\n| im.v1.chat.list | Obtener la lista de chat grupal | ✓ | ✓ | | | | | |\n| im.v1.chatMembers.get | Conseguir miembros del grupo | ✓ | ✓ | | | | | |\n| im.v1.mensaje.crear | Enviar mensajes | ✓ | ✓ | | | | | |\n| im.v1.mensaje.lista | Obtener lista de mensajes | ✓ | ✓ | | | | | |\n| bitable.v1.app.create | Crear base | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.crear | Crear una tabla de datos base | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.list | Obtener la lista de tablas de datos base | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableField.list | Obtener la lista de campos de la tabla de datos base | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.búsqueda | Buscar registros de la tabla de datos base | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.crear | Crear registros de la tabla de datos base | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchCreate | Creación por lotes de registros de tablas de datos base | | | | ✓ | | | |\n| bitable.v1.appTableRecord.actualización | Actualizar los registros de la tabla de datos base | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchUpdate | Actualización por lotes de registros de la tabla de datos base | | | | ✓ | | | |\n| docx.v1.documento.rawContent | Obtener el contenido del documento | ✓ | | | | ✓ | | |\n| docx.builtin.import | Importar documentos | ✓ | | | | ✓ | | |\n| docx.búsqueda integrada | Buscar documentos | ✓ | | | | ✓ | | |\n| unidad.v1.permisoMember.crear | Agregar permisos de colaborador | ✓ | | | | ✓ | | |\n| wiki.v2.space.getNode | Obtener el nodo Wiki | ✓ | | | | ✓ | | |\n| wiki.v1.node.search | Buscar nodos Wiki | ✓ | | | | ✓ | | |\n| contacto.v3.usuario.batchGetId | Obtener ID de usuario por lotes | ✓ | | | | | | |\n| tarea.v2.tarea.crear | Crear tarea | | | | | | ✓ | |\n| tarea.v2.tarea.parche | Modificar tarea | | | | | | ✓ | |\n| tarea.v2.tarea.addMembers | Agregar miembros de la tarea | | | | | | ✓ | |\n| tarea.v2.tarea.añadirRecordatorios | Agregar recordatorios de tareas | | | | | | ✓ | |\n| calendario.v4.eventodecalendario.crear | Crear evento de calendario | | | | | | | ✓ |\n| calendario.v4.eventodecalendario.parche | Modificar evento del calendario | | | | | | | ✓ |\n| calendario.v4.eventodecalendario.obtener | Obtener evento del calendario | | | | | | | ✓ |\n| calendario.v4.freebusy.list | Consultar estado de libre/ocupado | | | | | | | ✓ |\n| calendario.v4.calendario.primario | Obtener el calendario principal | | | | | | | ✓ |\n\n> **Nota** : En la tabla, \"✓\" indica que la herramienta está incluida en ese preajuste. Usar `-t preset.xxx` solo habilitará las herramientas marcadas con \"✓\" en la columna correspondiente.\n\n### Configuración avanzada\n\n#### Parámetros de la línea de comandos\n\nLa herramienta `lark-mcp mcp` proporciona varios parámetros de línea de comandos para una configuración flexible del servicio MCP:\n\n| Parámetro | Corto | Descripción | Ejemplo |\n| --------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- |\n| `--app-id` | `-a` | ID de la aplicación Feishu/Lark | `-a cli_xxxx` |\n| `--app-secret` | `-s` | Aplicación Feishu/Lark App Secret | `-s xxxx` |\n| `--domain` | `-d` | Dominio API de Feishu/Lark, el valor predeterminado es | `-d https://open.larksuite.com` |\n| `--tools` | `-t` | Lista de herramientas API para habilitar, separadas por comas | `-t im.v1.message.create,im.v1.chat.create` |\n| `--tool-name-case` | `-c` | Formato del nombre de la herramienta, las opciones son serpiente, camello, punto o kebab, el valor predeterminado es serpiente | `-c camel` |\n| `--language` | `-l` | Idioma de las herramientas, las opciones son zh o en, el valor predeterminado es en | `-l zh` |\n| `--user-access-token` | `-u` | Token de acceso de usuario para llamar a las API como usuario | `-u u-xxxx` |\n| `--token-mode` | | Tipo de token de API, las opciones son auto, tenant\\_access\\_token o user\\_access\\_token, el valor predeterminado es auto | `--token-mode user_access_token` |\n| `--mode` | `-m` | Modo de transporte, las opciones son stdio o sse, el valor predeterminado es stdio | `-m sse` |\n| `--host` | | Host de escucha en modo SSE, el valor predeterminado es localhost | `--host 0.0.0.0` |\n| `--port` | `-p` | Puerto de escucha en modo SSE, el valor predeterminado es 3000 | `-p 3000` |\n| `--config` | | Ruta del archivo de configuración, admite formato JSON | `--config ./config.json` |\n| `--version` | `-V` | Mostrar el número de versión | `-V` |\n| `--help` | `-h` | Mostrar información de ayuda | `-h` |\n\n#### Ejemplos de uso de parámetros\n\n1. **Uso básico** (usando la identidad de la aplicación):\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy\n ```\n\n2. **Usando la identidad del usuario** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -u u-zzzz\n ```\n\n > **Nota** : Los tokens de acceso de usuario se pueden obtener mediante el [proceso de autorización de Feishu Open Platform](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/authentication-management/access-token/get-user-access-token) o [Lark Open Platform](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create) , o bien, puede usar la consola de depuración de la API para obtenerlos. Tras usar un token de acceso de usuario, las llamadas a la API se realizarán con la identidad de ese usuario.\n\n3. **Configuración del modo de token específico** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy --token-mode user_access_token\n ```\n\n > **Nota** : Esta opción permite especificar explícitamente el tipo de token que se usará al llamar a las API. El modo `auto` (predeterminado) lo determinará el LLM al llamar a la API.\n\n4. **Especificación de dominios Lark o KA** :\n\n ```bash\n # Lark international version\n lark-mcp mcp -a -s -d https://open.larksuite.com\n\n # Custom domain (KA domain)\n lark-mcp mcp -a -s -d https://open.your-ka-domain.com\n ```\n\n5. **Habilitar solo herramientas API específicas u otras herramientas API** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -t im.v1.chat.create,im.v1.message.create\n ```\n\n > **Nota** : El parámetro `-t` admite las siguientes colecciones de herramientas preestablecidas:\n >\n > * `preset.default` : conjunto de herramientas predeterminado que contiene todas las herramientas preestablecidas\n > * `preset.im.default` - Herramientas relacionadas con la mensajería instantánea, como gestión de grupos, envío de mensajes, etc.\n > * `preset.bitable.default` : herramientas relacionadas con Bitable, como creación de tablas, gestión de registros, etc.\n > * `preset.bitable.batch` : herramientas de operación por lotes de Bitable, que incluyen funciones de creación y actualización de registros por lotes\n > * `preset.doc.default` : herramientas relacionadas con los documentos, como lectura de contenido, gestión de permisos, etc.\n > * `preset.task.default` : herramientas relacionadas con la gestión de tareas, como creación de tareas, gestión de miembros, etc.\n > * `preset.calendar.default` : herramientas de gestión de eventos de calendario, como creación de eventos de calendario, consulta de estado libre/ocupado, etc.\n\n6. **Uso del modo SSE con un puerto y host específicos** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -m sse --host 0.0.0.0 -p 3000\n ```\n\n7. **Configuración del idioma de las herramientas en chino** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -l zh\n ```\n\n > **Nota** : Configurar el idioma en chino ( `-l zh` ) puede consumir más tokens. Si tiene problemas con el límite de tokens al integrar con modelos de idiomas grandes, considere usar la configuración predeterminada en inglés ( `-l en` ).\n\n8. **Establecer el formato del nombre de la herramienta en CamelCase** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -c camel\n ```\n\n > **Nota** : Al configurar el formato del nombre de la herramienta, puede cambiar cómo aparecen los nombres en el MCP. Por ejemplo, `im.v1.message.create` en diferentes formatos:\n >\n > * formato de serpiente (predeterminado): `im_v1_message_create`\n > * formato camello: `imV1MessageCreate`\n > * formato kebab: `im-v1-message-create`\n > * formato de punto: `im.v1.message.create`\n\n9. **Uso de variables de entorno en lugar de parámetros de línea de comandos** :\n\n ```bash\n # Set environment variables\n export APP_ID=cli_xxxx\n export APP_SECRET=yyyyy\n\n # Start the service (no need to specify -a and -s parameters)\n lark-mcp mcp\n ```\n\n10. **Usando el archivo de configuración** :\n\nAdemás de los parámetros de la línea de comandos, también puedes usar un archivo de configuración en formato JSON para establecer parámetros:\n\n```bash\nlark-mcp mcp --config ./config.json\n```\n\nEjemplo de archivo de configuración (config.json):\n\n```json\n{\n \"appId\": \"cli_xxxx\",\n \"appSecret\": \"xxxx\",\n \"domain\": \"https://open.feishu.cn\",\n \"tools\": [\"im.v1.message.create\",\"im.v1.chat.create\"],\n \"toolNameCase\": \"snake\",\n \"language\": \"zh\",\n \"userAccessToken\": \"\",\n \"tokenMode\": \"auto\",\n \"mode\": \"stdio\",\n \"host\": \"localhost\",\n \"port\": \"3000\"\n}\n```\n\n> **Nota** : Los parámetros de la línea de comandos tienen mayor prioridad que el archivo de configuración. Al usar tanto los parámetros de la línea de comandos como el archivo de configuración, estos últimos anularán la configuración correspondiente en el archivo de configuración.\n\n11. **Modos de transporte** :\n\nlark-mcp admite dos modos de transporte:\n\n1. **Modo stdio (predeterminado/recomendado)** : adecuado para la integración con herramientas de IA como Trae/Cursor o Claude, comunicándose a través de flujos de entrada/salida estándar.\n\n```bash\nlark-mcp mcp -a -s -m stdio\n```\n\n2. **Modo SSE** : proporciona una interfaz HTTP basada en eventos enviados por el servidor, adecuada para escenarios donde la ejecución local no es posible.\n\n```bash\n# Default listens only on localhost\nlark-mcp mcp -a -s -m sse -p 3000\n\n# Listen on all network interfaces (allowing remote access)\nlark-mcp mcp -a -s -m sse --host 0.0.0.0 -p 3000\n```\n\nDespués del inicio, el punto final SSE será accesible en `http://:/sse` .\n\n## Preguntas frecuentes\n\n* **Problema** : No se puede conectar a la API de Feishu/Lark. **Solución** : Verifique su conexión de red y asegúrese de que los valores APP\\_ID y APP\\_SECRET sean correctos. Verifique que pueda acceder a la API de plataforma abierta de Feishu/Lark; es posible que necesite configurar un proxy.\n\n* **Problema** : Error al usar user\\_access\\_token. **Solución** : Verifique si el token ha caducado. user\\_access\\_token suele tener una validez de 2 horas y debe actualizarse periódicamente. Puede implementar un mecanismo de actualización automática de tokens.\n\n* **Problema** : No se pueden llamar ciertas API tras iniciar el servicio MCP, con errores de permisos insuficientes. **Solución** : Compruebe si su aplicación ha obtenido los permisos de API correspondientes. Algunas API requieren permisos adicionales de alto nivel, que se pueden configurar en la [Consola del desarrollador](https://open.feishu.cn/app) o en [la Consola del desarrollador de Lark](https://open.larksuite.com/app) . Asegúrese de que los permisos estén aprobados.\n\n* **Problema** : Fallan las llamadas a la API relacionadas con la carga/descarga de imágenes o archivos. **Solución** : La versión actual no admite la función de carga/descarga de archivos e imágenes. Estas API serán compatibles en futuras versiones.\n\n* **Problema** : La línea de comandos muestra caracteres ilegibles en Windows. **Solución** : Cambie la codificación de la línea de comandos a UTF-8 ejecutando `chcp 65001` en el símbolo del sistema. Si usa PowerShell, es posible que deba cambiar la fuente del terminal o la configuración de PowerShell.\n\n* **Problema** : Errores de permisos durante la instalación. **Solución** : En macOS/Linux, use `sudo npm install -g @larksuiteoapi/lark-mcp` para la instalación o modifique los permisos de la ruta de instalación global de npm. Los usuarios de Windows pueden intentar ejecutar el símbolo del sistema como administrador.\n\n* **Problema** : se excedió el límite de tokens después de iniciar el servicio MCP **Solución** : intente usar `-t` para reducir la cantidad de API habilitadas o use un modelo que admita tokens más grandes (como claude3.7).\n\n* **Problema** : No se puede conectar ni recibir mensajes en modo SSE. **Solución** : Compruebe si el puerto ya está en uso e intente cambiar a otro. Asegúrese de que el cliente esté conectado correctamente al endpoint SSE y esté gestionando el flujo de eventos.\n\n## Enlaces relacionados\n\n* [Plataforma abierta Feishu](https://open.feishu.cn/)\n* [Plataforma Abierta Internacional Lark](https://open.larksuite.com/)\n* [Documentación de la API de plataforma abierta de Feishu](https://open.feishu.cn/document/home/index)\n* [Documentación de la API de la plataforma abierta Lark](https://open.larksuite.com/document/home/index)\n* [Sitio web de Node.js](https://nodejs.org/)\n* [Documentación de npm](https://docs.npmjs.com/)\n\n## Comentario\n\nAgradecemos cualquier problema que nos ayude a mejorar esta herramienta. Si tienes alguna pregunta o sugerencia, compártela en el repositorio de GitHub.","Spanish","es-ES",{"_29":54,"_33":58,"_38":59},{"_31":55,"_33":56,"_35":57},"AI アシスタントがドキュメント処理、会話管理、カレンダーのスケジュール設定などの自動化シナリオで Feishu/Lark API インターフェースを直接呼び出すことができるツールキット。","フェイシュウ/ラーク OpenAPI MCP","# フェイシュウ/ラーク OpenAPI MCP\n\n[![npmバージョン](https://img.shields.io/npm/v/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![npmダウンロード](https://img.shields.io/npm/dm/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![Node.js バージョン](https://img.shields.io/node/v/@larksuiteoapi/lark-mcp.svg)](https://nodejs.org/)\n\n英語 |[中文](./README_ZH.md)\n\n[開発者向けドキュメント取得 MCP](./README_RECALL.md) |[公式ドキュメント](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/mcp_introduction)\n\n> **⚠️ ベータ版のお知らせ**：このツールは現在ベータ版です。機能やAPIは変更される可能性がありますので、バージョンリリースの最新情報をご確認ください。\n\nこれは、Feishu/Lark公式OpenAPI MCP（Model Context Protocol）ツールです。ユーザーがFeishu/Larkプラットフォームに迅速に接続し、AIエージェントとFeishu/Lark間の効率的な連携を実現できるように設計されています。このツールは、Feishu/Lark Open Platform APIインターフェースをMCPツールとしてカプセル化しており、AIアシスタントがこれらのインターフェースを直接呼び出して、ドキュメント処理、会話管理、カレンダースケジュール設定などのさまざまな自動化シナリオを実装できます。\n\n## 特徴\n\n* \\*\\*完全な Feishu/Lark API ツールキット:\\*\\*メッセージ管理、グループ管理、ドキュメント操作、カレンダーイベント、Bitable、その他のコア機能領域を含む、ほぼすべての Feishu/Lark API インターフェイスをカプセル化します。\n\n* **二重認証サポート:**\n\n * アプリアクセストークン認証をサポート\n * ユーザーアクセストークン認証をサポート\n\n* **柔軟な通信プロトコル:**\n\n * 標準入出力ストリーム（stdio）モードをサポートし、Trae/Cursor/ClaudeなどのAIツールとの統合に適しています。\n * Server-Sent Events (SSE) モードをサポートし、HTTP ベースのインターフェースを提供します。\n\n* さまざまな使用シナリオに適応する複数の構成方法をサポートします\n\n## ツールリスト\n\nサポートされているすべての Feishu/Lark ツールの完全なリストは[tools.md](./docs/tools-en.md)にあります。ツールはプロジェクトとバージョン別に分類され、説明が付いています。\n\n## 準備\n\n### Feishu/Lark アプリケーションの作成\n\nlark-mcp ツールを使用する前に、Feishu/Lark アプリケーションを作成する必要があります。\n\n1. [Feishu Open Platform](https://open.feishu.cn/)または[Lark Open Platform](https://open.larksuite.com/)にアクセスしてログインしてください\n2. 「コンソール」をクリックして新しいアプリケーションを作成します\n3. API認証に使用するApp IDとApp Secretを取得します。\n4. 使用シナリオに基づいてアプリケーションに必要な権限を追加します\n5. ユーザーとしてAPIを呼び出す必要がある場合は、OAuth 2.0リダイレクトURLを設定し、ユーザーアクセストークンを取得します。\n\nアプリケーションの作成と構成に関する詳細なガイドラインについては、 [Feishu Open Platform ドキュメントの「アプリケーションの作成」](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0)または[Lark Open Platform ドキュメント](https://open.larksuite.com/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0)を参照してください。\n\n### Node.jsのインストール\n\nlark-mcp ツールを使用する前に、Node.js 環境をインストールする必要があります。\n\n#### macOSにNode.jsをインストールする\n\n1. **Homebrew の使用 (推奨)** :\n\n ```bash\n brew install node\n ```\n\n2. **公式インストーラーの使用**:\n\n * [Node.jsのウェブサイト](https://nodejs.org/)をご覧ください\n\n * LTSバージョンをダウンロードしてインストールする\n\n * インストール後、ターミナルで確認します。\n\n ```bash\n node -v\n npm -v\n ```\n\n#### WindowsにNode.jsをインストールする\n\n1. **公式インストーラーの使用**:\n\n * [Node.jsのウェブサイト](https://nodejs.org/)をご覧ください\n\n * Windowsインストーラー（.msiファイル）をダウンロードして実行します\n\n * インストールウィザードに従ってインストールを完了します\n\n * インストール後、コマンドプロンプトで確認します。\n\n ```bash\n node -v\n npm -v\n ```\n\n2. **nvm-windows の使用**:\n\n * [nvm-windows](https://github.com/coreybutler/nvm-windows/releases)をダウンロード\n\n * nvm-windowsをインストールする\n\n * nvm を使用して Node.js をインストールします。\n\n ```bash\n nvm install latest\n nvm use \n ```\n\n## インストール\n\nlark-mcp ツールをグローバルにインストールします。\n\n```bash\nnpm install -g @larksuiteoapi/lark-mcp\n```\n\n## 使用ガイド\n\n### Trae/Cursor/Claude と併用\n\nFeishu/Lark 機能を Trae、Cursor、Claude などの AI ツールに統合するには、構成ファイルに以下を追加します。\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\"\n ]\n }\n }\n}\n```\n\nユーザー ID を使用して API にアクセスするには、ユーザーアクセストークンを追加します。\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\",\n \"-u\",\n \"\"\n ]\n }\n }\n}\n```\n\n### カスタムAPI構成\n\nMCPサービスはデフォルトで共通APIを有効にします。他のツールや特定のAPI、プリセットのみを有効にするには、 `-t`パラメータ（カンマ区切り）を使用して指定します。\n\n```bash\nlark-mcp mcp -a -s -t im.v1.message.create,im.v1.message.list,im.v1.chat.create,preset.calendar.default\n```\n\n#### プリセットツールコレクションの詳細\n\n次の表は、各 API ツールと、それがさまざまなプリセットコレクションに含まれているかどうかの詳細を示しており、ニーズに適したプリセットを選択するのに役立ちます。\n\n| ツール名 | 機能説明 | preset.default (デフォルト) | プリセット.im.デフォルト | preset.base.default | preset.base.batch | プリセット.doc.デフォルト | プリセットタスクのデフォルト | プリセットカレンダーのデフォルト |\n| ------------------------------------- | ---------------------- | :--------------------: | :------------: | :-----------------: | :---------------: | :-------------: | :------------: | :--------------: |\n| im.v1.チャット.作成 | グループチャットを作成する | ✓ | ✓ | | | | | |\n| im.v1.チャットリスト | グループチャットリストを取得する | ✓ | ✓ | | | | | |\n| im.v1.chatMembers.get | グループメンバーを取得する | ✓ | ✓ | | | | | |\n| im.v1.メッセージ作成 | メッセージを送信する | ✓ | ✓ | | | | | |\n| im.v1.メッセージリスト | メッセージリストを取得 | ✓ | ✓ | | | | | |\n| bitable.v1.app.create | ベースを作成 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.create | 基本データテーブルを作成する | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.list | 基本データテーブルリストを取得する | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableField.list | 基本データテーブルフィールドリストを取得する | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.search | 検索ベースデータテーブルレコード | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.create | 基本データテーブルレコードを作成する | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchCreate | 基本データテーブルレコードのバッチ作成 | | | | ✓ | | | |\n| bitable.v1.appTableRecord.更新 | 基本データテーブルレコードを更新する | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchUpdate | 基本データテーブルレコードの一括更新 | | | | ✓ | | | |\n| docx.v1.document.rawContent | ドキュメントコンテンツを取得する | ✓ | | | | ✓ | | |\n| docx.組み込みインポート | ドキュメントのインポート | ✓ | | | | ✓ | | |\n| docx.組み込み検索 | ドキュメントを検索 | ✓ | | | | ✓ | | |\n| ドライブ.v1.権限メンバー.作成 | 共同編集者の権限を追加する | ✓ | | | | ✓ | | |\n| wiki.v2.space.getNode | Wikiノードを取得 | ✓ | | | | ✓ | | |\n| wiki.v1.node.search | Wikiノードを検索 | ✓ | | | | ✓ | | |\n| contact.v3.user.batchGetId | ユーザーIDを一括取得 | ✓ | | | | | | |\n| タスク.v2.タスク作成 | タスクを作成 | | | | | | ✓ | |\n| タスク.v2.タスク.パッチ | タスクの変更 | | | | | | ✓ | |\n| タスク.v2.タスク.メンバーの追加 | タスクメンバーを追加する | | | | | | ✓ | |\n| task.v2.task.addReminders | タスクのリマインダーを追加する | | | | | | ✓ | |\n| カレンダー.v4.カレンダーイベント.作成 | カレンダーイベントを作成 | | | | | | | ✓ |\n| カレンダー.v4.calendarEvent.パッチ | カレンダーイベントの変更 | | | | | | | ✓ |\n| カレンダー.v4.カレンダーイベント.get | カレンダーイベントを取得 | | | | | | | ✓ |\n| カレンダー.v4.空き時間リスト | 空き時間情報を照会する | | | | | | | ✓ |\n| カレンダー.v4.カレンダー.プライマリ | メインカレンダーを取得する | | | | | | | ✓ |\n\n> **注**: 表中の「✓」は、そのツールがそのプリセットに含まれていることを示します。 `-t preset.xxx`を使用すると、対応する列に「✓」マークが付いているツールのみが有効になります。\n\n### 詳細設定\n\n#### コマンドラインパラメータ\n\n`lark-mcp mcp`ツールは、柔軟な MCP サービス構成のためのさまざまなコマンドラインパラメータを提供します。\n\n| パラメータ | 短い | 説明 | 例 |\n| --------------------- | ---- | ----------------------------------------------------------------------------------- | ------------------------------------------- |\n| `--app-id` | `-a` | Feishu/LarkアプリケーションのアプリID | `-a cli_xxxx` |\n| `--app-secret` | `-s` | Feishu/Lark アプリケーション App Secret | `-s xxxx` |\n| `--domain` | `-d` | Feishu/Lark API ドメイン、デフォルトはです | `-d https://open.larksuite.com` |\n| `--tools` | `-t` | 有効にする API ツールのリスト（カンマ区切り） | `-t im.v1.message.create,im.v1.chat.create` |\n| `--tool-name-case` | `-c` | ツール名の形式。オプションは、snake、camel、dot、kebab で、デフォルトは snake です。 | `-c camel` |\n| `--language` | `-l` | ツールの言語、オプションは zh または en、デフォルトは en | `-l zh` |\n| `--user-access-token` | `-u` | ユーザーとして API を呼び出すためのユーザーアクセストークン | `-u u-xxxx` |\n| `--token-mode` | | API トークンの種類。オプションは auto、tenant\\_access\\_token、user\\_access\\_token で、デフォルトは auto です。 | `--token-mode user_access_token` |\n| `--mode` | `-m` | トランスポートモード、オプションはstdioまたはsse、デフォルトはstdio | `-m sse` |\n| `--host` | | SSEモードのリスニングホスト、デフォルトはlocalhost | `--host 0.0.0.0` |\n| `--port` | `-p` | SSEモードのリスニングポート、デフォルトは3000 | `-p 3000` |\n| `--config` | | 設定ファイルのパス、JSON 形式をサポート | `--config ./config.json` |\n| `--version` | `-V` | バージョン番号を表示する | `-V` |\n| `--help` | `-h` | ヘルプ情報を表示する | `-h` |\n\n#### パラメータの使用例\n\n1. **基本的な使用方法**(アプリケーション ID を使用):\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy\n ```\n\n2. **ユーザーIDの使用**:\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -u u-zzzz\n ```\n\n > **注**：ユーザーアクセストークンは[、Feishu Open Platformの認証プロセス](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/authentication-management/access-token/get-user-access-token)または[Lark Open Platformの認証プロセス](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create)を通じて取得できます。また、APIデバッグコンソールを使用して取得することもできます。ユーザーアクセストークンを使用すると、API呼び出しはそのユーザーのIDを使用して実行されます。\n\n3. **特定のトークンモードの設定**:\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy --token-mode user_access_token\n ```\n\n > **注**: このオプションを使用すると、API呼び出し時に使用するトークンタイプを明示的に指定できます。 `auto`モード（デフォルト）は、API呼び出し時にLLMによって決定されます。\n\n4. **LarkまたはKAドメインの指定**:\n\n ```bash\n # Lark international version\n lark-mcp mcp -a -s -d https://open.larksuite.com\n\n # Custom domain (KA domain)\n lark-mcp mcp -a -s -d https://open.your-ka-domain.com\n ```\n\n5. **特定の API ツールのみを有効にするか、他の API ツールを有効にするか**:\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -t im.v1.chat.create,im.v1.message.create\n ```\n\n > **注**: `-t`パラメータは、次のプリセットツールコレクションをサポートします。\n >\n > * `preset.default` - すべてのプリセットツールを含むデフォルトのツールセット\n > * `preset.im.default` - グループ管理、メッセージ送信などのインスタントメッセージング関連のツール。\n > * `preset.bitable.default` - テーブル作成、レコード管理などの Bitable 関連ツール。\n > * `preset.bitable.batch` - バッチ作成およびレコード更新機能を含む Bitable バッチ操作ツール\n > * `preset.doc.default` - ドキュメントコンテンツの読み取り、権限管理などのドキュメント関連ツール。\n > * `preset.task.default` - タスクの作成、メンバーの管理などのタスク管理関連のツール。\n > * `preset.calendar.default` - カレンダーイベントの作成、空き時間情報の照会などのカレンダーイベント管理ツール。\n\n6. **特定のポートとホストでSSEモードを使用する**:\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -m sse --host 0.0.0.0 -p 3000\n ```\n\n7. **ツールの言語を中国語に設定する**:\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -l zh\n ```\n\n > **注**：言語を中国語（ `-l zh` ）に設定すると、トークンの消費量が増える可能性があります。大規模な言語モデルとの統合時にトークン制限の問題が発生する場合は、デフォルトの英語設定（ `-l en` ）の使用を検討してください。\n\n8. **ツール名の形式をキャメルケースに設定する**:\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -c camel\n ```\n\n > **注**: ツール名の形式を設定することで、MCP におけるツール名の表示形式を変更できます。例えば、 `im.v1.message.create`は以下のように表示されます。\n >\n > * スネークフォーマット（デフォルト）： `im_v1_message_create`\n > * キャメル形式: `imV1MessageCreate`\n > * ケバブ形式: `im-v1-message-create`\n > * ドット形式: `im.v1.message.create`\n\n9. **コマンドラインパラメータの代わりに環境変数を使用する**:\n\n ```bash\n # Set environment variables\n export APP_ID=cli_xxxx\n export APP_SECRET=yyyyy\n\n # Start the service (no need to specify -a and -s parameters)\n lark-mcp mcp\n ```\n\n10. **設定ファイルの使用**:\n\nコマンドラインパラメータに加えて、JSON 形式の構成ファイルを使用してパラメータを設定することもできます。\n\n```bash\nlark-mcp mcp --config ./config.json\n```\n\n設定ファイルの例 (config.json):\n\n```json\n{\n \"appId\": \"cli_xxxx\",\n \"appSecret\": \"xxxx\",\n \"domain\": \"https://open.feishu.cn\",\n \"tools\": [\"im.v1.message.create\",\"im.v1.chat.create\"],\n \"toolNameCase\": \"snake\",\n \"language\": \"zh\",\n \"userAccessToken\": \"\",\n \"tokenMode\": \"auto\",\n \"mode\": \"stdio\",\n \"host\": \"localhost\",\n \"port\": \"3000\"\n}\n```\n\n> **注**：コマンドラインパラメータは設定ファイルよりも優先されます。コマンドラインパラメータと設定ファイルの両方を使用する場合、コマンドラインパラメータが設定ファイルの対応する設定を上書きします。\n\n11. **輸送モード**:\n\nlark-mcp は 2 つのトランスポートモードをサポ��トしています。\n\n1. **stdio モード (デフォルト/推奨)** : 標準入出力ストリームを介して通信する、Trae/Cursor や Claude などの AI ツールとの統合に適しています。\n\n```bash\nlark-mcp mcp -a -s -m stdio\n```\n\n2. **SSE モード**: ローカル実行が不可能なシナリオに適した、Server-Sent Events に基づく HTTP インターフェイスを提供します。\n\n```bash\n# Default listens only on localhost\nlark-mcp mcp -a -s -m sse -p 3000\n\n# Listen on all network interfaces (allowing remote access)\nlark-mcp mcp -a -s -m sse --host 0.0.0.0 -p 3000\n```\n\n起動後、SSE エンドポイントは`http://:/sse`でアクセスできるようになります。\n\n## よくある質問\n\n* **問題**：Feishu/Lark APIに接続できません**解決策**：ネットワーク接続を確認し、APP\\_IDとAPP\\_SECRETが正しいことを確認してください。Feishu/Lark Open Platform APIにアクセスできることを確認してください。プロキシの設定が必要になる場合があります。\n\n* **問題**: user\\_access\\_token の使用時にエラーが発生します。**解決策**: トークンの有効期限が切れていないか確認してください。user\\_access\\_token の有効期間は通常 2 時間で、定期的に更新する必要があります。自動トークン更新メカニズムを実装することもできます。\n\n* **問題**：MCPサービス開始後、権限不足エラーが発生し、特定のAPIを呼び出せません。**解決策**：アプリケーションが適切なAPI権限を取得しているかどうかを確認してください。一部のAPIでは[、開発者コンソール](https://open.feishu.cn/app)または[Lark開発者コンソール](https://open.larksuite.com/app)で設定できる追加の高レベルの権限が必要です。権限が承認されていることを確認してください。\n\n* **問題**: 画像またはファイルのアップロード/ダウンロード関連のAPI呼び出しが失敗する**解決策**: 現在のバージョンでは、ファイルおよび画像のアップロード/ダウンロード機能はサポートされていません。これらのAPIは将来のバージョンでサポートされる予定です。\n\n* **問題**：Windows環境でコマンドラインが文字化けする**解決策**：コマンドプロンプトで`chcp 65001`を実行し、コマンドラインのエンコーディングをUTF-8に変更してください。PowerShellを使用している場合は、ターミナルのフォントまたはPowerShellの設定を変更する必要がある可能性があります。\n\n* **問題**：インストール中の権限エラー**解決策**：macOS/Linux では、 `sudo npm install -g @larksuiteoapi/lark-mcp`を使用してインストールするか、npm のグローバルインストールパスの権限を変更してください。Windows では、コマンドプロンプトを管理者として実行してみてください。\n\n* **問題**: MCP サービスの開始後にトークン制限を超えました。**解決策**: `-t`を使用して有効な API の数を減らすか、より大きなトークンをサポートするモデル (claude3.7 など) を使用してください。\n\n* **問題**: SSEモードで接続またはメッセージを受信できません。**解決策**: ポートが既に使用されていないか確認し、別のポートに変更してみてください。クライアントがSSEエンドポイントに正しく接続され、イベントストリームを処理していることを確認してください。\n\n## 関連リンク\n\n* [フェイシュオープンプラットフォーム](https://open.feishu.cn/)\n* [ラーク国際オープンプラットフォーム](https://open.larksuite.com/)\n* [Feishu オープンプラットフォーム API ドキュメント](https://open.feishu.cn/document/home/index)\n* [Lark オープンプラットフォーム API ドキュメント](https://open.larksuite.com/document/home/index)\n* [Node.js ウェブサイト](https://nodejs.org/)\n* [npmドキュメント](https://docs.npmjs.com/)\n\n## フィードバック\n\nこのツールの改善に役立つ問題を歓迎します。ご質問やご提案がございましたら、GitHubリポジトリにご投稿ください。","Japanese","ja-JP",{"_29":61,"_33":65,"_38":66},{"_31":62,"_33":63,"_35":64},"AI 어시스턴트가 문서 처리, 대화 관리, 일정 예약과 같은 자동화 시나리오를 위해 Feishu/Lark API 인터페이스를 직접 호출할 수 있도록 하는 툴킷입니다.","페이슈/라크 OpenAPI MCP","# 페이슈/라크 OpenAPI MCP\n\n[![npm 버전](https://img.shields.io/npm/v/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![npm 다운로드](https://img.shields.io/npm/dm/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![Node.js 버전](https://img.shields.io/node/v/@larksuiteoapi/lark-mcp.svg)](https://nodejs.org/)\n\n영어 | [중문](./README_ZH.md)\n\n[개발자 문서 검색 MCP](./README_RECALL.md) | [공식 문서](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/mcp_introduction)\n\n> **⚠️ 베타 버전 안내** : 이 도구는 현재 베타 단계입니다. 기능 및 API가 변경될 수 있으니, 버전 출시에 대한 최신 정보를 확인해 주세요.\n\n이는 사용자가 Feishu/Lark 플랫폼에 빠르게 연결하고 AI 에이전트와 Feishu/Lark 간의 효율적인 협업을 지원할 수 있도록 설계된 Feishu/Lark 공식 OpenAPI MCP(Model Context Protocol) 도구입니다. 이 도구는 Feishu/Lark Open Platform API 인터페이스를 MCP 도구로 캡슐화하여 AI 비서가 이러한 인터페이스를 직접 호출하고 문서 처리, 대화 관리, 일정 예약 등 다양한 자동화 시나리오를 구현할 수 있도록 지원합니다.\n\n## 특징\n\n* **완전한 Feishu/Lark API 툴킷:** 메시지 관리, 그룹 관리, 문서 작업, 캘린더 이벤트, Bitable 및 기타 핵심 기능 영역을 포함한 거의 모든 Feishu/Lark API 인터페이스를 캡슐화합니다.\n\n* **이중 인증 지원:**\n\n * 앱 액세스 토큰 인증을 지원합니다\n * 사용자 액세스 토큰 인증을 지원합니다\n\n* **유연한 통신 프로토콜:**\n\n * Trae/Cursor/Claude와 같은 AI 도구와의 통합에 적합한 표준 입출력 스트림(stdio) 모드를 지원합니다.\n * HTTP 기반 인터페이스를 제공하는 SSE(Server-Sent Events) 모드를 지원합니다.\n\n* 다양한 사용 시나리오에 맞춰 여러 구성 방법을 지원합니다.\n\n## 도구 목록\n\n지원되는 모든 Feishu/Lark 도구의 전체 목록은 [tools.md](./docs/tools-en.md) 에서 확인할 수 있으며, 여기서 도구는 설명과 함께 프로젝트 및 버전별로 분류됩니다.\n\n## 준비\n\n### Feishu/Lark 애플리케이션 만들기\n\nlark-mcp 도구를 사용하기 전에 Feishu/Lark 애플리케이션을 만들어야 합니다.\n\n1. [Feishu Open Platform](https://open.feishu.cn/) 또는 [Lark Open Platform을](https://open.larksuite.com/) 방문하여 로그인하세요.\n2. \"콘솔\"을 클릭하고 새 애플리케이션을 만듭니다.\n3. API 인증에 사용될 앱 ID와 앱 비밀번호를 얻으세요.\n4. 사용 시나리오에 따라 애플리케이션에 필요한 권한을 추가하세요.\n5. 사용자로서 API를 호출해야 하는 경우 OAuth 2.0 리디렉션 URL을 설정하고 사용자 액세스 토큰을 얻으세요.\n\n자세한 애플리케이션 생성 및 구성 지침은 [Feishu 오픈 플랫폼 문서 - 애플리케이션 생성](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0) 또는 [Lark 오픈 플랫폼 문서를](https://open.larksuite.com/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0) 참조하세요.\n\n### Node.js 설치\n\nlark-mcp 도구를 사용하기 전에 Node.js 환경을 설치해야 합니다.\n\n#### macOS에 Node.js 설치\n\n1. **Homebrew 사용(권장)** :\n\n 지엑스피1\n\n2. **공식 설치 프로그램 사용** :\n\n * [Node.js 웹사이트를](https://nodejs.org/) 방문하세요\n\n * LTS 버전을 다운로드하고 설치하세요\n\n * 설치 후 터미널에서 확인하세요.\n\n ```bash\n node -v\n npm -v\n ```\n\n#### Windows에 Node.js 설치\n\n1. **공식 설치 프로그램 사용** :\n\n * [Node.js 웹사이트를](https://nodejs.org/) 방문하세요\n\n * Windows 설치 프로그램(.msi 파일)을 다운로드하여 실행하세요.\n\n * 설치 마법사를 따라 설치를 완료하세요.\n\n * 설치 후 명령 프롬프트에서 확인하세요.\n\n ```bash\n node -v\n npm -v\n ```\n\n2. **nvm-windows 사용하기** :\n\n * [nvm-windows](https://github.com/coreybutler/nvm-windows/releases) 다운로드\n\n * nvm-windows 설치\n\n * nvm을 사용하여 Node.js를 설치하세요.\n\n ```bash\n nvm install latest\n nvm use \n ```\n\n## 설치\n\nlark-mcp 도구를 전역적으로 설치합니다.\n\n```bash\nnpm install -g @larksuiteoapi/lark-mcp\n```\n\n## 사용 가이드\n\n### Trae/Cursor/Claude와 함께 사용\n\nTrae, Cursor 또는 Claude와 같은 AI 도구에 Feishu/Lark 기능을 통합하려면 구성 파일에 다음을 추가하세요.\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\"\n ]\n }\n }\n}\n```\n\n사용자 ID로 API에 액세스하려면 사용자 액세스 토큰을 추가할 수 있습니다.\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\",\n \"-u\",\n \"\"\n ]\n }\n }\n}\n```\n\n### 사용자 정의 API 구성\n\n기본적으로 MCP 서비스는 공통 API를 활성화합니다. 다른 도구나 특정 API 또는 프리셋만 활성화하려면 `-t` 매개변수(쉼표로 구분)를 사용하여 지정할 수 있습니다.\n\n```bash\nlark-mcp mcp -a -s -t im.v1.message.create,im.v1.message.list,im.v1.chat.create,preset.calendar.default\n```\n\n#### 사전 설정 도구 컬렉션에 대한 자세한 정보\n\n다음 표에서는 각 API 도구와 다양한 사전 설정 컬렉션에 포함된 내용을 자세히 설명하여 필요에 맞는 적절한 사전 설정을 선택하는 데 도움을 줍니다.\n\n| 도구 이름 | 기능 설명 | 사전 설정.기본값(기본값) | 프리셋.im.default | 프리셋.베이스.디폴트 | 프리셋.베이스.배치 | 사전 설정.doc.기본값 | 사전 설정.작업.기본값 | 사전 설정.캘린더.기본값 |\n| ------------------------------------- | ---------------------- | :------------: | :------------: | :---------: | :--------: | :-----------: | :----------: | :-----------: |\n| im.v1.chat.create | 그룹 채팅 만들기 | ✓ | ✓ | | | | | |\n| im.v1.chat.list | 그룹 채팅 목록 가져오기 | ✓ | ✓ | | | | | |\n| im.v1.chatMembers.get | 그룹 멤버를 얻으세요 | ✓ | ✓ | | | | | |\n| im.v1.message.create | 메시지 보내기 | ✓ | ✓ | | | | | |\n| im.v1.메시지.목록 | 메시지 목록 가져오기 | ✓ | ✓ | | | | | |\n| bitable.v1.app.create | 베이스 생성 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.create | 기본 데이터 테이블 생성 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.list | 기본 데이터 테이블 목록 가져오기 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableField.list | 기본 데이터 테이블 필드 목록 가져오기 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.search | 검색 기반 데이터 테이블 레코드 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.create | 기본 데이터 테이블 레코드 생성 | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchCreate | 기본 데이터 테이블 레코드 일괄 생성 | | | | ✓ | | | |\n| bitable.v1.appTableRecord.update | 기본 데이터 테이블 레코드 업데이트 | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchUpdate | 일괄 업데이트 기본 데이터 테이블 레코드 | | | | ✓ | | | |\n| docx.v1.document.rawContent | 문서 내용 가져오기 | ✓ | | | | ✓ | | |\n| docx.builtin.import | 문서 가져오기 | ✓ | | | | ✓ | | |\n| docx.builtin.search | 문서 검색 | ✓ | | | | ✓ | | |\n| drive.v1.permissionMember.create | 공동작업자 권한 추가 | ✓ | | | | ✓ | | |\n| wiki.v2.space.getNode | 위키 노드 가져오기 | ✓ | | | | ✓ | | |\n| 위키.v1.노드.검색 | 위키 노드 검색 | ✓ | | | | ✓ | | |\n| 연락처.v3.user.batchGetId | 일괄 사용자 ID 가져오기 | ✓ | | | | | | |\n| task.v2.task.create | 작업 생성 | | | | | | ✓ | |\n| task.v2.task.patch | 작업 수정 | | | | | | ✓ | |\n| task.v2.task.addMembers | 작업 멤버 추가 | | | | | | ✓ | |\n| task.v2.task.addReminders | 작업 알림 추가 | | | | | | ✓ | |\n| calendar.v4.calendarEvent.create | 캘린더 이벤트 만들기 | | | | | | | ✓ |\n| calendar.v4.calendarEvent.patch | 캘린더 이벤트 수정 | | | | | | | ✓ |\n| calendar.v4.calendarEvent.get | 캘린더 이벤트 가져오기 | | | | | | | ✓ |\n| 캘린더.v4.잔여시간.목록 | 사용 가능/사용 중 상태 쿼리 | | | | | | | ✓ |\n| calendar.v4.calendar.primary | 기본 캘린더 가져오기 | | | | | | | ✓ |\n\n> **참고** : 표에서 \"✓\" 표시는 해당 도구가 해당 사전 설정에 포함되어 있음을 나타냅니다. `-t preset.xxx` 명령을 사용하면 해당 열에 \"✓\" 표시가 있는 도구만 활성화됩니다.\n\n### 고급 구성\n\n#### 명령줄 매개변수\n\n`lark-mcp mcp` 도구는 유연한 MCP 서비스 구성을 위한 다양한 명령줄 매개변수를 제공합니다.\n\n| 매개변수 | 짧은 | 설명 | 예 |\n| --------------------- | ---- | --------------------------------------------------------------------------------- | ------------------------------------------- |\n| `--app-id` | `-a` | Feishu/Lark 애플리케이션 앱 ID | `-a cli_xxxx` |\n| `--app-secret` | `-s` | 페이슈/라크 앱 앱 시크릿 | `-s xxxx` |\n| `--domain` | `-d` | Feishu/Lark API 도메인, 기본값은 입니다. | `-d https://open.larksuite.com` |\n| `--tools` | `-t` | 쉼표로 구분된 활성화할 API 도구 목록 | `-t im.v1.message.create,im.v1.chat.create` |\n| `--tool-name-case` | `-c` | 도구 이름 형식, 옵션은 뱀, 낙타, 점 또는 케밥이며 기본값은 뱀입니다. | `-c camel` |\n| `--language` | `-l` | 도구 언어, 옵션은 zh 또는 en이며 기본값은 en입니다. | `-l zh` |\n| `--user-access-token` | `-u` | 사용자로서 API를 호출하기 위한 사용자 액세스 토큰 | `-u u-xxxx` |\n| `--token-mode` | | API 토큰 유형, 옵션은 auto, tenant\\_access\\_token 또는 user\\_access\\_token이며 기본값은 auto입니다. | `--token-mode user_access_token` |\n| `--mode` | `-m` | 전송 모드, 옵션은 stdio 또는 sse이며 기본값은 stdio입니다. | `-m sse` |\n| `--host` | | SSE 모드에서 수신 호스트, 기본값은 localhost입니다. | `--host 0.0.0.0` |\n| `--port` | `-p` | SSE 모드에서 수신 포트, 기본값은 3000입니다. | `-p 3000` |\n| `--config` | | 구성 파일 경로, JSON 형식 지원 | `--config ./config.json` |\n| `--version` | `-V` | 버전 번호 표시 | `-V` |\n| `--help` | `-h` | 도움말 정보 표시 | `-h` |\n\n#### 매개변수 사용 예\n\n1. **기본 사용법** (애플리케이션 ID 사용):\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy\n ```\n\n2. **사용자 ID 사용** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -u u-zzzz\n ```\n\n > **참고** : 사용자 액세스 토큰은 [Feishu Open Platform의 인증 절차](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/authentication-management/access-token/get-user-access-token) 또는 [Lark Open Platform의 인증 절차를](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create) 통해 획득하거나, API 디버깅 콘솔을 사용하여 획득할 수 있습니다. 사용자 액세스 토큰을 사용하면 해당 사용자의 ID로 API 호출이 수행됩니다.\n\n3. **특정 토큰 모드 설정** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy --token-mode user_access_token\n ```\n\n > **참고** : 이 옵션을 사용하면 API를 호출할 때 사용할 토큰 유형을 명시적으로 지정할 수 있습니다. `auto` 모드(기본값)는 API를 호출할 때 LLM에 의해 결정됩니다.\n\n4. **Lark 또는 KA 도메인 지정** :\n\n ```bash\n # Lark international version\n lark-mcp mcp -a -s -d https://open.larksuite.com\n\n # Custom domain (KA domain)\n lark-mcp mcp -a -s -d https://open.your-ka-domain.com\n ```\n\n5. **특정 API 도구 또는 다른 API 도구만 활성화** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -t im.v1.chat.create,im.v1.message.create\n ```\n\n > **참고** : `-t` 매개변수는 다음과 같은 사전 설정 도구 컬렉션을 지원합니다.\n >\n > * `preset.default` - 모든 사전 설정 도구가 포함된 기본 도구 세트\n > * `preset.im.default` - 그룹 관리, 메시지 전송 등 인스턴트 메시징 관련 도구\n > * `preset.bitable.default` - 테이블 생성, 레코드 관리 등 Bitable 관련 도구\n > * `preset.bitable.batch` - 일괄 생성 및 레코드 업데이트 기능을 포함한 Bitable 일괄 작업 도구\n > * `preset.doc.default` - 문서 내용 읽기, 권한 관리 등 문서 관련 도구\n > * `preset.task.default` - 작업 생성, 멤버 관리 등 작업 관리 관련 도구\n > * `preset.calendar.default` - 캘린더 이벤트 생성, 여유/바쁨 상태 조회 등의 캘린더 이벤트 관리 도구입니다.\n\n6. **특정 포트 및 호스트를 사용하여 SSE 모드 사용** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -m sse --host 0.0.0.0 -p 3000\n ```\n\n7. **설정 도구 언어를 중국어로** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -l zh\n ```\n\n > **참고** : 언어를 중국어( `-l zh` )로 설정하면 토큰 사용량이 늘어날 수 있습니다. 대규모 언어 모델과 통합할 때 토큰 제한 문제가 발생하면 기본 영어 설정( `-l en` )을 사용하는 것이 좋습니다.\n\n8. **도구 이름 형식을 Camel Case로 설정** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -c camel\n ```\n\n > **참고** : 도구 이름 형식을 설정하면 MCP에 도구 이름이 표시되는 방식을 변경할 수 있습니다. 예를 들어, `im.v1.message.create` 다른 형식으로 변경할 수 있습니다.\n >\n > * 뱀 형식(기본값): `im_v1_message_create`\n > * camel 형식: `imV1MessageCreate`\n > * 케밥 형식: `im-v1-message-create`\n > * dot 형식: `im.v1.message.create`\n\n9. **명령줄 매개변수 대신 환경 변수 사용** :\n\n ```bash\n # Set environment variables\n export APP_ID=cli_xxxx\n export APP_SECRET=yyyyy\n\n # Start the service (no need to specify -a and -s parameters)\n lark-mcp mcp\n ```\n\n10. **구성 파일 사용** :\n\n명령줄 매개변수 외에도 JSON 형식 구성 파일을 사용하여 매개변수를 설정할 수 있습니다.\n\n```bash\nlark-mcp mcp --config ./config.json\n```\n\n구성 파일 예(config.json):\n\n```json\n{\n \"appId\": \"cli_xxxx\",\n \"appSecret\": \"xxxx\",\n \"domain\": \"https://open.feishu.cn\",\n \"tools\": [\"im.v1.message.create\",\"im.v1.chat.create\"],\n \"toolNameCase\": \"snake\",\n \"language\": \"zh\",\n \"userAccessToken\": \"\",\n \"tokenMode\": \"auto\",\n \"mode\": \"stdio\",\n \"host\": \"localhost\",\n \"port\": \"3000\"\n}\n```\n\n> **참고** : 명령줄 매개변수는 구성 파일보다 우선합니다. 명령줄 매개변수와 구성 파일을 모두 사용하는 경우, 명령줄 매개변수가 구성 파일의 해당 설정보다 우선합니다.\n\n11. **운송 모드** :\n\nlark-mcp는 두 가지 전송 모드를 지원합니다.\n\n1. **stdio 모드(기본값/권장)** : Trae/Cursor나 Claude와 같은 AI 도구와의 통합에 적합하며 표준 입출력 스트림을 통해 통신합니다.\n\n```bash\nlark-mcp mcp -a -s -m stdio\n```\n\n2. **SSE 모드** : 로컬 실행이 불가능한 시나리오에 적합한, 서버에서 보낸 이벤트 기반의 HTTP 인터페이스를 제공합니다.\n\n```bash\n# Default listens only on localhost\nlark-mcp mcp -a -s -m sse -p 3000\n\n# Listen on all network interfaces (allowing remote access)\nlark-mcp mcp -a -s -m sse --host 0.0.0.0 -p 3000\n```\n\n시작 후 SSE 엔드포인트는 `http://:/sse` 에서 액세스할 수 있습니다.\n\n## 자주 묻는 질문\n\n* **문제** : Feishu/Lark API에 연결할 수 없습니다. **해결 방법** : 네트워크 연결을 확인하고 APP\\_ID와 APP\\_SECRET이 올바른지 확인하세요. Feishu/Lark 오픈 플랫폼 API에 액세스할 수 있는지 확인하세요. 프록시를 구성해야 할 수도 있습니다.\n\n* **문제** : user\\_access\\_token 사용 시 오류 발생. **해결 방법** : 토큰이 만료되었는지 확인하세요. user\\_access\\_token은 일반적으로 2시간 동안 유효하며 주기적으로 갱신해야 합니다. 자동 토큰 갱신 메커니즘을 구현할 수 있습니다.\n\n* **문제** : MCP 서비스 시작 후 특정 API를 호출할 수 없으며 권한 부족 오류가 발생합니다. **해결 방법** : 애플리케이션이 해당 API 권한을 획득했는지 확인하세요. 일부 API에는 [개발자 콘솔](https://open.feishu.cn/app) 또는 [Lark 개발자 콘솔](https://open.larksuite.com/app) 에서 구성할 수 있는 추가 상위 권한이 필요합니다. 권한이 승인되었는지 확인하세요.\n\n* **문제** : 이미지 또는 파일 업로드/다운로드 관련 API 호출 실패 **해결 방법** : 현재 버전은 파일 및 이미지 업로드/다운로드 기능을 지원하지 않습니다. 이러한 API는 향후 버전에서 지원될 예정입니다.\n\n* **문제** : Windows 환경에서 명령줄에 깨진 문자가 표시됩니다. **해결 방법** : 명령 프롬프트에서 `chcp 65001` 실행하여 명령줄 인코딩을 UTF-8로 변경하세요. PowerShell을 사용하는 경우 터미널 글꼴이나 PowerShell 구성을 변경해야 할 수 있습니다.\n\n* **문제** : 설치 중 권한 오류 **해결 방법** : macOS/Linux에서는 `sudo npm install -g @larksuiteoapi/lark-mcp` 사용하여 설치하거나 npm 전역 설치 경로의 권한을 수정하세요. Windows 사용자는 명령 프롬프트를 관리자 권한으로 실행해 보세요.\n\n* **문제** : MCP 서비스를 시작한 후 토큰 제한이 초과되었습니다. **해결 방법** : `-t` 사용하여 활성화된 API 수를 줄이거나 더 큰 토큰을 지원하는 모델(예: claude3.7)을 사용해 보세요.\n\n* **문제** : SSE 모드에서 메시지를 연결하거나 수신할 수 없습니다. **해결 방법** : 포트가 이미 사용 중인지 확인하고 다른 포트로 변경해 보세요. 클라이언트가 SSE 엔드포인트에 올바르게 연결되어 있고 이벤트 스트림을 처리하고 있는지 확인하세요.\n\n## 관련 링크\n\n* [Feishu 오픈 플랫폼](https://open.feishu.cn/)\n* [Lark International 오픈 플랫폼](https://open.larksuite.com/)\n* [Feishu 개방형 플랫폼 API 문서](https://open.feishu.cn/document/home/index)\n* [Lark 오픈 플랫폼 API 문서](https://open.larksuite.com/document/home/index)\n* [Node.js 웹사이트](https://nodejs.org/)\n* [npm 문서](https://docs.npmjs.com/)\n\n## 피드백\n\n이 도구를 개선하는 데 도움이 되는 문제점을 알려주시면 감사하겠습니다. 질문이나 제안 사항이 있으시면 GitHub 저장소에 올려주세요.","Korean","ko-KR",{"_29":68,"_33":71,"_38":72},{"_31":69,"_33":34,"_35":70},"Набор инструментов, позволяющий помощникам на основе искусственного интеллекта напрямую вызывать интерфейсы API Feishu/Lark для автоматизации таких задач, как обработка документов, управление разговорами и составление календарного расписания.","# Feishu/Lark OpenAPI MCP\n\n[![npm-версия](https://img.shields.io/npm/v/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![npm-загрузки](https://img.shields.io/npm/dm/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp)[![Версия Node.js](https://img.shields.io/node/v/@larksuiteoapi/lark-mcp.svg)](https://nodejs.org/)\n\nанглийский |[中文](./README_ZH.md)\n\n[Извлечение документации разработчика MCP](./README_RECALL.md) | [Официальный документ](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/mcp_introduction)\n\n> **⚠️ Уведомление о бета-версии** : этот инструмент в настоящее время находится на стадии бета-тестирования. Функции и API могут измениться, поэтому, пожалуйста, следите за выпусками версий.\n\nЭто официальный инструмент Feishu/Lark OpenAPI MCP (Model Context Protocol), разработанный для того, чтобы помочь пользователям быстро подключиться к платформе Feishu/Lark и обеспечить эффективное сотрудничество между агентами ИИ и Feishu/Lark. Инструмент инкапсулирует интерфейсы Feishu/Lark Open Platform API как инструменты MCP, позволяя помощникам ИИ напрямую вызывать эти интерфейсы и реализовывать различные сценарии автоматизации, такие как обработка документов, управление разговорами, планирование календаря и многое другое.\n\n## Функции\n\n* **Полный набор инструментов API Feishu/Lark:** инкапсулирует почти все интерфейсы API Feishu/Lark, включая управление сообщениями, управление группами, операции с документами, события календаря, Bitable и другие основные функциональные области.\n\n* **Поддержка двойной аутентификации:**\n\n * Поддерживает аутентификацию с помощью токена доступа к приложению\n * Поддерживает аутентификацию с помощью токена доступа пользователя\n\n* **Гибкие протоколы связи:**\n\n * Поддерживает стандартный режим потока ввода/вывода (stdio), подходит для интеграции с инструментами ИИ, такими как Trae/Cursor/Claude\n * Поддерживает режим Server-Sent Events (SSE), предоставляя интерфейсы на основе HTTP\n\n* Поддерживает несколько методов настройки, адаптируясь к различным сценариям использования\n\n## Список инструментов\n\nПолный список всех поддерживаемых инструментов Feishu/Lark можно найти на [tools.md](./docs/tools-en.md) , где инструменты отсортированы по проектам и версиям с описаниями.\n\n## Подготовка\n\n### Создание приложения Feishu/Lark\n\nПеред использованием инструмента lark-mcp необходимо создать приложение Feishu/Lark:\n\n1. Посетите [Feishu Open Platform](https://open.feishu.cn/) или [Lark Open Platform](https://open.larksuite.com/) и войдите в систему.\n2. Нажмите «Консоль» и создайте новое приложение.\n3. Получите идентификатор приложения и секретный ключ приложения, которые будут использоваться для аутентификации API.\n4. Добавьте необходимые разрешения для вашего приложения в зависимости от вашего сценария использования.\n5. Если вам необходимо вызывать API как пользователь, настройте URL-адреса перенаправления OAuth 2.0 и получите токены доступа пользователя.\n\nПодробные инструкции по созданию и настройке приложений см. в [документации Feishu Open Platform — Создание приложения](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0) или [в документации Lark Open Platform](https://open.larksuite.com/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0) .\n\n### Установка Node.js\n\nПеред использованием инструмента lark-mcp необходимо установить среду Node.js.\n\n#### Установка Node.js на macOS\n\n1. **Использование Homebrew (рекомендуется)** :\n\n ```bash\n brew install node\n ```\n\n2. **Использование официального установщика** :\n\n * Посетите [сайт Node.js](https://nodejs.org/)\n\n * Загрузите и установите версию LTS\n\n * После установки проверьте в терминале:\n\n ```bash\n node -v\n npm -v\n ```\n\n#### Установка Node.js на Windows\n\n1. **Использование официального установщика** :\n\n * Посетите [сайт Node.js](https://nodejs.org/)\n\n * Загрузите и запустите установщик Windows (файл .msi)\n\n * Следуйте указаниям мастера установки для завершения установки.\n\n * После установки проверьте в командной строке:\n\n ```bash\n node -v\n npm -v\n ```\n\n2. **Использование nvm-windows** :\n\n * Скачать [nvm-windows](https://github.com/coreybutler/nvm-windows/releases)\n\n * Установить nvm-windows\n\n * Используйте nvm для установки Node.js:\n\n ```bash\n nvm install latest\n nvm use \n ```\n\n## Установка\n\nУстановите инструмент lark-mcp глобально:\n\n```bash\nnpm install -g @larksuiteoapi/lark-mcp\n```\n\n## Руководство по использованию\n\n### Использование с Trae/Cursor/Claude\n\nЧтобы интегрировать функциональность Feishu/Lark в инструменты искусственного интеллекта, такие как Trae, Cursor или Claude, добавьте в файл конфигурации следующее:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\"\n ]\n }\n }\n}\n```\n\nДля доступа к API с использованием идентификатора пользователя вы можете добавить токен доступа пользователя:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\",\n \"-u\",\n \"\"\n ]\n }\n }\n}\n```\n\n### Конфигурация пользовательского API\n\nПо умолчанию служба MCP включает общие API. Чтобы включить другие инструменты или только определенные API или предустановки, вы можете указать их с помощью параметра `-t` (через запятую):\n\n```bash\nlark-mcp mcp -a -s -t im.v1.message.create,im.v1.message.list,im.v1.chat.create,preset.calendar.default\n```\n\n#### Подробные сведения о предустановленных коллекциях инструментов\n\nВ следующей таблице подробно описан каждый инструмент API и его включение в различные коллекции предустановок, что поможет вам выбрать подходящую предустановку для ваших нужд:\n\n| Название инструмента | Описание функции | preset.default (по умолчанию) | preset.im.default | preset.base.default | предустановленная.базовая.партия | preset.doc.default | предустановленная.задача.по умолчанию | предустановленный.календарь.по.умолчанию |\n| ------------------------------------- | -------------------------------------------------- | :---------------------------: | :---------------: | :-----------------: | :------------------------------: | :----------------: | :-----------------------------------: | :--------------------------------------: |\n| im.v1.chat.create | Создать групповой чат | ✓ | ✓ | | | | | |\n| im.v1.chat.list | Получить список группового чата | ✓ | ✓ | | | | | |\n| im.v1.chatMembers.get | Получить участников группы | ✓ | ✓ | | | | | |\n| im.v1.сообщение.создать | Отправлять сообщения | ✓ | ✓ | | | | | |\n| im.v1.сообщение.список | Получить список сообщений | ✓ | ✓ | | | | | |\n| bitable.v1.app.create | Создать базу | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.создать | Создать базовую таблицу данных | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.list | Получить список таблиц базовых данных | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableField.list | Получить список полей таблицы базовых данных | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.поиск | Поиск записей таблицы базовых данных | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.создать | Создать базовые записи таблицы данных | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchCreate | Пакетное создание записей таблицы базовых данных | | | | ✓ | | | |\n| bitable.v1.appTableRecord.обновление | Обновление записей таблицы базовых данных | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchUpdate | Пакетное обновление записей таблицы базовых данных | | | | ✓ | | | |\n| docx.v1.document.rawContent | Получить содержимое документа | ✓ | | | | ✓ | | |\n| docx.встроенный.импорт | Импортные документы | ✓ | | | | ✓ | | |\n| docx.встроенный.поиск | Поиск документов | ✓ | | | | ✓ | | |\n| drive.v1.permissionMember.create | Добавить разрешения соавтора | ✓ | | | | ✓ | | |\n| wiki.v2.space.getNode | Получить Wiki-узел | ✓ | | | | ✓ | | |\n| wiki.v1.node.search | Поиск вики-узлов | ✓ | | | | ✓ | | |\n| contact.v3.user.batchGetId | Пакетное получение идентификаторов пользователей | ✓ | | | | | | |\n| задача.v2.задача.создать | Создать задачу | | | | | | ✓ | |\n| задача.v2.задача.патч | Изменить задачу | | | | | | ✓ | |\n| task.v2.task.addMembers | Добавить участников задачи | | | | | | ✓ | |\n| task.v2.task.addНапоминания | Добавить напоминания о задачах | | | | | | ✓ | |\n| календарь.v4.calendarEvent.создать | Создать событие календаря | | | | | | | ✓ |\n| календарь.v4.calendarEvent.патч | Изменить событие календаря | | | | | | | ✓ |\n| календарь.v4.calendarEvent.get | Получить событие календаря | | | | | | | ✓ |\n| календарь.v4.freebusy.list | Запрос статуса «свободен/занят» | | | | | | | ✓ |\n| календарь.v4.календарь.первичный | Получить основной календарь | | | | | | | ✓ |\n\n> **Примечание** : В таблице \"✓\" указывает, что инструмент включен в этот пресет. Использование `-t preset.xxx` включит только инструменты, отмеченные \"✓\" в соответствующем столбце.\n\n### Расширенная конфигурация\n\n#### Параметры командной строки\n\nИнструмент `lark-mcp mcp` предоставляет различные параметры командной строки для гибкой настройки службы MCP:\n\n| Параметр | Короткий | Описание | Пример |\n| --------------------- | -------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------- |\n| `--app-id` | `-a` | Идентификатор приложения Feishu/Lark | `-a cli_xxxx` |\n| `--app-secret` | `-s` | Секрет приложения Feishu/Lark | `-s xxxx` |\n| `--domain` | `-d` | Домен API Feishu/Lark, по умолчанию | `-d https://open.larksuite.com` |\n| `--tools` | `-t` | Список инструментов API для включения, разделенных запятыми | `-t im.v1.message.create,im.v1.chat.create` |\n| `--tool-name-case` | `-c` | Формат имени инструмента, варианты: змея, верблюд, точка или шашлык, по умолчанию — змея | `-c camel` |\n| `--language` | `-l` | Язык инструментов, варианты zh или en, по умолчанию en | `-l zh` |\n| `--user-access-token` | `-u` | Токен доступа пользователя для вызова API в качестве пользователя | `-u u-xxxx` |\n| `--token-mode` | | Тип токена API, варианты: auto, tenant\\_access\\_token или user\\_access\\_token, по умолчанию — auto | `--token-mode user_access_token` |\n| `--mode` | `-m` | Режим транспорта, варианты — stdio или sse, по умолчанию — stdio | `-m sse` |\n| `--host` | | Прослушивающий хост в режиме SSE, по умолчанию — localhost | `--host 0.0.0.0` |\n| `--port` | `-p` | Прослушиваемый порт в режиме SSE, по умолчанию 3000 | `-p 3000` |\n| `--config` | | Путь к файлу конфигурации, поддерживает формат JSON | `--config ./config.json` |\n| `--version` | `-V` | Показать номер версии | `-V` |\n| `--help` | `-h` | Отображение справочной информации | `-h` |\n\n#### Примеры использования параметров\n\n1. **Базовое использование** (с использованием идентификатора приложения):\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy\n ```\n\n2. **Использование идентификатора пользователя** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -u u-zzzz\n ```\n\n > **Примечание** : токены доступа пользователя можно получить через [процесс авторизации Feishu Open Platform](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/authentication-management/access-token/get-user-access-token) или [процесс авторизации Lark Open Platform](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create) , или вы можете использовать консоль отладки API для их получения. После использования токена доступа пользователя вызовы API будут выполняться с идентификатором этого пользователя.\n\n3. **Настройка определенного режима токена** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy --token-mode user_access_token\n ```\n\n > **Примечание** : эта опция позволяет явно указать, какой тип токена использовать при вызове API. `auto` режим (по умолчанию) будет определяться LLM при вызове API.\n\n4. **Указание доменов Lark или KA** :\n\n ```bash\n # Lark international version\n lark-mcp mcp -a -s -d https://open.larksuite.com\n\n # Custom domain (KA domain)\n lark-mcp mcp -a -s -d https://open.your-ka-domain.com\n ```\n\n5. **Включение только определенных инструментов API или других инструментов API** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -t im.v1.chat.create,im.v1.message.create\n ```\n\n > **Примечание** : Параметр `-t` поддерживает следующие предустановленные наборы инструментов:\n >\n > * `preset.default` — набор инструментов по умолчанию, содержащий все предустановленные инструменты\n > * `preset.im.default` — инструменты, связанные с мгновенным обменом сообщениями, такие как управление группами, отправка сообщений и т. д.\n > * `preset.bitable.default` — инструменты, связанные с Bitable, такие как создание таблиц, управление записями и т. д.\n > * `preset.bitable.batch` — инструменты пакетной обработки Bitable, включая функции пакетного создания и обновления записей\n > * `preset.doc.default` — инструменты, связанные с документами, такие как чтение содержимого документа, управление разрешениями и т. д.\n > * `preset.task.default` — инструменты, связанные с управлением задачами, такие как создание задач, управление участниками и т. д.\n > * `preset.calendar.default` — инструменты управления событиями календаря, такие как создание событий календаря, запрос статуса «свободен/занят» и т. д.\n\n6. **Использование режима SSE с определенным портом и хостом** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -m sse --host 0.0.0.0 -p 3000\n ```\n\n7. **Установка китайского языка в инструментах** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -l zh\n ```\n\n > **Примечание** : Установка языка на китайский ( `-l zh` ) может потреблять больше токенов. Если вы столкнетесь с проблемами ограничения токенов при интеграции с большими языковыми моделями, рассмотрите возможность использования настройки английского языка по умолчанию ( `-l en` ).\n\n8. **Установка формата имени инструмента на CamelCase** :\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -c camel\n ```\n\n > **Примечание** : Установив формат имени инструмента, вы можете изменить способ отображения имен инструментов в MCP. Например, `im.v1.message.create` в разных форматах:\n >\n > * формат змеи (по умолчанию): `im_v1_message_create`\n > * Формат Camel: `imV1MessageCreate`\n > * Формат кебаба: `im-v1-message-create`\n > * формат точки: `im.v1.message.create`\n\n9. **Использование переменных среды вместо параметров командной строки** :\n\n ```bash\n # Set environment variables\n export APP_ID=cli_xxxx\n export APP_SECRET=yyyyy\n\n # Start the service (no need to specify -a and -s parameters)\n lark-mcp mcp\n ```\n\n10. **Использование файла конфигурации** :\n\nПомимо параметров командной строки, для установки параметров можно также использовать файл конфигурации в формате JSON:\n\n```bash\nlark-mcp mcp --config ./config.json\n```\n\nПример файла конфигурации (config.json):\n\n```json\n{\n \"appId\": \"cli_xxxx\",\n \"appSecret\": \"xxxx\",\n \"domain\": \"https://open.feishu.cn\",\n \"tools\": [\"im.v1.message.create\",\"im.v1.chat.create\"],\n \"toolNameCase\": \"snake\",\n \"language\": \"zh\",\n \"userAccessToken\": \"\",\n \"tokenMode\": \"auto\",\n \"mode\": \"stdio\",\n \"host\": \"localhost\",\n \"port\": \"3000\"\n}\n```\n\n> **Примечание** : Параметры командной строки имеют более высокий приоритет, чем файл конфигурации. При использовании как параметров командной строки, так и файла конфигурации параметры командной строки переопределят соответствующие настройки в файле конфигурации.\n\n11. **Виды транспорта** :\n\nlark-mcp поддерживает два режима транспортировки:\n\n1. **Режим stdio (по умолчанию/рекомендуется)** : подходит для интеграции с инструментами ИИ, такими как Trae/Cursor или Claude, взаимодействующими через стандартные потоки ввода/вывода.\n\n```bash\nlark-mcp mcp -a -s -m stdio\n```\n\n2. **Режим SSE** : предоставляет HTTP-интерфейс на основе событий, отправляемых сервером, подходящий для сценариев, где локальное выполнение невозможно.\n\n```bash\n# Default listens only on localhost\nlark-mcp mcp -a -s -m sse -p 3000\n\n# Listen on all network interfaces (allowing remote access)\nlark-mcp mcp -a -s -m sse --host 0.0.0.0 -p 3000\n```\n\nПосле запуска конечная точка SSE будет доступна по адресу `http://:/sse` .\n\n## Часто задаваемые вопросы\n\n* **Проблема** : Невозможно подключиться к API Feishu/Lark **Решение** : Проверьте сетевое подключение и убедитесь, что APP\\_ID и APP\\_SECRET указаны правильно. Убедитесь, что вы можете получить доступ к API Feishu/Lark Open Platform; возможно, вам придется настроить прокси-сервер.\n\n* **Проблема** : Ошибка при использовании user\\_access\\_token **Решение** : Проверьте, не истек ли срок действия токена. Обычно срок действия user\\_access\\_token составляет 2 часа, и его необходимо периодически обновлять. Вы можете реализовать механизм автоматического обновления токена.\n\n* **Проблема** : Невозможно вызвать определенные API после запуска службы MCP, с ошибками недостаточного количества разрешений **Решение** : Проверьте, получило ли ваше приложение соответствующие разрешения API. Некоторые API требуют дополнительных разрешений высокого уровня, которые можно настроить в [Developer Console](https://open.feishu.cn/app) или [Lark Developer Console](https://open.larksuite.com/app) . Убедитесь, что разрешения были одобрены.\n\n* **Проблема** : Вызовы API, связанные с загрузкой/выгрузкой изображений или файлов, не работают. **Решение** : Текущая версия не поддерживает функциональность загрузки/выгрузки файлов и изображений. Эти API будут поддерживаться в будущих версиях.\n\n* **Проблема** : Командная строка отображает искаженные символы в среде Windows **Решение** : Измените кодировку командной строки на UTF-8, выполнив команду `chcp 65001` в командной строке. Если вы используете PowerShell, вам может потребоваться изменить шрифт терминала или конфигурацию PowerShell.\n\n* **Проблема** : Ошибки разрешений во время установки **Решение** : На macOS/Linux используйте `sudo npm install -g @larksuiteoapi/lark-mcp` для установки или измените разрешения глобального пути установки npm. Пользователи Windows могут попробовать запустить командную строку от имени администратора.\n\n* **Проблема** : превышен лимит токенов после запуска службы MCP. **Решение** : попробуйте использовать `-t` , чтобы уменьшить количество включенных API, или используйте модель, которая поддерживает более крупные токены (например, claude3.7).\n\n* **Проблема** : Невозможно подключиться или получить сообщения в режиме SSE. **Решение** : Проверьте, не используется ли уже порт, и попробуйте изменить его на другой порт. Убедитесь, что клиент правильно подключен к конечной точке SSE и обрабатывает поток событий.\n\n## Ссылки по теме\n\n* [Открытая платформа Фейшу](https://open.feishu.cn/)\n* [Открытая международная платформа Lark](https://open.larksuite.com/)\n* [Документация по API открытой платформы Feishu](https://open.feishu.cn/document/home/index)\n* [Документация API открытой платформы Lark](https://open.larksuite.com/document/home/index)\n* [Сайт Node.js](https://nodejs.org/)\n* [Документация npm](https://docs.npmjs.com/)\n\n## Обратная связь\n\nВопросы приветствуются, чтобы помочь улучшить этот инструмент. Если у вас есть какие-либо вопросы или предложения, пожалуйста, поднимите их в репозитории GitHub.","Russian","ru-RU",{"_29":74,"_33":78,"_38":79},{"_31":75,"_33":76,"_35":77},"一套工具包，支持AI助手直接调用飞书/Lark API接口，实现文档处理、对话管理、日历安排等自动化场景。","飞书/Lark OpenAPI MCP","# 飞书/Lark OpenAPI MCP\n\n[![npm 版本](https://img.shields.io/npm/v/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![npm 下载](https://img.shields.io/npm/dm/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp) [![Node.js 版本](https://img.shields.io/node/v/@larksuiteoapi/lark-mcp.svg)](https://nodejs.org/)\n\n英语 |[中文](./README_ZH.md)\n\n[开发者文档检索MCP](./README_RECALL.md) |[官方文档](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/mcp_introduction)\n\n> **⚠️ Beta 版本公告**：本工具目前处于 Beta 阶段。功能和 API 可能会有所变更，请持续关注版本更新。\n\n这是飞书/Lark 官方 OpenAPI MCP（模型上下文协议）工具，旨在帮助用户快速接入飞书/Lark 平台，实现 AI 助手与飞书/Lark 的高效协同。该工具将飞书/Lark 开放平台 API 接口封装为 MCP 工具，AI 助手可以直接调用这些接口，实现文档处理、对话管理、日历安排等各种自动化场景。\n\n## 特征\n\n* \\*\\*完整的飞书/Lark API 工具包：\\*\\*封装了几乎所有飞书/Lark API 接口，包括消息管理、群组管理、文档操作、日历事件、Bitable 等核心功能区。\n\n* **双重身份验证支持：**\n\n * 支持App Access Token认证\n * 支持用户访问令牌认证\n\n* **灵活的通信协议：**\n\n * 支持标准输入/输出流（stdio）模式，适合与Trae/Cursor/Claude等AI工具集成\n * 支持服务器发送事件（SSE）模式，提供基于HTTP的接口\n\n* 支持多种配置方式，适应不同使用场景\n\n## 工具清单\n\n所有受支持的飞书/Lark 工具的完整列表可以在[tools.md](./docs/tools-en.md)中找到，其中工具按项目和版本分类并附有说明。\n\n## 准备\n\n### 创建飞书/Lark 应用\n\n使用 lark-mcp 工具前，你需要创建一个飞书/Lark 应用：\n\n1. 访问[飞书开放平台](https://open.feishu.cn/)或[Lark 开放平台](https://open.larksuite.com/)并登录\n2. 点击“控制台”并创建一个新的应用程序\n3. 获取App ID和App Secret，用于API认证\n4. 根据您的使用场景为您的应用程序添加必要的权限\n5. 如果需要以用户身份调用 API，请设置 OAuth 2.0 重定向 URL 并获取用户访问令牌\n\n详细的应用创建及配置指南，请参考[飞书开放平台文档-创建应用](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0)或[Lark 开放平台文档](https://open.larksuite.com/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0)。\n\n### 安装 Node.js\n\n使用 lark-mcp 工具前，需要安装 Node.js 环境。\n\n#### 在 macOS 上安装 Node.js\n\n1. **使用 Homebrew（推荐）** ：\n\n ```bash\n brew install node\n ```\n\n2. **使用官方安装程序**：\n\n * 访问[Node.js 网站](https://nodejs.org/)\n\n * 下载并安装 LTS 版本\n\n * 安装完成后在终端验证：\n\n ```bash\n node -v\n npm -v\n ```\n\n#### 在 Windows 上安装 Node.js\n\n1. **使用官方安装程序**：\n\n * 访问[Node.js 网站](https://nodejs.org/)\n\n * 下载并运行 Windows 安装程序（.msi 文件）\n\n * 按照安装向导完成安装\n\n * 安装完成后，在命令提示符中验证：\n\n ```bash\n node -v\n npm -v\n ```\n\n2. **使用 nvm-windows** ：\n\n * 下载[nvm-windows](https://github.com/coreybutler/nvm-windows/releases)\n\n * 安装 nvm-windows\n\n * 使用 nvm 安装 Node.js：\n\n ```bash\n nvm install latest\n nvm use \n ```\n\n## 安装\n\n全局安装 lark-mcp 工具：\n\n```bash\nnpm install -g @larksuiteoapi/lark-mcp\n```\n\n## 使用指南\n\n### 与 Trae/Cursor/Claude 一起使用\n\n要将飞书/Lark 功能集成到 Trae，Cursor 或 Claude 等 AI 工具中，请在配置文件中添加以下内容：\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\"\n ]\n }\n }\n}\n```\n\n要使用用户身份访问 API，您可以添加用户访问令牌：\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\",\n \"-u\",\n \"\"\n ]\n }\n }\n}\n```\n\n### 自定义 API 配置\n\nMCP 服务默认启用常用 API。如需启用其他工具或仅启用特定的 API 或预设，您可以使用`-t`参数指定（以逗号分隔）：\n\n```bash\nlark-mcp mcp -a -s -t im.v1.message.create,im.v1.message.list,im.v1.chat.create,preset.calendar.default\n```\n\n#### 预设工具集合详情\n\n下表详细介绍了每个 API 工具及其在不同预设集合中的包含情况，帮助您根据需求选择合适的预设：\n\n| 工具名称 | 功能描述 | preset.default（默认） | 预设.im.默认值 | 预设.基础.默认 | 预设.基础.批次 | 预设.doc.默认 | 预设任务默认 | 预设.日历.默认 |\n| ------------------------------------- | ----------- | :----------------: | :-------: | :------: | :------: | :-------: | :----: | :------: |\n| im.v1.聊天.创建 | 创建群聊 | ✓ | ✓ | | | | | |\n| im.v1.聊天列表 | 获取群聊列表 | ✓ | ✓ | | | | | |\n| im.v1.聊天成员.获取 | 获取群组成员 | ✓ | ✓ | | | | | |\n| im.v1.消息.创建 | 发送消息 | ✓ | ✓ | | | | | |\n| im.v1.消息列表 | 获取消息列表 | ✓ | ✓ | | | | | |\n| bitable.v1.app.创建 | 创建基地 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.创建 | 创建基础数据表 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.list | 获取基础数据表列表 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableField.list | 获取基础数据表字段列表 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.search | 查找基础数据表记录 | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.创建 | 创建基础数据表记录 | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchCreate | 批量创建基础数据表记录 | | | | ✓ | | | |\n| bitable.v1.appTableRecord.update | 更新基础数据表记录 | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchUpdate | 批量更新基础数据表记录 | | | | ✓ | | | |\n| docx.v1.document.rawContent | 获取文档内容 | ✓ | | | | ✓ | | |\n| docx.builtin.import | 导入文件 | ✓ | | | | ✓ | | |\n| docx.builtin.search | 搜索文档 | ✓ | | | | ✓ | | |\n| 驱动器.v1.权限成员.创建 | 添加协作者权限 | ✓ | | | | ✓ | | |\n| wiki.v2.space.getNode | 获取 Wiki 节点 | ✓ | | | | ✓ | | |\n| wiki.v1.node.search | 搜索 Wiki 节点 | ✓ | | | | ✓ | | |\n| contact.v3.用户.batchGetId | 批量获取用户ID | ✓ | | | | | | |\n| 任务.v2.任务.创建 | 创建任务 | | | | | | ✓ | |\n| 任务.v2.任务.补丁 | 修改任务 | | | | | | ✓ | |\n| task.v2.task.添加成员 | 添加任务成员 | | | | | | ✓ | |\n| task.v2.task.添加提醒 | 添加任务提醒 | | | | | | ✓ | |\n| calendar.v4.calendarEvent.create | 创建日历事件 | | | | | | | ✓ |\n| calendar.v4.calendarEvent.patch | 修改日历事件 | | | | | | | ✓ |\n| calendar.v4.calendarEvent.get | 获取日历事件 | | | | | | | ✓ |\n| 日历.v4.空闲忙碌列表 | 查询空闲/忙碌状态 | | | | | | | ✓ |\n| 日历.v4.日历.主 | 获取主日历 | | | | | | | ✓ |\n\n> **注意**：表中的“✓”表示该工具包含在该预设中。使用`-t preset.xxx`将仅启用相应列中标有“✓”的工具。\n\n### 高级配置\n\n#### 命令行参数\n\n`lark-mcp mcp`工具提供了丰富的命令行参数，可以灵活地配置 MCP 服务：\n\n| 范围 | 短的 | 描述 | 例子 |\n| --------------------- | ---- | ----------------------------------------------------------------------- | ------------------------------------------- |\n| `--app-id` | `-a` | 飞书/Lark 应用 App ID | `-a cli_xxxx` |\n| `--app-secret` | `-s` | 飞书/Lark 应用 App Secret | `-s xxxx` |\n| `--domain` | `-d` | 飞书/Lark API 域名，默认为 | `-d https://open.larksuite.com` |\n| `--tools` | `-t` | 要启用的 API 工具列表，以逗号分隔 | `-t im.v1.message.create,im.v1.chat.create` |\n| `--tool-name-case` | `-c` | 工具名称格式，可选为snake、camel、dot、kebab，默认为snake | `-c camel` |\n| `--language` | `-l` | 工具语言，可选zh或en，默认为en | `-l zh` |\n| `--user-access-token` | `-u` | 用于以用户身份调用 API 的用户访问令牌 | `-u u-xxxx` |\n| `--token-mode` | | API token 类型，可选 auto、tenant\\_access\\_token、user\\_access\\_token，默认为 auto | `--token-mode user_access_token` |\n| `--mode` | `-m` | 传输模式，选项为 stdio 或 sse，默认为 stdio | `-m sse` |\n| `--host` | | SSE模式下监听主机，默认为localhost | `--host 0.0.0.0` |\n| `--port` | `-p` | SSE模式下监听端口，默认3000 | `-p 3000` |\n| `--config` | | 配置文件路径，支持JSON格式 | `--config ./config.json` |\n| `--version` | `-V` | 显示版本号 | `-V` |\n| `--help` | `-h` | 显示帮助信息 | `-h` |\n\n#### 参数使用示例\n\n1. **基本用法**（使用应用程序身份）：\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy\n ```\n\n2. **使用用户身份**：\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -u u-zzzz\n ```\n\n > **注意**：用户访问令牌可以通过[飞书开放平台授权流程](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/authentication-management/access-token/get-user-access-token)、 [Lark开放平台授权流程](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create)获取，也可以通过API调试控制台获取。使用用户访问令牌后，将以该用户的身份进行API调用。\n\n3. **设置特定的令牌模式**：\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy --token-mode user_access_token\n ```\n\n > **注意**：此选项允许您明确指定调用 API 时要使用的令牌类型。 `auto`模式（默认）将由 LLM 在调用 API 时确定。\n\n4. **指定 Lark 或 KA 域名**：\n\n ```bash\n # Lark international version\n lark-mcp mcp -a -s -d https://open.larksuite.com\n\n # Custom domain (KA domain)\n lark-mcp mcp -a -s -d https://open.your-ka-domain.com\n ```\n\n5. **仅启用特定 API 工具或其他 API 工具**：\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -t im.v1.chat.create,im.v1.message.create\n ```\n\n > **注意**： `-t`参数支持以下预设工具集合：\n >\n > * `preset.default` - 包含所有预设工具的默认工具集\n > * `preset.im.default` - 即时通讯相关工具，例如群组管理、消息发送等。\n > * `preset.bitable.default` - Bitable 相关工具，例如表创建、记录管理等。\n > * `preset.bitable.batch` - Bitable批量操作工具，包含批量创建、更新记录功能\n > * `preset.doc.default` - 文档相关工具，如文档内容读取、权限管理等。\n > * `preset.task.default` - 任务管理相关工具，例如任务创建、成员管理等。\n > * `preset.calendar.default` - 日历事件管理工具，例如创建日历事件、查询空闲/忙碌状态等。\n\n6. **使用具有特定端口和主机的 SSE 模式**：\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -m sse --host 0.0.0.0 -p 3000\n ```\n\n7. **将工具语言设置为中文**：\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -l zh\n ```\n\n > **注意**：将语言设置为中文 ( `-l zh` ) 可能会消耗更多 token。如果在集成大型语言模型时遇到 token 限制问题，请考虑使用默认的英语设置 ( `-l en` )。\n\n8. **将工具名称格式设置为驼峰式命名法**：\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -c camel\n ```\n\n > **注意**：通过设置工具名称格式，您可以更改工具名称在 MCP 中的显示方式。例如， `im.v1.message.create`有以下不同格式：\n >\n > * 蛇形格式（默认）： `im_v1_message_create`\n > * 骆驼格式： `imV1MessageCreate`\n > * kebab格式： `im-v1-message-create`\n > * 点格式： `im.v1.message.create`\n\n9. **使用环境变量代替命令行参数**：\n\n ```bash\n # Set environment variables\n export APP_ID=cli_xxxx\n export APP_SECRET=yyyyy\n\n # Start the service (no need to specify -a and -s parameters)\n lark-mcp mcp\n ```\n\n10. **使用配置文件**：\n\n除了命令行参数外，还可以使用JSON格式的配置文件来设置参数：\n\n```bash\nlark-mcp mcp --config ./config.json\n```\n\n配置文件示例（config.json）：\n\n```json\n{\n \"appId\": \"cli_xxxx\",\n \"appSecret\": \"xxxx\",\n \"domain\": \"https://open.feishu.cn\",\n \"tools\": [\"im.v1.message.create\",\"im.v1.chat.create\"],\n \"toolNameCase\": \"snake\",\n \"language\": \"zh\",\n \"userAccessToken\": \"\",\n \"tokenMode\": \"auto\",\n \"mode\": \"stdio\",\n \"host\": \"localhost\",\n \"port\": \"3000\"\n}\n```\n\n> **注意**：命令行参数的优先级高于配置文件。当同时使用命令行参数和配置文件时，命令行参数将覆盖配置文件中的相应设置。\n\n11. **运输方式**：\n\nlark-mcp 支持两种传输模式：\n\n1. **stdio 模式（默认/推荐）** ：适合与 Trae/Cursor 或 Claude 等 AI 工具集成，通过标准输入/输出流进行通信。\n\n```bash\nlark-mcp mcp -a -s -m stdio\n```\n\n2. **SSE模式**：提供基于Server-Sent Events的HTTP接口，适用于无法本地执行的场景。\n\n```bash\n# Default listens only on localhost\nlark-mcp mcp -a -s -m sse -p 3000\n\n# Listen on all network interfaces (allowing remote access)\nlark-mcp mcp -a -s -m sse --host 0.0.0.0 -p 3000\n```\n\n启动后，SSE 端点可通过`http://:/sse`访问。\n\n## 常问问题\n\n* **问题**：无法连接到飞书/Lark API**解决方案**：请检查网络连接，并确保您的 APP\\_ID 和 APP\\_SECRET 正确。请确认您可以访问飞书/Lark 开放平台 API；您可能需要配置代理。\n\n* **问题**：使用 user\\_access\\_token 时出错**解决方案**：检查 token 是否过期。user\\_access\\_token 的有效期通常为 2 小时，需要定期刷新。您可以实现 token 自动刷新机制。\n\n* **问题**：启动 MCP 服务后无法调用某些 API，提示权限不足**解决方案**：请检查您的应用是否已获取相应的 API 权限。部分 API 需要额外的高级权限，您可以在[开发者控制台](https://open.feishu.cn/app)或[Lark 开发者控制台](https://open.larksuite.com/app)中配置这些权限。请确保权限已获得批准。\n\n* **问题**：图片或文件上传/下载相关的 API 调用失败**解决方案**：当前版本不支持文件和图片上传/下载功能。这些 API 将在后续版本中支持。\n\n* **问题**：Windows 环境下命令行显示乱码**解决方案**：在命令提示符中执行`chcp 65001` ，将命令行编码更改为 UTF-8。如果使用 PowerShell，可能需要更改终端字体或 PowerShell 配置。\n\n* **问题**：安装过程中出现权限错误**解决方案**：macOS/Linux 用户请使用`sudo npm install -g @larksuiteoapi/lark-mcp`安装，或修改 npm 全局安装路径的权限。Windows 用户可尝试以管理员身份运行命令提示符。\n\n* **问题**：启动 MCP 服务后超出 Token 限制**解决方案**：尝试使用`-t`减少启用的 API 数量，或者使用支持更大 Token 的机型（例如 claude3.7）。\n\n* **问题**：无法在 SSE 模式下连接或接收消息**解决方案**：检查端口是否已被使用，并尝试切换到其他端口。确保客户端已正确连接到 SSE 端点并正在处理事件流。\n\n## 相关链接\n\n* [飞书开放平台](https://open.feishu.cn/)\n* [Lark国际开放平台](https://open.larksuite.com/)\n* [飞书开放平台API文档](https://open.feishu.cn/document/home/index)\n* [Lark 开放平台 API 文档](https://open.larksuite.com/document/home/index)\n* [Node.js 网站](https://nodejs.org/)\n* [npm 文档](https://docs.npmjs.com/)\n\n## 反馈\n\n欢迎提交问题来帮助改进此工具。如果您有任何问题或建议，请在 GitHub 仓库中提出。","Chinese","zh-CN","githubUser","locale",{"_83":84,"_85":86,"_13":131,"_140":42,"_141":42,"_142":143,"_147":148,"_171":-5,"_16":172,"_173":174,"_175":176,"_33":34,"_187":161,"_188":189,"_193":-5,"_194":195,"_200":-5,"_183":157,"_201":202,"_205":206,"_162":207,"_208":209},"addedAt","2025-04-17T15:03:04.373373551Z","argumentsJsonSchema",{"_87":88,"_128":129,"_94":130},"properties",{"_89":90,"_96":97,"_100":101,"_104":105,"_107":108,"_110":111,"_114":115,"_118":119,"_121":122,"_125":126},"HOST",{"_91":92,"_31":93,"_94":95},"default","localhost","Listening host in SSE mode","type","string","MODE",{"_91":98,"_31":99,"_94":95},"stdio","Transport mode, options are stdio or sse","PORT",{"_91":102,"_31":103,"_94":95},"3000","Listening port in SSE mode","TOOLS",{"_31":106,"_94":95},"List of API tools to enable, separated by commas","APP_ID",{"_31":109,"_94":95},"Feishu/Lark application App ID","DOMAIN",{"_91":112,"_31":113,"_94":95},"https://open.feishu.cn","Feishu/Lark API domain, default is Feishu China version","LANGUAGE",{"_91":116,"_31":117,"_94":95},"en","Tools language, options are zh or en","APP_SECRET",{"_31":120,"_94":95},"Feishu/Lark application App Secret","TOOL_NAME_CASE",{"_91":123,"_31":124,"_94":95},"snake","Tool name format, options are snake, camel, dot, or kebab","USER_ACCESS_TOKEN",{"_31":127,"_94":95},"User access token for calling APIs as a user","required",[107,118],"object",[132,133,134,135,136,137,138,139],"author:official","category:communication","category:calendar-management","category:app-automation","environment:network","hosting:remote-capable","language:typescript","license_grade:a","descriptionMarkdown","descriptionPlainText","githubProject",{"_35":144,"_145":146},"# Feishu/Lark OpenAPI MCP\n\n[![npm version](https://img.shields.io/npm/v/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp)\n[![npm downloads](https://img.shields.io/npm/dm/@larksuiteoapi/lark-mcp.svg)](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp)\n[![Node.js Version](https://img.shields.io/node/v/@larksuiteoapi/lark-mcp.svg)](https://nodejs.org/)\n\nEnglish | [中文](./README_ZH.md)\n\n[Developer Documentation Retrieval MCP](./docs/recall-mcp/README.md)\n\n[Official Document](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/mcp_introduction)\n\n[Trouble Shooting](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/use_cases)\n\n> **⚠️ Beta Version Notice**: This tool is currently in Beta stage. Features and APIs may change, so please stay updated with version releases.\n\nThis is the Feishu/Lark official OpenAPI MCP (Model Context Protocol) tool designed to help users quickly connect to the Feishu/Lark platform and enable efficient collaboration between AI Agents and Feishu/Lark. The tool encapsulates Feishu/Lark Open Platform API interfaces as MCP tools, allowing AI assistants to directly call these interfaces and implement various automation scenarios such as document processing, conversation management, calendar scheduling, and more.\n\n## Features\n\n- **Complete Feishu/Lark API Toolkit:** Encapsulates almost all Feishu/Lark API interfaces, including message management, group management, document operations, calendar events, Bitable, and other core functional areas.\n- **Dual Authentication Support:**\n - Supports App Access Token authentication\n - Supports User Access Token authentication\n- **Flexible Communication Protocols:**\n - Supports standard input/output stream (stdio) mode, suitable for integration with AI tools like Trae/Cursor/Claude\n - Supports StreamableHTTP/SSE mode, providing HTTP-based interfaces\n\n- Supports multiple configuration methods, adapting to different usage scenarios\n\n## Tool List\n\nA complete list of all supported Feishu/Lark tools can be found in [tools.md](./docs/tools-en.md), where tools are categorized by project and version with descriptions.\n\n## Preparation\n\n### Creating a Feishu/Lark Application\n\nBefore using the lark-mcp tool, you need to create a Feishu/Lark application:\n\n1. Visit the [Feishu Open Platform](https://open.feishu.cn/) or [Lark Open Platform](https://open.larksuite.com/) and log in\n2. Click \"Console\" and create a new application\n3. Obtain the App ID and App Secret, which will be used for API authentication\n4. Add the necessary permissions for your application based on your usage scenario\n5. If you need to call APIs as a user, set the OAuth 2.0 redirect URL to http://localhost:3000/callback\n\nFor detailed application creation and configuration guidelines, please refer to the [Feishu Open Platform Documentation - Creating an Application](https://open.feishu.cn/document/home/introduction-to-custom-app-development/self-built-application-development-process#a0a7f6b0).\n\n### Installing Node.js\n\nBefore using the lark-mcp tool, you need to install the Node.js environment.\n\n**Using the Official Installer (Recommended)**:\n\n1. Visit the [Node.js website](https://nodejs.org/)\n2. Download and install the LTS version\n3. After installation, verify in the terminal:\n\n```bash\nnode -v\nnpm -v\n```\n\n## Usage Guide\n\n### Using with Trae/Cursor/Claude\n\nTo integrate Feishu/Lark functionality in AI tools like Trae, Cursor or Claude, install using the button below.\n\n[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/install-mcp?name=lark-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsYXJrc3VpdGVvYXBpL2xhcmstbWNwIiwibWNwIiwiLWEiLCJ5b3VyX2FwcF9pZCIsIi1zIiwieW91cl9hcHBfc2VjcmV0Il19)\n\n[![Install MCP Server](./assets/trae-cn.svg)](trae-cn://trae.ai-ide/mcp-import?source=lark&type=stdio&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsYXJrc3VpdGVvYXBpL2xhcmstbWNwIiwibWNwIiwiLWEiLCJ5b3VyX2FwcF9pZCIsIi1zIiwieW91cl9hcHBfc2VjcmV0Il19) [![Install MCP Server](./assets/trae.svg)](trae://trae.ai-ide/mcp-import?source=lark&type=stdio&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsYXJrc3VpdGVvYXBpL2xhcmstbWNwIiwibWNwIiwiLWEiLCJ5b3VyX2FwcF9pZCIsIi1zIiwieW91cl9hcHBfc2VjcmV0Il19)\n\nor add the following to your configuration file:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\"\n ]\n }\n }\n}\n```\n\nIf you need to access APIs with **user identity**, you need to login first using the login command in the terminal. Note that you need to configure the application's redirect URL in the developer console first, default is http://localhost:3000/callback\n\n```bash\n\n# Login and get user access token\nnpx -y @larksuiteoapi/lark-mcp login -a cli_xxxx -s yyyyy\n \n# Or optionally, login with specific OAuth scope - if not specified, all permissions will be authorized by default\nnpx -y @larksuiteoapi/lark-mcp login -a cli_xxxx -s yyyyy --scope offline_access docx:document\n\n```\n\nThen add the following to your configuration file:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\",\n \"--oauth\"\n ]\n }\n }\n}\n```\n\nYou can also directly add a user access token (expires in 2 hours) via -u:\n\n```json\n{\n \"mcpServers\": {\n \"lark-mcp\": {\n \"command\": \"npx\",\n \"args\": [\n \"-y\",\n \"@larksuiteoapi/lark-mcp\",\n \"mcp\",\n \"-a\",\n \"\",\n \"-s\",\n \"\",\n \"-u\",\n \"\"\n ]\n }\n }\n}\n```\n\n### Custom API Configuration\n\nBy default, the MCP service enables common APIs. To enable other tools or only specific APIs or presets, you can specify them using the `-t` parameter (separated by commas):\n\n```bash\nlark-mcp mcp -a -s -t im.v1.message.create,im.v1.message.list,im.v1.chat.create,preset.calendar.default\n```\n\n> **⚠️ Notice**：Non-preset APIs have not undergone compatibility testing, and the AI may not perform optimally during the process of understanding and using them.\n\n#### Preset Tool Collections in Detail\n\nThe following table details each API tool and its inclusion in different preset collections, helping you choose the appropriate preset for your needs:\n\n| Tool Name | Function Description | preset.light | preset.default (Default) | preset.im.default | preset.base.default | preset.base.batch | preset.doc.default | preset.task.default | preset.calendar.default |\n| --- | --- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |\n| im.v1.chat.create | Create a group chat | | ✓ | ✓ | | | | | |\n| im.v1.chat.list | Get group chat list | | ✓ | ✓ | | | | | |\n| im.v1.chat.search | Search group chats | ✓ | | | | | | | |\n| im.v1.chatMembers.get | Get group members | | ✓ | ✓ | | | | | |\n| im.v1.message.create | Send messages | ✓ | ✓ | ✓ | | | | | |\n| im.v1.message.list | Get message list | ✓ | ✓ | ✓ | | | | | |\n| bitable.v1.app.create | Create base | | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.create | Create base data table | | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTable.list | Get base data table list | | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableField.list | Get base data table field list | | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.search | Search base data table records | ✓ | ✓ | | ✓ | ✓ | | | |\n| bitable.v1.appTableRecord.create | Create base data table records | | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchCreate | Batch create base data table records | ✓ | | | | ✓ | | | |\n| bitable.v1.appTableRecord.update | Update base data table records | | ✓ | | ✓ | | | | |\n| bitable.v1.appTableRecord.batchUpdate | Batch update base data table records | | | | | ✓ | | | |\n| docx.v1.document.rawContent | Get document content | ✓ | ✓ | | | | ✓ | | |\n| docx.builtin.import | Import documents | ✓ | ✓ | | | | ✓ | | |\n| docx.builtin.search | Search documents | ✓ | ✓ | | | | ✓ | | |\n| drive.v1.permissionMember.create | Add collaborator permissions | | ✓ | | | | ✓ | | |\n| wiki.v2.space.getNode | Get Wiki node | ✓ | ✓ | | | | ✓ | | |\n| wiki.v1.node.search | Search Wiki nodes | | ✓ | | | | ✓ | | |\n| contact.v3.user.batchGetId | Batch get user IDs | ✓ | ✓ | | | | | | |\n| task.v2.task.create | Create task | | | | | | | ✓ | |\n| task.v2.task.patch | Modify task | | | | | | | ✓ | |\n| task.v2.task.addMembers | Add task members | | | | | | | ✓ | |\n| task.v2.task.addReminders | Add task reminders | | | | | | | ✓ | |\n| calendar.v4.calendarEvent.create | Create calendar event | | | | | | | | ✓ |\n| calendar.v4.calendarEvent.patch | Modify calendar event | | | | | | | | ✓ |\n| calendar.v4.calendarEvent.get | Get calendar event | | | | | | | | ✓ |\n| calendar.v4.freebusy.list | Query free/busy status | | | | | | | | ✓ |\n| calendar.v4.calendar.primary | Get primary calendar | | | | | | | | ✓ |\n\n> **Note**: In the table, \"✓\" indicates the tool is included in that preset. Using `-t preset.xxx` will enable tools marked with \"✓\" in the corresponding column.\n\n### Advanced Configuration\n\n#### Command Line Parameters\n\n**`lark-mcp login` Command Parameters**:\n\n| Parameter | Short | Description | Example |\n|------|------|------|------|\n| `--app-id` | `-a` | Feishu/Lark application App ID | `-a cli_xxxx` |\n| `--app-secret` | `-s` | Feishu/Lark application App Secret | `-s xxxx` |\n| `--domain` | `-d` | Feishu/Lark API domain, default is https://open.feishu.cn | `-d https://open.larksuite.com` |\n| `--host` | | Host to listen, default is localhost | `--host localhost` |\n| `--port` | `-p` | Port to listen, default is 3000 | `-p 3000` |\n| `--scope` | | Specify OAuth scope for user access token, default is all permissions granted to the app, separated by spaces or commas | `--scope offline_access docx:document` |\n\n**`lark-mcp logout` Command Parameters**:\n\n| Parameter | Short | Description | Example |\n|------|------|------|------|\n| `--app-id` | `-a` | Feishu/Lark application App ID, optional. If specified, only clears the token for this app; if not specified, clears tokens for all apps | `-a cli_xxxx` |\n\nThis command is used to clear locally stored user access tokens. If the `--app-id` parameter is specified, it only clears the user access token for that application; if not specified, it clears user access tokens for all applications.\n\n**`lark-mcp mcp` Command Parameters**:\n\n| Parameter | Short | Description | Example |\n|------|------|------|------|\n| `--app-id` | `-a` | Feishu/Lark application App ID | `-a cli_xxxx` |\n| `--app-secret` | `-s` | Feishu/Lark application App Secret | `-s xxxx` |\n| `--domain` | `-d` | Feishu/Lark API domain, default is https://open.feishu.cn | `-d https://open.larksuite.com` |\n| `--tools` | `-t` | List of API tools to enable, separated by spaces or commas | `-t im.v1.message.create,im.v1.chat.create` |\n| `--tool-name-case` | `-c` | Tool name format, options are snake, camel, dot, or kebab, default is snake | `-c camel` |\n| `--language` | `-l` | Tools language, options are zh or en, default is en | `-l zh` |\n| `--user-access-token` | `-u` | User access token for calling APIs as a user | `-u u-xxxx` |\n| `--token-mode` | | API token type, options are auto, tenant_access_token, or user_access_token, default is auto | `--token-mode user_access_token` |\n| `--oauth` | | Enable MCP Auth Server to get user_access_token and auto request user login when token expires (Beta) | `--oauth` |\n| `--scope` | | Specify OAuth scope for user access token, default is all permissions granted to the app, separated by spaces or commas | `--scope offline_access docx:document` |\n| `--mode` | `-m` | Transport mode, options are stdio, streamable, or sse, default is stdio | `-m streamable` |\n| `--host` | | Listening host in SSE/Streamable mode, default is localhost | `--host 0.0.0.0` |\n| `--port` | `-p` | Listening port in SSE/Streamable mode, default is 3000 | `-p 3000` |\n| `--config` | | Configuration file path, supports JSON format | `--config ./config.json` |\n| `--version` | `-V` | Display version number | `-V` |\n| `--help` | `-h` | Display help information | `-h` |\n\n#### Parameter Usage Examples\n\n1. **Basic Usage**:\n\n ```bash\n # Start with default settings and auto request user login when token expires (recommended for local scenarios)\n lark-mcp mcp -a cli_xxxx -s yyyyy --oauth\n\n # Start with default settings\n lark-mcp mcp -a cli_xxxx -s yyyyy\n ```\n\n2. **Using User Identity**:\n\n If you need to access APIs with user identity, you need to first use the login command to log in. For details, refer to \"Using OAuth Login to Get User Access Token\":\n\n ```bash\n\n # Login and get user access token\n lark-mcp login -a cli_xxxx -s yyyyy\n ```\n\n You can also manually pass user_access_token using -u:\n\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -u u-zzzz\n ```\n\n > **Note**: User access tokens can be obtained through the [Feishu Open Platform's authorization process](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/authentication-management/access-token/get-user-access-token), or you can use the API debugging console to obtain them. After using a user access token, API calls will be made with that user's identity.\n\n3. **Using OAuth Login to Get User Access Token**:\n ```bash\n # Login and get user access token\n lark-mcp login -a cli_xxxx -s yyyyy\n \n # Specify OAuth scope\n lark-mcp login -a cli_xxxx -s yyyyy --scope offline_access\n \n # Specify domain for OAuth authentication\n lark-mcp login -a cli_xxxx -s yyyyy -d https://open.larksuite.com\n ```\n\n > **Note**: Using the `login` command will start a local OAuth server and open a browser to complete authorization. The user access token will be automatically obtained and stored securely locally for automatic use in subsequent startups.\n\n4. **Logout and Clear Stored Token**:\n ```bash\n # Clear locally stored user access token\n lark-mcp logout\n ```\n > **Note**: The `logout` command will clear the locally stored user access token. If there is no stored token currently, a corresponding message will be displayed.\n\n5. **Setting Specific Token Mode**:\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy --token-mode user_access_token\n ```\n \n > **Note**: This option allows you to explicitly specify which token type to use when calling APIs. The `auto` mode (default) will be determined by the LLM when calling the API.\n\n6. **Specifying Lark or KA Domains**:\n ```bash\n # Lark international version\n lark-mcp mcp -a -s -d https://open.larksuite.com\n\n # Custom domain (KA domain)\n lark-mcp mcp -a -s -d https://open.your-ka-domain.com\n ```\n\n7. **Enabling Only Specific API Tools or Other API Tools**:\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -t im.v1.chat.create,im.v1.message.create\n ```\n\n > **Note**: The `-t` parameter supports the following preset tool collections:\n > - `preset.light` - Lightweight tool set with fewer but commonly used tools, suitable for scenarios that require reduced token usage\n > - `preset.default` - Default tool set containing all preset tools\n > - `preset.im.default` - Instant messaging related tools, such as group management, message sending, etc.\n > - `preset.base.default` - Base related tools, such as table creation, record management, etc.\n > - `preset.base.batch` - Base batch operation tools, including batch create and update record functions\n > - `preset.doc.default` - Document related tools, such as document content reading, permission management, etc.\n > - `preset.task.default` - Task management related tools, such as task creation, member management, etc.\n > - `preset.calendar.default` - Calendar event management tools, such as creating calendar events, querying free/busy status, etc.\n\n8. **Setting Tools Language to Chinese**:\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -l zh\n ```\n \n > **Note**: Setting the language to Chinese (`-l zh`) may consume more tokens. If you encounter token limit issues when integrating with large language models, consider using the default English setting (`-l en`).\n\n9. **Setting Tool Name Format to Camel Case**:\n ```bash\n lark-mcp mcp -a cli_xxxx -s yyyyy -c camel\n ```\n \n > **Note**: By setting the tool name format, you can change how tool names appear in the MCP. For example, `im.v1.message.create` in different formats:\n > - snake format (default): `im_v1_message_create`\n > - camel format: `imV1MessageCreate`\n > - kebab format: `im-v1-message-create`\n > - dot format: `im.v1.message.create`\n\n10. **Using Environment Variables Instead of Command Line Parameters**:\n ```bash\n # Set environment variables\n export APP_ID=cli_xxxx\n export APP_SECRET=yyyyy\n export USER_ACCESS_TOKEN=zzzzz\n export LARK_TOOLS=a.b.c,a.c.d\n export LARK_DOMAIN=https://open.feishu.cn\n export LARK_TOKEN_MODE=user_access_token\n \n # Start the service (no need to specify -a and -s parameters)\n lark-mcp mcp\n ```\n\n11. **Using Configuration File**:\n\n Besides command line parameters, you can also use a JSON format configuration file to set parameters:\n\n ```bash\n lark-mcp mcp --config ./config.json\n ```\n\n Configuration file example (config.json):\n\n ```json\n {\n \"appId\": \"cli_xxxx\",\n \"appSecret\": \"xxxx\",\n \"domain\": \"https://open.feishu.cn\",\n \"tools\": [\"im.v1.message.create\",\"im.v1.chat.create\"],\n \"toolNameCase\": \"snake\",\n \"language\": \"zh\",\n \"userAccessToken\": \"\",\n \"tokenMode\": \"auto\",\n \"mode\": \"stdio\",\n \"host\": \"localhost\",\n \"port\": \"3000\",\n \"oauth\": true,\n \"scope\": \"offline_access docx:document\"\n }\n ```\n\n > **Note**: Command line parameters have higher priority than configuration file. When using both command line parameters and configuration file, command line parameters will override corresponding settings in the configuration file.\n\n12. **Transport Modes**:\n\n lark-mcp supports three transport modes:\n\n 1. **stdio mode (Default/Recommended)**: Suitable for integration with AI tools like Trae/Cursor or Claude, communicating through standard input/output streams.\n ```bash\n lark-mcp mcp -a -s -m stdio\n ```\n\n 2. **SSE mode (Deprecated)**: Provides an HTTP interface based on Server-Sent Events, suitable for scenarios where local execution is not possible.\n \n ```bash\n # Default listens only on localhost\n lark-mcp mcp -a -s -m sse -p 3000\n \n # Listen on all network interfaces (allowing remote access)\n lark-mcp mcp -a -s -m sse --host 0.0.0.0 -p 3000\n ```\n \n After startup, the SSE endpoint will be accessible at `http://:/sse`.\n\n 3. **streamable mode**: Provides StreamableHTTP-based interface\n \n ```bash\n # Start streamable mode\n lark-mcp mcp -a -s -m streamable --host 0.0.0.0 -p 3000\n ```\n\n## FAQ\n\n- **Issue**: Unable to connect to Feishu/Lark API\n\n **Solution**: Check your network connection and ensure your APP_ID and APP_SECRET are correct. Verify that you can access the Feishu/Lark Open Platform API; you may need to configure a proxy.\n\n- **Issue**: Error when using user_access_token\n\n **Solution**: Check if the token has expired. user_access_token usually has a validity period of 2 hours and needs to be refreshed periodically. You can implement an automatic token refresh mechanism.\n\n- **Issue**: Unable to call certain APIs after starting the MCP service, with insufficient permissions errors\n\n **Solution**: Check if your application has obtained the corresponding API permissions. Some APIs require additional high-level permissions, which can be configured in the [Developer Console](https://open.feishu.cn/app). Ensure that permissions have been approved.\n\n- **Issue**: Image or file upload/download related API calls fail\n\n **Solution**: The current version does not support file and image upload/download functionality. These APIs will be supported in future versions.\n\n- **Issue**: Command line displays garbled characters in Windows environment\n\n **Solution**: Change the command line encoding to UTF-8 by executing `chcp 65001` in the command prompt. If using PowerShell, you may need to change the terminal font or PowerShell configuration.\n\n- **Issue**: Permission errors during installation\n\n **Solution**: On macOS/Linux, use `sudo npm install -g @larksuiteoapi/lark-mcp` for installation, or modify the permissions of the npm global installation path. Windows users can try running the command prompt as administrator.\n\n- **Issue**: Token limit exceeded after starting the MCP service\n\n **Solution**: Try using `-t` to reduce the number of enabled APIs, or use a model that supports larger tokens.\n\n- **Issue**: Unable to connect or receive messages in SSE/Stream mode\n\n **Solution**: Check if the port is already in use and try changing to a different port. Ensure that the client is correctly connected to the SSE endpoint and is handling the event stream.\n\n- **Issue**: Linux environment startup error [StorageManager] Failed to initialize: xxx\n\n **Solution**: This does not affect scenarios where user_access_token is manually passed or not used. StorageManager uses keytar for encrypted storage of user_access_token. Please ensure libsecret is installed in the Linux environment:\n\n - Debian/Ubuntu: `sudo apt-get install libsecret-1-dev`\n - Red Hat-based: `sudo yum install libsecret-devel`\n - Arch Linux: `sudo pacman -S libsecret`\n\n## Related Links\n\n- [Feishu Open Platform](https://open.feishu.cn/)\n- [Development Documentation: OpenAPI MCP](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mcp_integration/mcp_introduction)\n- [Lark International Open Platform](https://open.larksuite.com/)\n- [Feishu Open Platform API Documentation](https://open.feishu.cn/document/home/index)\n- [Node.js Website](https://nodejs.org/)\n- [npm Documentation](https://docs.npmjs.com/)\n\n## Feedback\n\nIssues are welcome to help improve this tool. If you have any questions or suggestions, please raise them in the GitHub repository.","url","https://github.com/larksuite/lark-openapi-mcp","githubRepository",{"_149":150,"_151":152,"_153":154,"_155":156,"_33":157,"_158":159,"_164":165,"_166":167,"_169":170},"defaultBranch","main","fullName","larksuite/lark-openapi-mcp","githubTreeId",161092,"language","TypeScript","lark-openapi-mcp","owner",{"_160":161,"_162":163},"login","larksuite","uid","HdChsSRErq","recentStargazers",10,"spdxLicense",{"_33":168},"MIT License","stargazers",180,"glamaJson",5602,"inspectable",false,"integrations",[177],{"_178":179,"_31":185,"_162":186},"brand",{"_180":181,"_33":182,"_183":184},"logoSvgPath","M11.998,24c-0.321,0-0.641-0.084-0.922-0.247l-2.936-1.737c-0.438-0.245-0.224-0.332-0.08-0.383 c0.585-0.203,0.703-0.25,1.328-0.604c0.065-0.037,0.151-0.023,0.218,0.017l2.256,1.339c0.082,0.045,0.197,0.045,0.272,0l8.795-5.076 c0.082-0.047,0.134-0.141,0.134-0.238V6.921c0-0.099-0.053-0.192-0.137-0.242l-8.791-5.072c-0.081-0.047-0.189-0.047-0.271,0 L3.075,6.68C2.99,6.729,2.936,6.825,2.936,6.921v10.15c0,0.097,0.054,0.189,0.139,0.235l2.409,1.392 c1.307,0.654,2.108-0.116,2.108-0.89V7.787c0-0.142,0.114-0.253,0.256-0.253h1.115c0.139,0,0.255,0.112,0.255,0.253v10.021 c0,1.745-0.95,2.745-2.604,2.745c-0.508,0-0.909,0-2.026-0.551L2.28,18.675c-0.57-0.329-0.922-0.945-0.922-1.604V6.921 c0-0.659,0.353-1.275,0.922-1.603l8.795-5.082c0.557-0.315,1.296-0.315,1.848,0l8.794,5.082c0.57,0.329,0.924,0.944,0.924,1.603 v10.15c0,0.659-0.354,1.273-0.924,1.604l-8.794,5.078C12.643,23.916,12.324,24,11.998,24z M19.099,13.993 c0-1.9-1.284-2.406-3.987-2.763c-2.731-0.361-3.009-0.548-3.009-1.187c0-0.528,0.235-1.233,2.258-1.233 c1.807,0,2.473,0.389,2.747,1.607c0.024,0.115,0.129,0.199,0.247,0.199h1.141c0.071,0,0.138-0.031,0.186-0.081 c0.048-0.054,0.074-0.123,0.067-0.196c-0.177-2.098-1.571-3.076-4.388-3.076c-2.508,0-4.004,1.058-4.004,2.833 c0,1.925,1.488,2.457,3.895,2.695c2.88,0.282,3.103,0.703,3.103,1.269c0,0.983-0.789,1.402-2.642,1.402 c-2.327,0-2.839-0.584-3.011-1.742c-0.02-0.124-0.126-0.215-0.253-0.215h-1.137c-0.141,0-0.254,0.112-0.254,0.253 c0,1.482,0.806,3.248,4.655,3.248C17.501,17.007,19.099,15.91,19.099,13.993z","Node.js","slug","node-dot-js","Provides a Node.js-based MCP server that encapsulates Feishu/Lark Open Platform API interfaces, allowing AI assistants to directly call these interfaces for various automation scenarios.","gqmuqm54ju","namespace","npmPackage",{"_33":190,"_191":192},"@larksuiteoapi/lark-mcp","weeklyDownloads",1387,"redditPostForeignId","scores",{"_196":197,"_198":-5,"_199":-5},"license",100,"quality","security","simpleIcon","supportedPlatforms",[203,204],"MACOS","WINDOWS","toolCount",0,"n0svtdiilx","updatedAt","2025-08-06T16:52:23.837837801Z","meta",[212,215,217,224,227,229,232,235,238,241,244,246,249,252,254,256,258,260,262],{"_213":214},"title","Feishu/Lark OpenAPI MCP | Glama",{"_216":42,"_33":31},"content",{"_218":219,"_220":221,"_222":223},"href","https://glama.ai/mcp/servers/@larksuite/lark-openapi-mcp","rel","canonical","tagName","link",{"_216":34,"_225":226},"property","og:title",{"_216":42,"_225":228},"og:description",{"_216":230,"_225":231},"https://glama.ai/logo.png","og:logo",{"_216":233,"_225":234},"https://glama.ai/mcp/servers/@larksuite/lark-openapi-mcp/og-image","og:image",{"_216":236,"_225":237},"630","og:image:height",{"_216":239,"_225":240},"1200","og:image:width",{"_216":242,"_225":243},"website","og:type",{"_216":219,"_225":245},"og:url",{"_216":247,"_225":248},"Glama – MCP Hosting Platform","og:site_name",{"_216":250,"_33":251},"summary_large_image","twitter:card",{"_216":247,"_33":253},"twitter:title",{"_216":42,"_33":255},"twitter:description",{"_216":233,"_33":257},"twitter:image",{"_216":236,"_33":259},"twitter:image:height",{"_216":239,"_33":261},"twitter:image:width",{"_263":264},"script:ld+json",{"_265":266,"_267":268},"@context","http://schema.org","@graph",[269],{"_265":270,"_271":272,"_273":274},"https://schema.org","@type","BreadcrumbList","itemListElement",[275,282,286,290],{"_271":276,"_277":278,"_33":279,"_280":281},"ListItem","item","https://glama.ai/","Glama","position",1,{"_271":276,"_277":283,"_33":284,"_280":285},"https://glama.ai/mcp","MCP",2,{"_271":276,"_277":287,"_33":288,"_280":289},"https://glama.ai/mcp/servers","Servers",3,{"_271":276,"_277":219,"_33":34,"_280":291},4,"visitorIsMaintainer","routes/_public/mcp/servers/~namespace/~slug/_pages/reviews/_route",{"_80":-5,"_29":295,"_210":320,"_355":-5},{"_83":84,"_85":296,"_13":309,"_140":42,"_141":42,"_142":310,"_147":311,"_171":-5,"_16":172,"_173":174,"_175":314,"_33":34,"_187":161,"_188":317,"_193":-5,"_194":318,"_200":-5,"_183":157,"_201":319,"_205":206,"_162":207,"_208":209},{"_87":297,"_128":308,"_94":130},{"_89":298,"_96":299,"_100":300,"_104":301,"_107":302,"_110":303,"_114":304,"_118":305,"_121":306,"_125":307},{"_91":92,"_31":93,"_94":95},{"_91":98,"_31":99,"_94":95},{"_91":102,"_31":103,"_94":95},{"_31":106,"_94":95},{"_31":109,"_94":95},{"_91":112,"_31":113,"_94":95},{"_91":116,"_31":117,"_94":95},{"_31":120,"_94":95},{"_91":123,"_31":124,"_94":95},{"_31":127,"_94":95},[107,118],[132,133,134,135,136,137,138,139],{"_35":144,"_145":146},{"_149":150,"_151":152,"_153":154,"_155":156,"_33":157,"_158":312,"_164":165,"_166":313,"_169":170},{"_160":161,"_162":163},{"_33":168},[315],{"_178":316,"_31":185,"_162":186},{"_180":181,"_33":182,"_183":184},{"_33":190,"_191":192},{"_196":197,"_198":-5,"_199":-5},[203,204],[321,323,325,327,329,330,331,332,333,334,335,336,337,338,339,340,341,342,343],{"_213":322},"Reviews | Feishu/Lark OpenAPI MCP | Glama",{"_216":324,"_33":31},"Read community reviews and feedback for Feishu/Lark OpenAPI MCP. Discover user experiences, ratings, strengths, and potential limitations of this MCP implementation from actual users.",{"_218":326,"_220":221,"_222":223},"https://glama.ai/mcp/servers/@larksuite/lark-openapi-mcp/reviews",{"_216":328,"_225":226},"Reviews | Feishu/Lark OpenAPI MCP",{"_216":324,"_225":228},{"_216":230,"_225":231},{"_216":233,"_225":234},{"_216":236,"_225":237},{"_216":239,"_225":240},{"_216":242,"_225":243},{"_216":326,"_225":245},{"_216":247,"_225":248},{"_216":250,"_33":251},{"_216":247,"_33":253},{"_216":324,"_33":255},{"_216":233,"_33":257},{"_216":236,"_33":259},{"_216":239,"_33":261},{"_263":344},{"_265":266,"_267":345},[346],{"_265":270,"_271":272,"_273":347},[348,349,350,351,352],{"_271":276,"_277":278,"_33":279,"_280":281},{"_271":276,"_277":283,"_33":284,"_280":285},{"_271":276,"_277":287,"_33":288,"_280":289},{"_271":276,"_277":219,"_33":34,"_280":291},{"_271":276,"_277":326,"_33":353,"_280":354},"Reviews",5,"review","actionData","errors"]

Rate & Review

MCP directory API