logo
0
0
WeChat Login
chenli.idevlab<chenli.idevlab@bytedance.com>
doc: new docs

Feishu/Lark Open Platform Developer Documentation Retrieval MCP

npm version npm downloads Node.js Version

English | 中文

⚠️ Beta Version Notice: This tool is currently in Beta. Features and APIs may change, so please pay close attention to version updates.

This is the Feishu/Lark official Open Platform Developer Documentation Retrieval MCP (Model Context Protocol) tool, designed to help users quickly find the documentation they need after entering their requirements. It can also be used with Feishu/Lark OpenAPI MCP to enable AI assistants to run automated scenarios.

The scope of documentation retrieval covers all developer guides, tutorials, server-side APIs, and client-side APIs under the Developer Documentation or Lark Developer Documentation, helping users quickly find the corresponding OpenAPI or other developer documentation. It does not search "Lark Docs" documents.

Getting Started

Install Node.js

Before using the lark-mcp tool, you need to install the Node.js environment. If you have already installed Node.js, you can skip this step.

  1. Install with Homebrew (Recommended):

    brew install node
  2. Use the official installer:

    • Visit the Node.js official website
    • Download and install the LTS version
    • After installation, open the terminal to verify:
      node -v npm -v

Install Node.js on Windows

  1. Use the official installer:

    • Visit the Node.js official website
    • Download and run the Windows installer (.msi file)
    • Follow the installation wizard to complete the installation
    • After installation, open the command prompt to verify:
      node -v npm -v
  2. Use nvm-windows:

    • Download nvm-windows
    • Install nvm-windows
    • Use nvm to install Node.js:
      nvm install latest nvm use <version>

Installation

Install the lark-mcp tool globally:

npm install -g @larksuiteoapi/lark-mcp

User Guide

Use in Trae/Cursor/Claude

To integrate Lark features in AI tools such as Trae, Cursor or Claude, you can install using the button below.

Install MCP Server

Install MCP Server Install MCP Server

or you can add the following to your configuration file:

{ "mcpServers": { "lark-mcp": { "command": "npx", "args": [ "-y", "@larksuiteoapi/lark-mcp", "recall-developer-documents", ] } } }

Advanced Configuration

Command Line Arguments

The lark-mcp recall-developer-documents tool provides a variety of command line arguments for flexible MCP service configuration:

ParameterShortDescriptionExample
--mode-mTransfer mode, options are stdio or streamable or sse, default is stdio-m sse
--hostListening host in SSE\Streamable mode, default is localhost--host 0.0.0.0
--port-pListening port in SSE\Streamable mode, default is 3000-p 3000
--version-VShow version number-V
--help-hShow help information-h

Example Usage of Arguments

  1. Transfer Modes

    recall-developer-documents supports two transfer modes:

    1. stdio mode (default/recommended): Suitable for integration with AI tools such as Cursor or Claude, communicating via standard input and output streams.
    lark-mcp recall-developer-documents -m stdio
    1. SSE mode: Provides an HTTP interface based on Server-Sent Events, suitable for web applications or scenarios requiring a network interface.
    # By default, only listens on localhost lark-mcp recall-developer-documents -m sse -p 3000 # Listen on all network interfaces (allow remote access) lark-mcp recall-developer-documents -m sse --host 0.0.0.0 -p 3000

    After starting, the SSE endpoint can be accessed at http://<host>:<port>/sse.

Related Links

Feedback

You are welcome to submit Issues to help improve this tool. If you have any questions or suggestions, please raise them in the GitHub repository.