- name
- feishu-doc-collab
- description
- |
- Features
- Triggers
- Feishu doc collaboration, 飞书文档协作, document edit event, in-doc chat, 文档内对话,
Feishu Document Collaboration Skill
Turn any Feishu document into a real-time human-AI collaboration space.
Overview
This skill patches OpenClaw's Feishu extension to detect document edit events and trigger isolated agent sessions. Combined with a structured in-document chat protocol, it enables:
- ✍️ Write a question in a Feishu doc → AI reads it and appends a reply
- 🚦 Status flags (🔴 editing / 🟢 done) prevent premature responses
- 👥 Multi-party routing: messages can target specific participants
- 📋 Optional Bitable task board for structured task management
Prerequisites
- OpenClaw with Feishu channel configured (app ID, app secret, event subscriptions)
- openclaw-lark extension installed (v2026.3+) or built-in feishu extension
- Feishu app event subscriptions enabled:
- drive.file.edit_v1 — document edit events - drive.file.bitable_record_changed_v1 — (optional) bitable record changes - drive.file.read_v1 — (optional, auto-ignored to suppress warnings)
- Required Feishu app permissions (enable in Open Platform console + user OAuth):
- space:document:retrieve — read documents - docx:document:readonly — read docx content (app-level) - base:table:read — read bitable table structure - base:record:read — read bitable records - base:record:update — update bitable records (for task board) - base:field:read — read bitable field definitions - drive:drive:readonly — read drive file info
- Hooks enabled in
openclaw.json:
{
"hooks": {
"enabled": true,
"token": "your-hooks-token-here"
}
}Quick Setup
Step 1: Enable hooks in openclaw.json
Add the hooks section if not present:
# Generate a random token
TOKEN=$(openssl rand -hex 16)
echo "Your hooks token: $TOKEN"
# Then add to openclaw.json:
# "hooks": { "enabled": true, "token": "<TOKEN>" }Step 2: Apply the monitor patch
bash ./skills/feishu-doc-collab/scripts/patch-monitor.shThis patches the Feishu extension's monitor.js (or monitor.ts for older installs) to:
- Detect
drive.file.edit_v1andbitable_record_changed_v1events - Apply 30-second debounce per file to prevent event storms
- Skip bot's own edits (anti-loop)
- Trigger an isolated agent session via
/hooks/agentwithdeliver: false - Silently ignore
drive.file.read_v1events (suppress warnings)
Step 3: Configure your agent identity
Edit ./skills/feishu-doc-collab/config.json:
{
"agent_name": "MyBot",
"agent_display_name": "My AI Assistant"
}The patch script uses this to set up message routing (who the agent responds as).
Step 4: Restart the gateway
openclaw gateway restartStep 5: Set up the Doc Chat Protocol
Copy the protocol template to your workspace:
cp ./skills/feishu-doc-collab/assets/DOC_PROTOCOL_TEMPLATE.md ./DOC_PROTOCOL.mdEdit DOC_PROTOCOL.md to fill in your participant roster.
How It Works
Document Edit Flow
User edits Feishu doc
↓
Feishu sends drive.file.edit_v1 event
↓
Patched monitor.ts receives event
↓
Checks: is this the bot's own edit? → Yes: skip (anti-loop)
↓ No
Debounce: same file triggered within 30s? → Yes: skip
↓ No
POST /hooks/agent with deliver:false (isolated session)
↓
Agent reads DOC_PROTOCOL.md for message format
↓
Agent reads the document, finds last message block
↓
Checks: status=🟢? addressed to me? not from me?
↓ Yes
Agent composes reply and appends to documentIn-Document Chat Protocol
Messages in the document follow this format:
---
> **Sender Name** → **Receiver Name** | 🟢 完成
Your message content here.Status flags:
- 🔴 编辑中 (editing) — AI will NOT process this message (user is still typing)
- 🟢 完成 (done) — AI will read and respond to this message
Routing:
→ AgentName— addressed to a specific AI agent→ all— broadcast to all participants
This solves a critical problem: Feishu auto-saves continuously while typing, which would trigger multiple premature AI responses without the status flag mechanism.
Bitable Task Board (Optional)
For structured task management alongside document collaboration:
- Create a Bitable with these fields:
- Task Summary (Text) - Status (SingleSelect): Unread / Read / In Progress / Done / N/A - Created (DateTime) - From (SingleSelect): participant names - To (MultiSelect): participant names - Priority (SingleSelect): Low / Medium / High / Urgent - Notes (Text) - Related Doc (URL)
- Configure in
config.json:
{
"bitable": {
"app_token": "your_bitable_app_token",
"table_id": "your_table_id"
}
}- The patch also handles
bitable_record_changed_v1events for task routing.
Re-applying After Updates
⚠️ OpenClaw or extension updates may overwrite monitor.js. After any update:
bash ./skills/feishu-doc-collab/scripts/patch-monitor.sh
openclaw gateway restartThe patch script is idempotent — safe to run multiple times.
Note: For the openclaw-lark extension (compiled .js), no jiti cache clearing is needed. For older built-in .ts installs, also run: rm -f /tmp/jiti/src-monitor.*.cjs
Configuration Reference
config.json
| Field | Type | Required | Description |
|---|---|---|---|
agent_name | string | Yes | Internal name used in protocol routing |
agent_display_name | string | Yes | Display name shown in doc replies |
bitable.app_token | string | No | Bitable app token for task board |
bitable.table_id | string | No | Bitable table ID for task board |
Environment
The patch reads from ~/.openclaw/openclaw.json:
hooks.token— authentication for /hooks/agent endpointgateway.port— gateway port (default: 18789)
Known Issues & Solutions
Event Storm (事件风暴)
Problem: Feishu sends multiple drive.file.edit_v1 and bitable_record_changed_v1 events for a single logical edit. Bitable edits are especially bad — changing one record field can trigger 10-20+ events in rapid succession. Without debounce, each event spawns a separate isolated agent session (using the full model), causing massive token waste.
Real-world impact: A single bitable task edit triggered 15+ Hook sessions consuming 350k+ tokens, all running in parallel and all reaching the same conclusion: "nothing to do".
Solution: 30-second debounce per fileToken (implemented in patch-monitor.sh v2):
- A
Map<string, number>tracks the last trigger timestamp per file/table - If the same file was triggered within 30 seconds, the event is silently skipped
- For bitable events, the debounce key includes both fileToken and tableId
- The debounce is applied before the
/hooks/agentcall, so no session is created
Bot self-edit loop: When the agent updates a bitable record (e.g., changing status to "处理完"), that edit triggers MORE events. The bot self-edit check (comparing operator_id to botOpenId) catches most of these, but the debounce provides a critical safety net for cases where the operator ID doesn't match (e.g., API calls vs. bot identity).
Important: Already-running sessions cannot be stopped by debounce. If an event storm has already started, the sessions will run to completion. Debounce only prevents NEW triggers.
Re-patching After Updates
OpenClaw or extension updates may overwrite monitor.js. After any update:
bash ./skills/feishu-doc-collab/scripts/patch-monitor.sh
openclaw gateway restartThe patch script is idempotent — checks for both /hooks/agent and _editDebounce markers.
Limitations
- Requires patching OpenClaw extension files (fragile across updates)
- Feishu app needs
drive.file.edit_v1event subscription approval - Multiple OAuth scopes must be authorized (use batch auth for convenience)
- Document must use the structured protocol format for reliable routing
- Works best with docx type; other file types (sheets, slides) are not supported
- Isolated hook sessions reuse cached OAuth tokens from the main interactive session
Credits
Created by dongwei. Inspired by the need for real-time human-AI collaboration in Chinese enterprise workflows using Feishu/Lark.
License
MIT