Fillout MCP Server

🚀 Fillout.io MCP サーバー

Fillout.io API 用の MCP サーバーで、フォーム管理、レスポンス処理、分析をサポートします。

🚀 クイックスタート

このサーバーは Fillout.io API 用の MCP サーバーで、フォーム管理、レスポンス処理、分析などの機能を提供します。

✨ 主な機能

• フォーム管理：フォームの作成、読み取り、更新、削除が可能です。
• レスポンス処理：レスポンスデータの送信、取得、修正、削除を行えます。
• ユーザー認証：複数の認証方法を統合しています。
• データ分析：フォームの入力状況を統計します。
• イベントトリガー：フォーム完了後のカスタム操作を設定できます。

📦 インストール

インストールと実行

# 依存関係のインストール
npm install

# 開発モードで起動
npm run dev

# 本番用バージョンのビルド
npm run build

Docker デプロイ

# イメージのビルド
docker build -t mcp/fillout .

# コンテナの実行
docker run -e FILLOUT_API_KEY=your-key mcp/fillout

💻 使用例

基本的な使用法

フォームの作成

const form = await client.createForm({
  name: "客户反馈",
  description: "分享您的体验",
  questions: [
    {
      type: "ShortAnswer",
      name: "您最喜欢的部分是什么？",
      required: true
    },
    {
      type: "MultipleChoice",
      name: "您会推荐我们吗？",
      required: true,
      choices: ["是", "否", "可能"]
    }
  ]
});

レスポンスの送信

const response = await client.submitFormResponse(formId, {
  responses: [
    {
      questionId: "q1",
      value: "一流的客户服务！"
    },
    {
      questionId: "q2",
      value: "是"
    }
  ]
});

高度な使用法

エラー処理

try {
  const forms = await client.listForms();
} catch (error) {
  if (error instanceof AuthenticationError) {
    // 無効な API キーの処理
  } else if (error instanceof FilloutError) {
    // API 固有のエラーの処理
  } else {
    // 予期しないエラーの処理
  }
}

📚 ドキュメント

トークン設定

1. Fillout.io API キーを取得します。

   • Fillout.io アカウントにログインします。
   • アカウント設定 → API と Webhook に移動します。
   • 「新しい API キーを作成」をクリックします。
   • 新しい API キーをコピーします。

2. API キーの情報：

   • 本番用キーは fo_live_ で始まります。
   • テスト用キーは fo_test_ で始まります。
   • テスト用キーはテストフォームにのみ使用できます。
   • API キーはアカウント内のすべてのリソースへのアクセス権を提供します。

3. 設定ファイル内の your-fillout-api-key を自分の API キーに置き換えます。

⚠️ 重要提示

• API キーを安全かつ秘密に保管してください。
• 開発にはテスト用キーを使用してください。
• キーを環境変数に保存してください。
• コード内にキーをハードコードしないでください。
• 定期的にキーを更新し、ローテーションしてください。

トラブルシューティング

一般的なエラーと解決策：

1. 無効な API キー

   • キーが正しいことを確認してください。
   • 大文字と小文字が区別されるかどうかを確認してください（API は大文字と小文字を区別する場合があります）。
   • キーが期限切れでないことを確認してください。

2. ネットワーク接続の問題

   • ネットワークが正常に動作していることを確認してください。
   • API サービスエンドポイントに到達可能であることを確認してください。
   • パケットキャプチャツールを使用してリクエストとレスポンスを確認してください。

3. 権限不足

   • キーが必要な権限を持っていることを確認してください。
   • 管理者にキーの権限設定を確認してもらってください。
   • API ドキュメントを参照して、操作に追加の権限が必要かどうかを確認してください。

4. レート制限

   • しばらく待ってから再試行してください。
   • キューイングまたはレート制御メカニズムを使用してください。
   • サポートに連絡してクォータを増やしてもらってください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。