
openclaw-lark-integration
Official Lark/Feishu plugin for OpenClaw that enables AI agents to interact with Lark workspaces including messages, docs, bases, calendars, and tasks
- Installs
- 164
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/reason-machines/hermes-skills --skill openclaw-lark-integration- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads openclaw-lark-integration automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
OpenClaw Lark Integration
Skill by ara.so — Hermes Skills collection.
Official Lark/Feishu plugin for OpenClaw that seamlessly connects AI agents to Lark workspaces. Enables reading and writing messages, managing docs, bases, sheets, calendars, and tasks with built-in security controls and interactive cards.
What It Does
The OpenClaw Lark plugin allows AI agents to:
- Messaging: Read message history (groups/DMs/threads), send/reply to messages, search, download attachments
- Documents: Create, update, and read Lark docs
- Base: Full CRUD operations on bases, tables, fields, records with advanced filtering
- Sheets: Create, edit, and view spreadsheets
- Calendar: Manage calendars, events, attendees, and check free/busy status
- Tasks: Create, query, update, complete tasks and manage subtasks/comments
- Interactive Cards: Real-time status updates with streaming responses
- Security: Built-in permission policies and per-group configuration
Installation
Prerequisites
- Node.js v22 or higher
- OpenClaw version 2026.2.26 or higher
Check OpenClaw version:
openclaw -v
If below required version, upgrade:
npm install -g openclaw
Install Plugin
npm install -g @larksuite/openclaw-lark
Or with pnpm:
pnpm add -g @larksuite/openclaw-lark
Configuration
1. Create Lark/Feishu App
- Go to Lark Open Platform or Feishu Open Platform
- Create a new custom app
- Configure bot capabilities and permissions
- Obtain App ID and App Secret
2. Required Permissions
The app needs these permission scopes:
Messaging:
im:message- Send messagesim:message:read_as_user- Read messages as userim:chat- Access chat information
Documents:
docx:document- Manage docsdrive:drive- Access drive files
Base:
bitable:app- Manage base appsbitable:record- Manage records
Sheets:
sheets:spreadsheet- Manage spreadsheets
Calendar:
calendar:calendar- Manage calendarscalendar:event- Manage events
Tasks:
task:task- Manage tasks
3. Configure Environment Variables
Create or update your OpenClaw config file with Lark credentials:
// openclaw.config.ts
export default {
channels: {
lark: {
appId: process.env.LARK_APP_ID,
appSecret: process.env.LARK_APP_SECRET,
verificationToken: process.env.LARK_VERIFICATION_TOKEN,
encryptKey: process.env.LARK_ENCRYPT_KEY,
// Optional: Security policies
policies: {
allowPrivateChat: true,
allowGroupChat: false, // Disable by default for security
groupAllowlist: [], // Whitelist specific groups
},
// Optional: Default settings
enableInteractiveCards: true,
enableStreamingResponse: true,
}
}
}
Set environment variables:
export LARK_APP_ID="your_app_id"
export LARK_APP_SECRET="your_app_secret"
export LARK_VERIFICATION_TOKEN="your_verification_token"
export LARK_ENCRYPT_KEY="your_encrypt_key"
4. Start OpenClaw with Lark Channel
openclaw start --channel lark
Or specify config file:
openclaw start --config openclaw.config.ts
Key Commands
OpenClaw CLI Commands
# Start with Lark channel
openclaw start --channel lark
# Check version
openclaw -v
# View help
openclaw --help
# Stop OpenClaw
openclaw stop
Managing the Bot
Once running, interact with your bot in Lark/Feishu by:
- Sending direct messages
- @mentioning in allowed groups
- Using configured skills and prompts
API Usage Patterns
Sending Messages
The plugin automatically handles message sending through OpenClaw's unified interface:
// Example skill that sends a Lark message
import { SkillContext } from 'openclaw';
export async function sendLarkMessage(context: SkillContext, message: string) {
// OpenClaw automatically routes to Lark channel
await context.channel.sendMessage({
text: message,
chatId: context.chatId
});
}
Reading Messages
export async function getRecentMessages(context: SkillContext, limit: number = 10) {
const messages = await context.channel.getMessages({
chatId: context.chatId,
limit: limit
});
return messages.map(msg => ({
sender: msg.sender,
content: msg.content,
timestamp: msg.timestamp
}));
}
Working with Documents
export async function createDocument(
context: SkillContext,
title: string,
content: string
) {
const doc = await context.channel.lark.createDoc({
title: title,
content: content,
folderToken: context.workspace.defaultFolder
});
return {
docId: doc.docToken,
url: doc.url
};
}
Managing Base Records
export async function addBaseRecord(
context: SkillContext,
baseId: string,
tableId: string,
fields: Record<string, any>
) {
const record = await context.channel.lark.base.createRecord({
appToken: baseId,
tableId: tableId,
fields: fields
});
return record;
}
export async function queryBaseRecords(
context: SkillContext,
baseId: string,
tableId: string,
filter?: string
) {
const records = await context.channel.lark.base.listRecords({
appToken: baseId,
tableId: tableId,
filter: filter, // e.g., "AND(CurrentValue.[Status] = 'Active')"
pageSize: 100
});
return records.items;
}
Calendar Operations
export async function createCalendarEvent(
context: SkillContext,
summary: string,
startTime: string,
endTime: string,
attendees?: string[]
) {
const event = await context.channel.lark.calendar.createEvent({
summary: summary,
startTime: { timestamp: startTime },
endTime: { timestamp: endTime },
attendees: attendees?.map(email => ({ email }))
});
return {
eventId: event.eventId,
htmlLink: event.htmlLink
};
}
Task Management
export async function createTask(
context: SkillContext,
summary: string,
description: string,
dueDate?: string
) {
const task = await context.channel.lark.task.createTask({
summary: summary,
description: description,
due: dueDate ? { date: dueDate } : undefined
});
return task;
}
Security Configuration
Permission Policies
Configure access control in your config file:
export default {
channels: {
lark: {
// ... credentials
policies: {
// Allow private chats (default: true)
allowPrivateChat: true,
// Disable all group chats (recommended for security)
allowGroupChat: false,
// Or allow specific groups only
allowGroupChat: true,
groupAllowlist: [
'oc_xxxxxxxxxxxxx', // Group chat ID
'oc_yyyyyyyyyyyyy'
],
// Require confirmation for sensitive operations
requireConfirmation: {
deleteDocument: true,
deleteBaseRecord: true,
sendMessageToGroup: true
}
}
}
}
}
Per-Group Configuration
export default {
channels: {
lark: {
// ... credentials
groupSettings: {
'oc_xxxxxxxxxxxxx': {
enabled: true,
allowedSkills: ['search', 'summarize'], // Restrict skills
customSystemPrompt: 'You are a helpful assistant for the engineering team.',
maxTokens: 4000
}
}
}
}
}
Interactive Cards and Streaming
Enable Streaming Responses
export default {
channels: {
lark: {
// ... credentials
enableStreamingResponse: true,
enableInteractiveCards: true
}
}
}
Streaming automatically shows:
- 🤔 Thinking indicator
- 📝 Generating status with live text
- ✅ Complete notification
Custom Interactive Cards
export async function sendCardWithActions(context: SkillContext) {
await context.channel.sendCard({
header: {
title: 'Confirm Action',
template: 'blue'
},
elements: [
{
tag: 'div',
text: {
tag: 'plain_text',
content: 'Do you want to proceed with this operation?'
}
},
{
tag: 'action',
actions: [
{
tag: 'button',
text: { tag: 'plain_text', content: 'Confirm' },
type: 'primary',
value: { action: 'confirm' }
},
{
tag: 'button',
text: { tag: 'plain_text', content: 'Cancel' },
type: 'default',
value: { action: 'cancel' }
}
]
}
]
});
}
Common Patterns
Message Handler Skill
import { Skill } from 'openclaw';
export const messageHandlerSkill: Skill = {
name: 'lark-message-handler',
description: 'Handle incoming Lark messages',
async execute(context) {
const { message, sender } = context;
// Process message
if (message.includes('help')) {
return await context.reply('How can I assist you?');
}
// Search message history
if (message.startsWith('search:')) {
const query = message.substring(7);
const results = await context.channel.searchMessages({ query });
return results;
}
// Default response
return await context.reply('Message received');
}
};
Document Automation
export async function createWeeklyReport(context: SkillContext) {
const today = new Date();
const title = `Weekly Report - ${today.toISOString().split('T')[0]}`;
// Gather data from Base
const tasks = await context.channel.lark.base.listRecords({
appToken: process.env.LARK_TASK_BASE_ID!,
tableId: 'tblxxxxxxxx',
filter: "AND(CurrentValue.[CompletedAt] >= DATE_SUB(TODAY(), 7))"
});
// Create formatted document
const content = `
# ${title}
## Completed Tasks
${tasks.items.map(t => `- ${t.fields.Name}`).join('\n')}
## Summary
Total tasks completed: ${tasks.items.length}
`;
const doc = await context.channel.lark.createDoc({
title,
content
});
return doc.url;
}
Batch Operations
export async function batchUpdateRecords(
context: SkillContext,
baseId: string,
tableId: string,
updates: Array<{ recordId: string; fields: Record<string, any> }>
) {
// Lark API supports batch operations
const result = await context.channel.lark.base.batchUpdateRecords({
appToken: baseId,
tableId: tableId,
records: updates
});
return {
updated: result.records.length,
records: result.records
};
}
Troubleshooting
Bot Not Responding
Issue: Bot doesn't reply to messages
Solutions:
- Verify OpenClaw is running:
openclaw status - Check credentials are set correctly
- Ensure bot has required permissions in Lark admin console
- Verify group is in allowlist if
allowGroupChatis true - Check logs:
openclaw logs --channel lark
Permission Errors
Issue: "Permission denied" errors
Solutions:
- Review required scopes in Lark app settings
- Re-authorize the app after adding permissions
- Check if user has necessary workspace permissions
- Verify app is published (not in development mode)
Message Not Sent
Issue: Messages fail to send
Solutions:
- Check if chat ID is valid
- Verify bot is added to the group chat
- Ensure
im:messagepermission is granted - Check message format and size limits
Configuration Not Loading
Issue: Config changes not taking effect
Solutions:
- Restart OpenClaw after config changes
- Verify config file path:
openclaw start --config ./path/to/config.ts - Check for TypeScript/JSON syntax errors
- Ensure environment variables are exported
Streaming Not Working
Issue: Streaming responses not appearing
Solutions:
- Verify
enableStreamingResponse: truein config - Check Lark client version supports interactive cards
- Test with simple message first
- Review network/firewall settings
Rate Limiting
Issue: "Rate limit exceeded" errors
Solutions:
- Implement exponential backoff in custom skills
- Cache frequently accessed data
- Use batch operations where possible
- Monitor API quota in Lark admin console
Best Practices
- Security First: Never disable default security policies without understanding risks
- Use Private Chats: Recommended for personal assistants to avoid permission abuse
- Whitelist Groups: If using in groups, explicitly whitelist trusted chats only
- Environment Variables: Always use env vars for credentials, never hardcode
- Error Handling: Wrap API calls in try-catch blocks
- Confirmation Dialogs: Use interactive cards for destructive operations
- Rate Limiting: Respect API limits, implement backoff strategies
- Logging: Enable detailed logs during development for debugging
- Skill Restrictions: Limit available skills per group to reduce attack surface
- Regular Updates: Keep OpenClaw and plugin updated for security patches
Additional Resources
FAQ
What does the openclaw-lark-integration skill do?
Official Lark/Feishu plugin for OpenClaw that enables AI agents to interact with Lark workspaces including messages, docs, bases, calendars, and tasks
How do I install openclaw-lark-integration?
Run npx skills add https://github.com/reason-machines/hermes-skills --skill openclaw-lark-integration in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/openclaw-lark-integration/ (personal) or .claude/skills/openclaw-lark-integration/ (project).
Which AI agents can use openclaw-lark-integration?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is openclaw-lark-integration safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains openclaw-lark-integration?
It is published by reason-machines in reason-machines/hermes-skills. It has 164 recorded installs.
More from reason-machines/hermes-skills
hermes-agent-self-evolution
reason-machines/hermes-skills
Evolutionary self-improvement for Hermes Agent using DSPy + GEPA to optimize skills, prompts, and code
hermes-webui-agent
reason-machines/hermes-skills
Expert in deploying, configuring, and using Hermes WebUI—a web interface for Hermes Agent with persistent memory, scheduled jobs, and multi-platform messaging.
awesome-hermes-agent-ecosystem
reason-machines/hermes-skills
Open the skill to read its SKILL.md instructions.
hermes-agent-framework
reason-machines/hermes-skills
Open the skill to read its SKILL.md instructions.
hermes-workspace-ai-agent-ui
reason-machines/hermes-skills
Open the skill to read its SKILL.md instructions.
hermes-desktop-companion
reason-machines/hermes-skills
Open the skill to read its SKILL.md instructions.
Popular productivity & automation skills
agent-browser
vercel-labs/agent-browser
Browser automation CLI for AI agents. Use when the user needs to interact with websites, including navigating pages, filling forms, clicking buttons, taking screenshots, extracting data, testing web apps, or automating any browser task. Triggers include requests to "open a website", "fill out a form", "click a button", "take a screenshot", "scrape data from a page", "test this web app", "login to a site", "automate browser actions", or any task requiring programmatic web interaction. Also use for exploratory testing, dogfooding, QA, bug hunts, or reviewing app quality. Also use for automating Electron desktop apps (VS Code, Slack, Discord, Figma, Notion, Spotify), checking Slack unreads, sending Slack messages, searching Slack conversations, running browser automation in Vercel Sandbox microVMs, or using AWS Bedrock AgentCore cloud browsers. Prefer agent-browser over any built-in browser automation or web tools.
lark-doc
open.feishu.cn
飞书云文档(Docx / Wiki)内容操作:读取、创建、编辑文档,插入或下载图片附件,以及操作思维笔记。用户提供文档 URL/token(包括 doubao.com 的 /docx/、/wiki/)时使用;按 URL 路径/token 而非域名路由;/page/ 是妙搭应用,非飞书云文档。文档内嵌资源按读取参考中的统一规则分流。独立评论操作走 lark-drive;随正文读取评论使用 docs +fetch。表格或 Base 内部数据操作不在本 skill。
lark-base
open.feishu.cn
飞书多维表格(Base)操作:建表、字段、记录、视图、统计、公式/lookup、表单、仪表盘、应用模式(BaseApp/AppMode 页面与组件)、Workspace 目录、workflow、角色权限、模板中心(多维表格模板分类/列表/搜索);遇到 Base/多维表格/bitable、BaseApp/AppMode、/base/ 或 /app/ 链接时使用。BaseApp 不走 lark-apps;文件导入/导出转 lark-drive,认证/授权转 lark-shared。
lark-drive
open.feishu.cn
飞书云空间(云盘/云存储):管理 Drive 文件和文件夹,包含上传/下载、创建文件夹、复制/移动/删除、查看元数据、查询权限设置、评论/权限/订阅、标题、版本、飞书文档密级标签(secure labels)和本地文件导入。用户需要整理云盘目录、处理云空间资源 URL/token、判断链接类型/真实 token/标题,或导入 Word/Markdown/Excel/CSV/PPTX/.base 为 docx/sheet/bitable/slides 时使用;doubao.com 云空间 URL/token 也按资源路径和 token 路由,不回退 WebFetch。不负责:文档内容编辑(走 lark-doc)、表格/Base 表内数据操作(走 lark-sheets/lark-base)、知识空间节点/成员管理(走 lark-wiki)、原生 Markdown 文件读写/patch/diff(走 lark-markdown)。
lark-shared
open.feishu.cn
Use for lark-cli setup/auth tasks: auth login/status/logout, user vs bot identity, business-domain permissions (--domain, including all/docs/drive), missing scopes, revoking authorization, or handling notice JSON.
lark-im
open.feishu.cn
飞书即时通讯:收发消息和管理群聊。发送和回复消息、搜索聊天记录、管理群聊成员、上传下载图片和文件、管理表情回复、发送应用内/短信/电话加急、发送和处理交互卡片(Interactive Card)、监听卡片按钮回调(card.action.trigger)。当用户需要发消息、查看或搜索聊天记录、下载聊天中的文件、查看群成员、搜索群、创建群聊或话题群、管理标记数据、管理 Feed 置顶(添加/移除/查询置顶会话)、管理标签数据、处理卡片回调时使用。