lark-openapi-explorer

Original：🇨🇳 Chinese

Translated

Feishu/Lark Native OpenAPI Exploration: Uncover native OpenAPI interfaces that are not encapsulated by CLI from the official document library. Use this when users' requirements cannot be met by existing lark-* skills or registered commands in lark-cli, and they need to find and call native Feishu OpenAPIs.

1.4kinstalls

Sourcelarksuite/cli

Added on2026-03-28

NPX Install

npx skill4agent add larksuite/cli lark-openapi-explorer

SKILL.md Content (Chinese)

View Translation Comparison →

OpenAPI Explorer

Prerequisites: First read
../lark-shared/SKILL.md
to understand authentication, identity switching and security rules.

When users' requirements cannot be covered by existing skills or registered APIs in CLI, use this skill to layer-by-layer explore native OpenAPI interfaces from Feishu's official markdown document library, then complete tasks by directly calling them via

lark-cli api

.

Document Library Structure

Feishu OpenAPI documents are organized in a markdown hierarchy:

llms.txt                          ← Top-level index, listing links to all module documents
  └─ llms-<module>.txt            ← Module document, including function overview + links to underlying API documents
       └─ <api-doc>.md            ← Complete description of a single API (method/path/parameters/response/error codes)

Document Entry Points:

Brand	Entry URL
Feishu	`https://open.feishu.cn/llms.txt`
Lark	`https://open.larksuite.com/llms.txt`

All documents are written in Chinese. If users communicate in English, translate the document content to English before outputting.

Exploration Process

Strictly follow the steps below to retrieve layer by layer, do not skip steps or guess APIs:

Step 1: Confirm Existing Capabilities Are Insufficient

bash

# First check if there is a corresponding skill or registered API
lark-cli <possible-service> --help

If there is a corresponding command or shortcut, use it directly, no need to continue exploration.

Step 2: Locate Modules from Top-level Index

Use WebFetch to get the top-level index, find links to module documents related to the requirements:

WebFetch https://open.feishu.cn/llms.txt
  → Extraction question: "List all module document links and find those related to <user requirement keywords>"

Use
```
open.feishu.cn
```
for Feishu brand
Use
```
open.larksuite.com
```
for Lark brand
Default to Feishu if the user's brand is uncertain

Step 3: Locate Specific APIs from Module Documents

Use WebFetch to get the module document, find the document link of the specific API:

WebFetch https://open.feishu.cn/llms-docs/zh-CN/llms-<module>.txt
  → Extraction question: "Find API descriptions and document links related to <user requirement>"

Step 4: Obtain Complete API Specifications

Use WebFetch to get the specific API document, extract the complete calling specifications:

WebFetch https://open.feishu.cn/document/server-docs/.../<api>.md
  → Extraction question: "Return complete API specifications: HTTP method, URL path, path parameters, query parameters, request body fields (name/type/required/description), response fields, required permissions, error codes"

Step 5: Call APIs via CLI

Use

lark-cli api

for direct calls:

bash

# GET request
lark-cli api GET /open-apis/<path> --params '{"key":"value"}'

# POST request
lark-cli api POST /open-apis/<path> --data '{"key":"value"}'

# PUT request
lark-cli api PUT /open-apis/<path> --data '{"key":"value"}'

# DELETE request
lark-cli api DELETE /open-apis/<path>

Output Specifications

When presenting exploration results to users, organize them in the following format:

API Name & Function: One-sentence description
HTTP Method & Path:
```
METHOD /open-apis/...
```
Key Parameters: List required and commonly used optional parameters
Required Permissions: List of scopes
Call Example: Provide the complete
```
lark-cli api
```
command
Notes: Rate limits, special constraints, etc.

If users communicate in English, translate all the above content to English.

Security Rules

Write/Delete APIs (POST/PUT/DELETE): Must confirm the user's intent before calling
It is recommended to use
```
--dry-run
```
to preview the request first (if supported)
Do not guess API paths or parameters — must obtain confirmation from documents
When involving sensitive operations (such as deleting groups, removing members, etc.), explain the scope of impact to the user

Usage Scenario Examples

Scenario 1: User needs to add someone to a group (not encapsulated by CLI)

bash

# Step 1: Confirm CLI has no encapsulation
lark-cli im --help
# → Found no create command related to chat_members

# Step 2-4: Obtain API specifications via document exploration
# → POST /open-apis/im/v1/chats/:chat_id/members

# Step 5: Call the API
lark-cli api POST /open-apis/im/v1/chats/oc_xxx/members \
  --data '{"id_list":["ou_xxx","ou_yyy"]}' \
  --params '{"member_id_type":"open_id"}'

Scenario 2: User needs to set group announcements

bash

# Step 1: Confirm CLI has no encapsulation
lark-cli im --help
# → No commands related to announcement

# Step 2-4: Explore documents
# → PATCH /open-apis/im/v1/chats/:chat_id/announcement

# Step 5: Call the API
lark-cli api PATCH /open-apis/im/v1/chats/oc_xxx/announcement \
  --data '{"revision":"0","requests":["<html>Announcement content</html>"]}'

References

lark-shared — Authentication and global parameters
lark-skill-maker — If you need to solidify the explored API into a new Skill

lark-openapi-explorer

NPX Install

Tags

SKILL.md Content (Chinese)

OpenAPI Explorer

Document Library Structure

Exploration Process

Step 1: Confirm Existing Capabilities Are Insufficient

Step 2: Locate Modules from Top-level Index

Step 3: Locate Specific APIs from Module Documents

Step 4: Obtain Complete API Specifications

Step 5: Call APIs via CLI

Output Specifications

Security Rules

Usage Scenario Examples

Scenario 1: User needs to add someone to a group (not encapsulated by CLI)

Scenario 2: User needs to set group announcements

References