Lark

🚀 Lark MCP Server

An MCP (Model Context Protocol) server integrating Lark API, enabling LLMs to interact with Lark services.

🚀 Quick Start

The Lark MCP Server is an MCP server integrating Lark API, which allows LLMs to interact with Lark services. It offers features like querying employee information using Lark's contact API.

✨ Features

• Query employee information using Lark's contact API.
• More features are coming soon...

📦 Installation

Prerequisites

• Node.js 16 or higher.
• A Lark application with an App ID and App Secret.
• Claude for Desktop or other MCP clients.

Steps

npm install
npm run build

💻 Usage Examples

Basic Usage

You can run the server in two ways:

1. Using Command-line Arguments (Recommended)

npx lark-mcp <app_id> <app_secret>

Replace <app_id> and <app_secret> with the credentials of your Lark application.

2. Using Environment Variables

export LARK_APP_ID=your_app_id
export LARK_APP_SECRET=your_app_secret
npx lark-mcp

Advanced Usage

get-user-info

Query employee information based on the employee ID.

Example usage in Claude:

Please query the information of the employee with ID 12345

📚 Documentation

Development

1. Clone the repository.
2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

4. Start the development server:

   npm run dev
   

Configuration

The server prioritizes using credentials in the following order:

1. Command-line arguments
2. Environment variables
3. Default values (if any)

Error Handling

• The server validates credentials before starting.
• API errors are handled properly and returned to the client.
• Detailed error information helps with troubleshooting.

📄 License

MIT

🤝 Contribution Guidelines

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to the branch.
5. Create a new Pull Request.