Feishu MCP Server

🚀 FeiShu プロジェクトドキュメント

このプロジェクトは、FeiShu（飞书）と統合するためのツールキットで、様々な機能モジュールの開発をサポートしています。

🚀 クイックスタート

📦 インストール

依存関係のインストール

npm install @feishu/abc123

💻 使用例

基本的な使用法

初期化設定

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

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

const client = new FeiShuClient(config);

高度な使用法

メッセージ送信

テキストメッセージの送信

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

カードメッセージの送信

const card = {
  type: 'message_card',
  content: [{
    type: 'text',
    text: '卡片内容'
  }]
};

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

エラー処理

すべての API リクエストエラーは FeiShuApiError クラスでラップされます。

try {
  // 执行 API 操作
} catch (error) {
  if (error instanceof FeiShuApiError) {
    // 特定の API エラーを処理
    console.error(`飞书 API 错误 (${error.code}): ${error.message}`);
  } else {
    // 一般的なエラーを処理
    console.error('意外错误:', error);
  }
  // ユーザーフレンドリーなメッセージに変換
  throw new FeiShuApiError('操作失败', { cause: error });
}

拡張ガイド

新機能の追加手順

1. クライアントクラスの作成 src/client/feature/ ディレクトリに新しいクライアントクラスを作成します。

// 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. サービスクラスの作成 src/services/feature/ ディレクトリに新しいサービスクラスを作成します。

// 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. サービスの登録 src/services/index.ts で新しいサービスをエクスポートします。

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

4. MCP ツールの作成 src/server/tools/feature-tools.ts でツール関数を作成します。

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

5. 新機能の使用

import { createFeatureTool } from './tools/feature-tools';

const tool = createFeatureTool();
await tool.getFeature('123');

貢献ガイド

コードの提出規範

以下の提出規範に従ってください。

1. 各コミットには明確なコミットメッセージが必要です。
2. コードフォーマットを統一してください。
3. 提出前にすべてのテストケースを通過させてください。

新機能モジュールの作成

1. src/components/ の下に新しいコンポーネントを作成します。
2. コンポーネントのロジックを実装します。
3. サンプルページにコンポーネントを統合します。

エラー処理

エラー処理のドキュメントを参照してください：エラー処理ガイド

プロジェクト構造

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

📄 ライセンス

このプロジェクトは MIT ライセンスに従います。