@kickflow/mcp-server 0.1.8 → 1.0.0

package/README.md

@@ -51,150 +51,93 @@ MCPクライアント（Claude Desktop, Cursor, Clineなど）の構成ファイ
 
 ### 機能一覧
 
-このMCPサーバーは以下のツールをカテゴリ別に提供します:
+このMCPサーバーは3つの汎用ツールを提供し、kickflow APIのすべての機能にアクセスできます。
 
-#### Audit Logs
+#### discover_apis
 
-- `list_audit_logs`: 監査ログの一覧を取得します。
+利用可能なKickflow APIの一覧を表示します。`get_api_info`、`call_api`で使用する`operationId`を確認できます。
 
-#### Categories
+#### get_api_info
 
-- `list_categories`: カテゴリの一覧を取得します
-- `create_category`: カテゴリを作成します
-- `delete_category`: カテゴリを削除します
-- `update_category`: カテゴリを更新します
+指定した`operationId`のAPI情報をJSON Schemaで取得します。`call_api`を呼ぶ前に必要なパラメータを確認できます。
 
-#### Comments
+#### call_api
 
-- `list_comments`: チケットのコメント一覧を取得します
-- `create_comment`: チケットにコメントを投稿します
-- `get_comment`: チケットのコメントを取得します
-- `update_comment`: チケットのコメントを更新します
-- `delete_comment`: チケットのコメントを削除します
+Kickflow APIを実行します。`operationId`、`pathParams`、`queryParams`、`requestBody`をそれぞれ個別に指定してAPIを呼び出します。
 
-#### Folders
+### 使用例
 
-- `list_folders`: フォルダの一覧を取得します
-- `create_folder`: フォルダを作成します
-- `delete_folder`: フォルダを削除します
-- `update_folder`: フォルダを更新します
-- `get_folder`: フォルダを一件取得します
+#### 1. discover_apis でAPIの一覧を確認
 
-#### General Master Items
-
-- `list_general_master_items`: 汎用マスタアイテムの一覧を取得します
-- `create_general_master_item`: 汎用マスタアイテムを作成します
-- `get_general_master_item`: 汎用マスタアイテムを一件取得します
-- `update_general_master_item`: 汎用マスタアイテムを更新します
-- `delete_general_master_item`: 汎用マスタアイテムを削除します
-
-#### General Masters
-
-- `list_general_masters`: 汎用マスタの一覧を取得します
-- `create_general_master`: 汎用マスタを作成します
-- `get_general_master`: 汎用マスタを一件取得します
-- `update_general_master`: 汎用マスタを更新します
-- `delete_general_master`: 汎用マスタを削除します
-
-#### Grades
-
-- `list_grades`: 役職の一覧を取得します
-- `create_grade`: 役職を作成します
-- `get_grade`: 役職を一件取得します
-- `delete_grade`: 役職を削除します
-- `update_grade`: 役職を更新します
-- `set_default_grade`: 指定した役職をデフォルトにします
-
-#### Organization Charts
-
-- `list_organization_charts`: 組織図の一覧を取得します
-- `create_organization_chart`: 組織図を作成します
-- `delete_organization_chart`: 組織図を削除します
-- `get_organization_chart`: 組織図を一件取得します
-- `update_organization_chart`: 組織図を更新します
-- `get_current_organization_chart`: 現在有効になっている組織図を取得します
-- `activate_organization_chart`: 指定した組織図を有効化します
-
-#### Proxy Applicants
-
-- `list_proxy_applicants`: 代理申請の一覧を取得します
-- `create_proxy_applicant`: 代理申請を作成します
-- `delete_proxy_applicant`: 指定した代理申請を削除します
-
-#### Proxy Approvers
-
-- `list_proxy_approvers`: 代理承認の一覧を取得します
-- `create_proxy_approver`: 代理承認を作成します
-- `delete_proxy_approver`: 指定した代理承認を削除します
+結果例:
+```text
+listCategories: カテゴリの一覧を取得
+createCategory: カテゴリを作成
+getTicket: チケットを取得
+...
+```
 
-#### Roles
+#### 2. get_api_info で必要なパラメータを確認
 
