lark-openapi-explorer

Name: lark-openapi-explorer
Author: larksuite

378kinstalls1.1kforks

How to install lark-openapi-explorer?

larksuite/cli/lark-openapi-explorer

$npx -y skills add larksuite/cli --skill lark-openapi-explorer

Installs into the current project.

Summary

飞书/Lark 原生 OpenAPI 探索：从官方文档库中挖掘未经 CLI 封装的原生 OpenAPI 接口。当用户的需求无法被现有 lark-* skill 或 lark-cli 已注册命令满足，需要查找并调用原生飞书 OpenAPI 时使用。

Files · 1

View on GitHub

SKILL.md

1	# OpenAPI Explorer
2
3	> 前置条件：先阅读 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md) 了解认证、身份切换和安全规则。
4
5	当用户的需求无法被现有 skill 或 CLI 已注册 API 覆盖时，使用本技能从飞书官方 markdown 文档库中逐层挖掘原生 OpenAPI 接口，然后通过 `lark-cli api` 裸调完成任务。
6
7	## 文档库结构
8
9	飞书 OpenAPI 文档以 markdown 层级组织：
10
11	```
12	llms.txt ← 顶层索引，列出所有模块文档链接
13	└─ llms-<module>.txt ← 模块文档，包含功能概述 + 底层 API 文档链接
14	└─ <api-doc>.md ← 单个 API 的完整说明（方法/路径/参数/响应/错误码）
15	```
16
17	文档入口：
18
19	\| 品牌 \| 入口 URL \|
20	\|------\|----------\|
21	\| 飞书 (Feishu) \| `https://open.feishu.cn/llms.txt` \|
22	\| Lark \| `https://open.larksuite.com/llms.txt` \|
23
24	> 所有文档以中文编写。如果用户使用英文交流，需将文档内容翻译为英文后输出。
25
26	## 挖掘流程
27
28	严格按以下步骤逐层检索，不要跳步或猜测 API：
29
30	### Step 1：确认现有能力不足
31
32	```bash
33	# 先检查是否已有对应的 skill 或已注册 API
34	lark-cli <可能的service> --help
35	```
36
37	如果已有对应命令或 shortcut，直接使用，不需要继续挖掘。
38
39	### Step 2：从顶层索引定位模块
40
41	用 WebFetch 获取顶层索引，找到与需求相关的模块文档链接：
42
43	```
44	WebFetch https://open.feishu.cn/llms.txt
45	→ 提取问题："列出所有模块文档链接，找出与 <用户需求关键词> 相关的链接"
46	```
47
48	- 飞书品牌使用 `open.feishu.cn`
49	- Lark 品牌使用 `open.larksuite.com`
50	- 如不确定用户品牌，默认使用飞书
51
52	### Step 3：从模块文档定位具体 API
53
54	用 WebFetch 获取模块文档，找到具体 API 的文档链接：
55
56	```
57	WebFetch https://open.feishu.cn/llms-docs/zh-CN/llms-<module>.txt
58	→ 提取问题："找出与 <用户需求> 相关的 API 说明和文档链接"
59	```
60
61	### Step 4：获取 API 完整规范
62
63	用 WebFetch 获取具体 API 文档，提取完整的调用规范：
64
65	```
66	WebFetch https://open.feishu.cn/document/server-docs/.../<api>.md
67	→ 提取问题："返回完整 API 规范：HTTP 方法、URL 路径、路径参数、查询参数、请求体字段（名称/类型/必填/说明）、响应字段、所需权限、错误码"
68	```
69
70	### Step 5：通过 CLI 调用 API
71
72	使用 `lark-cli api` 裸调：
73
74	```bash
75	# GET 请求
76	lark-cli api GET /open-apis/<path> --params '{"key":"value"}'
77
78	# POST 请求
79	lark-cli api POST /open-apis/<path> --data '{"key":"value"}'
80
81	# PUT 请求
82	lark-cli api PUT /open-apis/<path> --data '{"key":"value"}'
83
84	# DELETE 请求
85	lark-cli api DELETE /open-apis/<path>
86	```
87
88	## 输出规范
89
90	向用户呈现挖掘结果时，按以下格式组织：
91
92	1. API 名称与功能：一句话描述
93	2. HTTP 方法与路径：`METHOD /open-apis/...`
94	3. 关键参数：列出必填和常用可选参数
95	4. 所需权限：scope 列表
96	5. 调用示例：给出 `lark-cli api` 的完整命令
97	6. 注意事项：频率限制、特殊约束等
98
99	如果用户使用英文交流，将以上所有内容翻译为英文。
100
101	## 安全规则
102
103	- 写入/删除类 API（POST/PUT/DELETE）调用前必须确认用户意图
104	- 建议先用 `--dry-run` 预览请求（如支持）
105	- 不要猜测 API 路径或参数——必须从文档中获取确认
106	- 涉及敏感操作（删除群、移除成员等）时，向用户说明影响范围
107
108	## 使用场景示例
109
110	### 场景 1：用户需要拉人进群（未被 CLI 封装）
111
112	```bash
113	# Step 1: 确认 CLI 没有封装
114	lark-cli im --help
115	# → 发现没有 chat_members 相关的 create 命令
116
117	# Step 2-4: 通过文档挖掘获得 API 规范
118	# → POST /open-apis/im/v1/chats/:chat_id/members
119
120	# Step 5: 调用
121	lark-cli api POST /open-apis/im/v1/chats/oc_xxx/members \
122	--data '{"id_list":["ou_xxx","ou_yyy"]}' \
123	--params '{"member_id_type":"open_id"}'
124	```
125
126	### 场景 2：用户需要设置群公告
127
128	```bash
129	# Step 1: 确认 CLI 没有封装
130	lark-cli im --help
131	# → 没有 announcement 相关命令
132
133	# Step 2-4: 挖掘文档
134	# → PATCH /open-apis/im/v1/chats/:chat_id/announcement
135
136	# Step 5: 调用
137	lark-cli api PATCH /open-apis/im/v1/chats/oc_xxx/announcement \
138	--data '{"revision":"0","requests":["<html>公告内容</html>"]}'
139	```
140
141	## 参考
142
143	- [lark-shared](../lark-shared/SKILL.md) — 认证和全局参数
144	- [lark-skill-maker](../lark-skill-maker/SKILL.md) — 如需将挖掘到的 API 固化为新 Skill

