Feishu MCP Server

🚀 FeiShu Project Documentation

This is a toolkit for integrating with FeiShu, supporting the development of multiple functional modules.

🚀 Quick Start

📦 Installation

npm install @feishu/abc123

💻 Usage Examples

Basic Usage

Initialization Configuration

import { FeiShuClient } from '@feishu/core';

const config: ClientConfig = {
  appId: 'your_app_id',
  appSecret: 'your_app_secret'
};

const client = new FeiShuClient(config);

Advanced Usage

Sending Text Messages

await client.sendMessage('open_chat_id', 'hello world');

Sending Card Messages

const card = {
  type: 'message_card',
  content: [{
    type: 'text',
    text: 'Card content'
  }]
};

await client.sendCardMessage('open_chat_id', card);

✨ Features

Message Sending

• Send text messages
• Send card messages

🔧 Technical Details

Error Handling

All API request errors will be wrapped by the FeiShuApiError class:

try {
  // Perform API operations
} catch (error) {
  if (error instanceof FeiShuApiError) {
    // Handle specific API errors
    console.error(`FeiShu API error (${error.code}): ${error.message}`);
  } else {
    // Handle general errors
    console.error('Unexpected error:', error);
  }
  // Convert to a user-friendly message
  throw new FeiShuApiError('Operation failed', { cause: error });
}

Extension Guide

Steps to Add New Features

1. Create a Client Class Create a new client class in the src/client/feature/ directory:

   // src/client/feature/feature-client.ts
   export class FeatureClient extends ApiClient {
     async getFeatureData(id: string): Promise<FeatureData> {
       return this.request<FeatureResponse>('/feature/get', { id });
     }
   }
   

2. Create a Service Class Create a new service class in the src/services/feature/ directory:

   // src/services/feature/feature-service.ts
   export class FeatureService {
     private client: FeatureClient;
     
     constructor(config: ApiClientConfig) {
       this.client = new FeatureClient(config);
     }
     
     async getFeature(id: string): Promise<Feature> {
       try {
         const data = await this.client.getFeatureData(id);
         return this.transformData(data);
       } catch (error) {
         handleError(error);
       }
     }
   }
   

3. Register the Service Export the new service in src/services/index.ts:

   // src/services/index.ts
   export { FeatureService } from './feature/feature-service';
   

4. Create an MCP Tool Create a tool function in src/server/tools/feature-tools.ts:

   // src/server/tools/feature-tools.ts
   export function createFeatureTool() {
     return {
       getFeature: async (id: string) => {
         const service = new FeatureService({ /* Configuration */ });
         return await service.getFeature(id);
       }
     };
   }
   

5. Use the New Feature

   import { createFeatureTool } from './tools/feature-tools';
   
   const tool = createFeatureTool();
   await tool.getFeature('123');
   

🤝 Contribution Guidelines

Code Submission Standards

Please follow the following submission standards:

1. Each commit must have a clear commit message.
2. Keep the code format consistent.
3. Pass all test cases before submitting.

Creating New Functional Modules

1. Create a new component under src/components/.
2. Implement the component logic.
3. Integrate the component on the example page.

📄 Error Handling

Please refer to the error handling documentation: Error Handling Guide

📁 Project Structure

project/
├── src/
│   ├── client/
│   │   └── feature/
│   │       └── feature-client.ts
│   └── services/
│       └── feature/
│           └── feature-service.ts
└── tools/
    └── feature-tools.ts

📄 License

This project is licensed under the MIT license.

The above is the complete documentation guide for this project, covering various aspects such as installation, usage, development, and error handling.