-- `list_roles`: 管理者ロールの一覧を取得します
-- `create_role`: 管理者ロールを作成します
-- `get_role`: 管理者ロールを一件取得します
-- `update_role`: 管理者ロールを更新します
-- `delete_role`: 管理者ロールを削除します
-- `create_role_members`: 管理者ロールにメンバーを追加します
-- `list_role_members`: 管理者ロールのメンバー一覧を取得します
-- `delete_role_member`: 管理者ロールからメンバーを削除します
+入力例:
+```json
+{
+  "operationId": "getTicket"
+}
+```
 
-#### Routes
+結果例:
+```json
+{
+  "pathParams": {
+    "type": "object",
+    "properties": {
+      "ticketId": { "type": "string", "format": "uuid" }
+    },
+    "required": ["ticketId"]
+  }
+}
+```
 
-- `list_routes`: 経路の一覧を取得します
-- `get_route`: 指定した経路を取得します
+#### 3. call_api でAPIを実行
 
-#### Teams
+パラメータなしの例:
+```json
+{
+  "operationId": "listCategories"
+}
+```
 
-- `list_teams`: 指定した組織図内のチーム一覧を取得します
-- `create_team`: 指定した組織図内にチームを作成します
-- `get_team`: チームを一件取得します
-- `update_team`: チームを編集します
-- `delete_team`: チームを削除します
-- `list_team_members`: チームのメンバー一覧を取得します
-- `create_team_members`: 指定したチームにメンバーを追加します
-- `delete_team_members`: 指定したチームからメンバーを削除します
-- `update_team_member`: チームのメンバーを更新します
+パスパラメータありの例:
+```json
+{
+  "operationId": "getTicket",
+  "pathParams": {
+    "ticketId": "550e8400-e29b-41d4-a716-446655440000"
+  }
+}
+```
 
-#### Ticket Links
+クエリパラメータありの例:
+```json
+{
+  "operationId": "listTickets",
+  "queryParams": {
+    "page": 1,
+    "perPage": 25
+  }
+}
+```
 
-- `list_ticket_links`: 指定したチケットの関連チケットを取得します
-
-#### Tickets
-
-- `get_ticket`: 指定したチケットの詳細情報を取得します
-- `list_tickets`: チケットの一覧を取得します
-- `approve_ticket`: チケットを承認または確認します
-- `reject_ticket`: チケットを差し戻します
-- `deny_ticket`: チケットを却下します
-- `withdraw_ticket`: 自分が作成したチケットを取り下げます
-- `archive_ticket`: チケットをアーカイブします
-- `list_tasks`: 承認リクエスト一覧を取得します
-
-#### Users
-
-- `get_current_user`: 現在のユーザーを取得します
-- `list_users`: ユーザー一覧を取得します
-- `create_user`: ユーザーを作成（招待）します
-- `get_user`: ユーザーを一件取得します
-- `delete_user`: ユーザーを削除します
-- `update_user`: ユーザーを更新します
-- `lookup_user_by_email`: メールアドレスからユーザーを取得します
-- `reinvite_user`: 削除されたユーザーを再び招待します
-- `suspend_user`: 有効なユーザーを一時停止します
-- `reactivate_user`: 一時停止中のユーザーを有効化します
-- `list_user_teams`: ユーザーの所属チーム一覧を取得します
-- `list_user_roles`: ユーザーの管理者ロール一覧を取得します
-
-#### Viewers
-
-- `list_viewers`: チケットの共有ユーザー一覧を取得します
-- `create_viewer`: チケットに共有ユーザーを追加します
-- `delete_viewer`: チケットの共有ユーザーを削除します
-
-#### Workflows
-
-- `list_workflows`: ワークフローの一覧を取得します
-- `get_workflow`: 指定したワークフローを取得します
+リクエストボディありの例:
+```json
+{
+  "operationId": "createCategory",
+  "requestBody": {
+    "name": "新しいカテゴリ"
+  }
+}
+```
 
 ---
 

package/dist/kickflow-api/generated/api-definitions.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval-hook.js
+ * Do not edit manually.
+ */
+export interface PathParamInfo {
+    name: string;
+    type: string;
+    required: boolean;
+    description?: string;
+    format?: string;
+    pattern?: string;
+}
+export interface ApiDefinition {
+    operationId: string;
+    summary: string;
+    pathParams: PathParamInfo[];
+}
+export declare const apiDefinitions: ApiDefinition[];
+export declare function findApiByOperationId(operationId: string): ApiDefinition | undefined;