People who liked this also viewed

6 picks

Type

lark-openapi-explorer

378kinstalls1.1kforks

View on GitHub

How to install lark-openapi-explorer?

larksuite/cli/lark-openapi-explorer

$npx -y skills add larksuite/cli --skill lark-openapi-explorer

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# OpenAPI Explorer
2
3	> 前置条件：先阅读 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md) 了解认证、身份切换和安全规则。
4
5	当用户的需求无法被现有 skill 或 CLI 已注册 API 覆盖时，使用本技能从飞书官方 markdown 文档库中逐层挖掘原生 OpenAPI 接口，然后通过 `lark-cli api` 裸调完成任务。
6
7	## 文档库结构
8
9	飞书 OpenAPI 文档以 markdown 层级组织：
10
11	```
12	llms.txt ← 顶层索引，列出所有模块文档链接
13	└─ llms-<module>.txt ← 模块文档，包含功能概述 + 底层 API 文档链接
14	└─ <api-doc>.md ← 单个 API 的完整说明（方法/路径/参数/响应/错误码）
15	```
16
17	文档入口：
18
19	\| 品牌 \| 入口 URL \|
20	\|------\|----------\|
21	\| 飞书 (Feishu) \| `https://open.feishu.cn/llms.txt` \|
22	\| Lark \| `https://open.larksuite.com/llms.txt` \|
23
24	> 所有文档以中文编写。如果用户使用英文交流，需将文档内容翻译为英文后输出。
25
26	## 挖掘流程
27
28	严格按以下步骤逐层检索，不要跳步或猜测 API：
29
30	### Step 1：确认现有能力不足
31
32	```bash
33	# 先检查是否已有对应的 skill 或已注册 API
34	lark-cli <可能的service> --help
35	```
36
37	如果已有对应命令或 shortcut，直接使用，不需要继续挖掘。
38
39	### Step 2：从顶层索引定位模块
40
41	用 WebFetch 获取顶层索引，找到与需求相关的模块文档链接：
42
43	```
44	WebFetch https://open.feishu.cn/llms.txt
45	→ 提取问题："列出所有模块文档链接，找出与 <用户需求关键词> 相关的链接"
46	```
47
48	- 飞书品牌使用 `open.feishu.cn`
49	- Lark 品牌使用 `open.larksuite.com`
50	- 如不确定用户品牌，默认使用飞书
51
52	### Step 3：从模块文档定位具体 API
53
54	用 WebFetch 获取模块文档，找到具体 API 的文档链接：
55
56	```
57	WebFetch https://open.feishu.cn/llms-docs/zh-CN/llms-<module>.txt
58	→ 提取问题："找出与 <用户需求> 相关的 API 说明和文档链接"
59	```
60
61	### Step 4：获取 API 完整规范
62
63	用 WebFetch 获取具体 API 文档，提取完整的调用规范：
64
65	```
66	WebFetch https://open.feishu.cn/document/server-docs/.../<api>.md
67	→ 提取问题："返回完整 API 规范：HTTP 方法、URL 路径、路径参数、查询参数、请求体字段（名称/类型/必填/说明）、响应字段、所需权限、错误码"
68	```
69
70	### Step 5：通过 CLI 调用 API
71
72	使用 `lark-cli api` 裸调：
73
74	```bash
75	# GET 请求
76	lark-cli api GET /open-apis/<path> --params '{"key":"value"}'
77
78	# POST 请求
79	lark-cli api POST /open-apis/<path> --data '{"key":"value"}'
80
81	# PUT 请求
82	lark-cli api PUT /open-apis/<path> --data '{"key":"value"}'
83
84	# DELETE 请求
85	lark-cli api DELETE /open-apis/<path>
86	```
87
88	## 输出规范
89
90	向用户呈现挖掘结果时，按以下格式组织：
91
92	1. API 名称与功能：一句话描述
93	2. HTTP 方法与路径：`METHOD /open-apis/...`
94	3. 关键参数：列出必填和常用可选参数
95	4. 所需权限：scope 列表
96	5. 调用示例：给出 `lark-cli api` 的完整命令
97	6. 注意事项：频率限制、特殊约束等
98
99	如果用户使用英文交流，将以上所有内容翻译为英文。
100
101	## 安全规则
102
103	- 写入/删除类 API（POST/PUT/DELETE）调用前必须确认用户意图
104	- 建议先用 `--dry-run` 预览请求（如支持）
105	- 不要猜测 API 路径或参数——必须从文档中获取确认
106	- 涉及敏感操作（删除群、移除成员等）时，向用户说明影响范围
107
108	## 使用场景示例
109
110	### 场景 1：用户需要拉人进群（未被 CLI 封装）
111
112	```bash
113	# Step 1: 确认 CLI 没有封装
114	lark-cli im --help
115	# → 发现没有 chat_members 相关的 create 命令
116
117	# Step 2-4: 通过文档挖掘获得 API 规范
118	# → POST /open-apis/im/v1/chats/:chat_id/members
119
120	# Step 5: 调用
121	lark-cli api POST /open-apis/im/v1/chats/oc_xxx/members \
122	--data '{"id_list":["ou_xxx","ou_yyy"]}' \
123	--params '{"member_id_type":"open_id"}'
124	```
125
126	### 场景 2：用户需要设置群公告
127
128	```bash
129	# Step 1: 确认 CLI 没有封装
130	lark-cli im --help
131	# → 没有 announcement 相关命令
132
133	# Step 2-4: 挖掘文档
134	# → PATCH /open-apis/im/v1/chats/:chat_id/announcement
135
136	# Step 5: 调用
137	lark-cli api PATCH /open-apis/im/v1/chats/oc_xxx/announcement \
138	--data '{"revision":"0","requests":["<html>公告内容</html>"]}'
139	```
140
141	## 参考
142
143	- [lark-shared](../lark-shared/SKILL.md) — 认证和全局参数
144	- [lark-skill-maker](../lark-skill-maker/SKILL.md) — 如需将挖掘到的 API 固化为新 Skill

People who liked this also viewed

6 picks

Type