@danyow/lark-mcp 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +62 -0
- package/LICENSE +9 -0
- package/README.md +215 -0
- package/README_ZH.md +212 -0
- package/dist/auth/config.d.ts +12 -0
- package/dist/auth/config.js +15 -0
- package/dist/auth/handler/handler-local.d.ts +21 -0
- package/dist/auth/handler/handler-local.js +123 -0
- package/dist/auth/handler/handler.d.ts +32 -0
- package/dist/auth/handler/handler.js +117 -0
- package/dist/auth/handler/index.d.ts +2 -0
- package/dist/auth/handler/index.js +18 -0
- package/dist/auth/index.d.ts +4 -0
- package/dist/auth/index.js +20 -0
- package/dist/auth/provider/index.d.ts +3 -0
- package/dist/auth/provider/index.js +19 -0
- package/dist/auth/provider/oauth.d.ts +18 -0
- package/dist/auth/provider/oauth.js +147 -0
- package/dist/auth/provider/oidc.d.ts +18 -0
- package/dist/auth/provider/oidc.js +172 -0
- package/dist/auth/provider/types.d.ts +8 -0
- package/dist/auth/provider/types.js +2 -0
- package/dist/auth/store.d.ts +39 -0
- package/dist/auth/store.js +213 -0
- package/dist/auth/types.d.ts +13 -0
- package/dist/auth/types.js +2 -0
- package/dist/auth/utils/encryption.d.ts +7 -0
- package/dist/auth/utils/encryption.js +40 -0
- package/dist/auth/utils/index.d.ts +3 -0
- package/dist/auth/utils/index.js +19 -0
- package/dist/auth/utils/is-token-valid.d.ts +7 -0
- package/dist/auth/utils/is-token-valid.js +28 -0
- package/dist/auth/utils/pkce.d.ts +6 -0
- package/dist/auth/utils/pkce.js +20 -0
- package/dist/auth/utils/storage-manager.d.ts +17 -0
- package/dist/auth/utils/storage-manager.js +135 -0
- package/dist/cli/index.d.ts +1 -0
- package/dist/cli/index.js +5 -0
- package/dist/cli/login-handler.d.ts +16 -0
- package/dist/cli/login-handler.js +142 -0
- package/dist/cli.d.ts +4 -0
- package/dist/cli.js +122 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +19 -0
- package/dist/mcp-server/index.d.ts +2 -0
- package/dist/mcp-server/index.js +18 -0
- package/dist/mcp-server/shared/index.d.ts +2 -0
- package/dist/mcp-server/shared/index.js +18 -0
- package/dist/mcp-server/shared/init.d.ts +10 -0
- package/dist/mcp-server/shared/init.js +121 -0
- package/dist/mcp-server/shared/types.d.ts +40 -0
- package/dist/mcp-server/shared/types.js +10 -0
- package/dist/mcp-server/transport/index.d.ts +3 -0
- package/dist/mcp-server/transport/index.js +19 -0
- package/dist/mcp-server/transport/sse.d.ts +2 -0
- package/dist/mcp-server/transport/sse.js +75 -0
- package/dist/mcp-server/transport/stdio.d.ts +2 -0
- package/dist/mcp-server/transport/stdio.js +36 -0
- package/dist/mcp-server/transport/streamable.d.ts +2 -0
- package/dist/mcp-server/transport/streamable.js +86 -0
- package/dist/mcp-server/transport/utils.d.ts +16 -0
- package/dist/mcp-server/transport/utils.js +34 -0
- package/dist/mcp-tool/constants.d.ts +49 -0
- package/dist/mcp-tool/constants.js +115 -0
- package/dist/mcp-tool/document-tool/index.d.ts +1 -0
- package/dist/mcp-tool/document-tool/index.js +17 -0
- package/dist/mcp-tool/document-tool/recall/index.d.ts +2 -0
- package/dist/mcp-tool/document-tool/recall/index.js +39 -0
- package/dist/mcp-tool/document-tool/recall/request.d.ts +2 -0
- package/dist/mcp-tool/document-tool/recall/request.js +25 -0
- package/dist/mcp-tool/document-tool/recall/type.d.ts +19 -0
- package/dist/mcp-tool/document-tool/recall/type.js +2 -0
- package/dist/mcp-tool/index.d.ts +5 -0
- package/dist/mcp-tool/index.js +21 -0
- package/dist/mcp-tool/mcp-tool.d.ts +52 -0
- package/dist/mcp-tool/mcp-tool.js +198 -0
- package/dist/mcp-tool/tools/en/builtin-tools/docx/builtin.d.ts +5 -0
- package/dist/mcp-tool/tools/en/builtin-tools/docx/builtin.js +219 -0
- package/dist/mcp-tool/tools/en/builtin-tools/drive/builtin.d.ts +4 -0
- package/dist/mcp-tool/tools/en/builtin-tools/drive/builtin.js +159 -0
- package/dist/mcp-tool/tools/en/builtin-tools/im/buildin.d.ts +4 -0
- package/dist/mcp-tool/tools/en/builtin-tools/im/buildin.js +63 -0
- package/dist/mcp-tool/tools/en/builtin-tools/index.d.ts +5 -0
- package/dist/mcp-tool/tools/en/builtin-tools/index.js +7 -0
- package/dist/mcp-tool/tools/en/gen-tools/index.d.ts +114 -0
- package/dist/mcp-tool/tools/en/gen-tools/index.js +129 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/acs_v1.d.ts +562 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/acs_v1.js +264 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/admin_v1.d.ts +912 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/admin_v1.js +449 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/aily_v1.d.ts +1213 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/aily_v1.js +560 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/apaas_v1.d.ts +2530 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/apaas_v1.js +949 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/application_v5.d.ts +80 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/application_v5.js +53 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/application_v6.d.ts +1008 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/application_v6.js +775 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/approval_v4.d.ts +3928 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/approval_v4.js +1602 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/attendance_v1.d.ts +6043 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/attendance_v1.js +1857 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/auth_v3.d.ts +151 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/auth_v3.js +71 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/authen_v1.d.ts +26 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/authen_v1.js +17 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/baike_v1.d.ts +2174 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/baike_v1.js +594 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/base_v2.d.ts +755 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/base_v2.js +234 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/bitable_v1.d.ts +3541 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/bitable_v1.js +1786 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/board_v1.d.ts +40 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/board_v1.js +18 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/calendar_v4.d.ts +2075 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/calendar_v4.js +1594 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/cardkit_v1.d.ts +528 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/cardkit_v1.js +260 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/compensation_v1.d.ts +189 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/compensation_v1.js +132 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/contact_v3.d.ts +4274 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/contact_v3.js +2583 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/corehr_v1.d.ts +16873 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/corehr_v1.js +5045 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/corehr_v2.d.ts +29387 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/corehr_v2.js +7787 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/directory_v1.d.ts +4274 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/directory_v1.js +1367 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/docs_v1.d.ts +58 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/docs_v1.js +28 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/docx_v1.d.ts +93466 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/docx_v1.js +14350 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/drive_v1.d.ts +3251 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/drive_v1.js +1422 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/drive_v2.d.ts +174 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/drive_v2.js +117 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/ehr_v1.d.ts +86 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/ehr_v1.js +48 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/event_v1.d.ts +44 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/event_v1.js +17 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/helpdesk_v1.d.ts +733 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/helpdesk_v1.js +285 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/hire_v1.d.ts +10076 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/hire_v1.js +6065 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/hire_v2.d.ts +158 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/hire_v2.js +61 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/human_authentication_v1.d.ts +70 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/human_authentication_v1.js +27 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/im_v1.d.ts +3043 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/im_v1.js +1869 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/im_v2.d.ts +2176 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/im_v2.js +460 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/lingo_v1.d.ts +2301 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/lingo_v1.js +669 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mail_v1.d.ts +2462 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mail_v1.js +1655 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mdm_v1.d.ts +104 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mdm_v1.js +45 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mdm_v3.d.ts +329 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/mdm_v3.js +78 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/minutes_v1.d.ts +92 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/minutes_v1.js +62 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/moments_v1.d.ts +52 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/moments_v1.js +24 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/okr_v1.d.ts +1628 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/okr_v1.js +434 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/optical_char_recognition_v1.d.ts +38 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/optical_char_recognition_v1.js +17 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/passport_v1.d.ts +131 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/passport_v1.js +59 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/payroll_v1.d.ts +333 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/payroll_v1.js +176 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/performance_v1.d.ts +309 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/performance_v1.js +178 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/performance_v2.d.ts +1177 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/performance_v2.js +559 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/personal_settings_v1.d.ts +640 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/personal_settings_v1.js +303 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/report_v1.d.ts +192 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/report_v1.js +71 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/search_v2.d.ts +1695 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/search_v2.js +446 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/security_and_compliance_v1.d.ts +68 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/security_and_compliance_v1.js +32 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/sheets_v2.d.ts +523 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/sheets_v2.js +231 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/sheets_v3.d.ts +979 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/sheets_v3.js +721 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/speech_to_text_v1.d.ts +225 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/speech_to_text_v1.js +65 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/task_v1.d.ts +1161 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/task_v1.js +672 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/task_v2.d.ts +6051 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/task_v2.js +1970 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/tenant_v2.d.ts +31 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/tenant_v2.js +24 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/translation_v1.d.ts +80 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/translation_v1.js +37 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/trust_party_v1.d.ts +182 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/trust_party_v1.js +141 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/vc_v1.d.ts +5725 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/vc_v1.js +1751 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/verification_v1.d.ts +21 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/verification_v1.js +14 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/wiki_v1.d.ts +72 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/wiki_v1.js +19 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/wiki_v2.d.ts +843 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/wiki_v2.js +381 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/workplace_v1.d.ts +116 -0
- package/dist/mcp-tool/tools/en/gen-tools/zod/workplace_v1.js +77 -0
- package/dist/mcp-tool/tools/index.d.ts +104 -0
- package/dist/mcp-tool/tools/index.js +9 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/docx/builtin.d.ts +5 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/docx/builtin.js +198 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/drive/builtin.d.ts +4 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/drive/builtin.js +159 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/im/buildin.d.ts +4 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/im/buildin.js +63 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/index.d.ts +5 -0
- package/dist/mcp-tool/tools/zh/builtin-tools/index.js +7 -0
- package/dist/mcp-tool/tools/zh/gen-tools/index.d.ts +114 -0
- package/dist/mcp-tool/tools/zh/gen-tools/index.js +129 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/acs_v1.d.ts +562 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/acs_v1.js +277 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/admin_v1.d.ts +912 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/admin_v1.js +430 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/aily_v1.d.ts +1213 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/aily_v1.js +541 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/apaas_v1.d.ts +2530 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/apaas_v1.js +885 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/application_v5.d.ts +80 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/application_v5.js +59 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/application_v6.d.ts +1007 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/application_v6.js +721 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/approval_v4.d.ts +3928 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/approval_v4.js +1532 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/attendance_v1.d.ts +6043 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/attendance_v1.js +1620 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/auth_v3.d.ts +151 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/auth_v3.js +87 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/authen_v1.d.ts +26 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/authen_v1.js +17 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/baike_v1.d.ts +2174 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/baike_v1.js +574 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/base_v2.d.ts +755 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/base_v2.js +270 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/bitable_v1.d.ts +3541 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/bitable_v1.js +1864 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/board_v1.d.ts +40 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/board_v1.js +18 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/calendar_v4.d.ts +2075 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/calendar_v4.js +1533 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/cardkit_v1.d.ts +528 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/cardkit_v1.js +248 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/compensation_v1.d.ts +189 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/compensation_v1.js +130 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/contact_v3.d.ts +4274 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/contact_v3.js +2394 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/corehr_v1.d.ts +16957 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/corehr_v1.js +4753 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/corehr_v2.d.ts +29869 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/corehr_v2.js +7902 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/directory_v1.d.ts +4324 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/directory_v1.js +1340 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/docs_v1.d.ts +58 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/docs_v1.js +26 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/docx_v1.d.ts +116719 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/docx_v1.js +14949 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/drive_v1.d.ts +3251 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/drive_v1.js +1395 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/drive_v2.d.ts +174 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/drive_v2.js +115 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/ehr_v1.d.ts +86 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/ehr_v1.js +48 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/event_v1.d.ts +44 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/event_v1.js +25 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/helpdesk_v1.d.ts +733 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/helpdesk_v1.js +279 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/hire_v1.d.ts +10085 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/hire_v1.js +5787 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/hire_v2.d.ts +158 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/hire_v2.js +64 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/human_authentication_v1.d.ts +70 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/human_authentication_v1.js +27 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/im_v1.d.ts +3043 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/im_v1.js +1812 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/im_v2.d.ts +2176 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/im_v2.js +454 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/lingo_v1.d.ts +2301 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/lingo_v1.js +650 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mail_v1.d.ts +2465 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mail_v1.js +1467 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mdm_v1.d.ts +104 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mdm_v1.js +45 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mdm_v3.d.ts +329 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/mdm_v3.js +76 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/minutes_v1.d.ts +92 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/minutes_v1.js +62 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/moments_v1.d.ts +52 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/moments_v1.js +20 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/okr_v1.d.ts +1664 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/okr_v1.js +455 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/optical_char_recognition_v1.d.ts +38 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/optical_char_recognition_v1.js +17 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/passport_v1.d.ts +131 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/passport_v1.js +53 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/payroll_v1.d.ts +609 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/payroll_v1.js +321 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/performance_v1.d.ts +309 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/performance_v1.js +165 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/performance_v2.d.ts +1177 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/performance_v2.js +525 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/personal_settings_v1.d.ts +640 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/personal_settings_v1.js +295 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/report_v1.d.ts +194 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/report_v1.js +72 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/search_v2.d.ts +1695 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/search_v2.js +556 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/security_and_compliance_v1.d.ts +68 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/security_and_compliance_v1.js +32 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/sheets_v2.d.ts +523 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/sheets_v2.js +231 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/sheets_v3.d.ts +979 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/sheets_v3.js +821 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/speech_to_text_v1.d.ts +225 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/speech_to_text_v1.js +65 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/task_v1.d.ts +1161 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/task_v1.js +647 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/task_v2.d.ts +6077 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/task_v2.js +1894 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/tenant_v2.d.ts +31 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/tenant_v2.js +24 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/translation_v1.d.ts +80 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/translation_v1.js +37 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/trust_party_v1.d.ts +182 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/trust_party_v1.js +137 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/vc_v1.d.ts +5725 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/vc_v1.js +1640 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/verification_v1.d.ts +21 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/verification_v1.js +14 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/wiki_v1.d.ts +72 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/wiki_v1.js +34 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/wiki_v2.d.ts +843 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/wiki_v2.js +376 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/workplace_v1.d.ts +116 -0
- package/dist/mcp-tool/tools/zh/gen-tools/zod/workplace_v1.js +77 -0
- package/dist/mcp-tool/types/index.d.ts +53 -0
- package/dist/mcp-tool/types/index.js +9 -0
- package/dist/mcp-tool/utils/case-transf.d.ts +2 -0
- package/dist/mcp-tool/utils/case-transf.js +15 -0
- package/dist/mcp-tool/utils/filter-tools.d.ts +2 -0
- package/dist/mcp-tool/utils/filter-tools.js +27 -0
- package/dist/mcp-tool/utils/get-should-use-uat.d.ts +2 -0
- package/dist/mcp-tool/utils/get-should-use-uat.js +18 -0
- package/dist/mcp-tool/utils/handler.d.ts +2 -0
- package/dist/mcp-tool/utils/handler.js +119 -0
- package/dist/mcp-tool/utils/index.d.ts +4 -0
- package/dist/mcp-tool/utils/index.js +20 -0
- package/dist/utils/clean-env-args.d.ts +1 -0
- package/dist/utils/clean-env-args.js +12 -0
- package/dist/utils/constants.d.ts +18 -0
- package/dist/utils/constants.js +35 -0
- package/dist/utils/http-instance.d.ts +2 -0
- package/dist/utils/http-instance.js +21 -0
- package/dist/utils/logger.d.ts +22 -0
- package/dist/utils/logger.js +97 -0
- package/dist/utils/noop.d.ts +1 -0
- package/dist/utils/noop.js +6 -0
- package/dist/utils/parser-string-array.d.ts +1 -0
- package/dist/utils/parser-string-array.js +13 -0
- package/dist/utils/safe-json-parse.d.ts +1 -0
- package/dist/utils/safe-json-parse.js +14 -0
- package/dist/utils/version.d.ts +1 -0
- package/dist/utils/version.js +52 -0
- package/docs/recall-mcp/README.md +137 -0
- package/docs/recall-mcp/README_ZH.md +137 -0
- package/docs/reference/cli/cli-zh.md +92 -0
- package/docs/reference/cli/cli.md +92 -0
- package/docs/reference/tool-presets/presets-zh.md +120 -0
- package/docs/reference/tool-presets/presets.md +120 -0
- package/docs/reference/tool-presets/tools-en.md +1527 -0
- package/docs/reference/tool-presets/tools-zh.md +1544 -0
- package/docs/troubleshooting/faq-zh.md +67 -0
- package/docs/troubleshooting/faq.md +67 -0
- package/docs/usage/configuration/configuration-zh.md +344 -0
- package/docs/usage/configuration/configuration.md +344 -0
- package/docs/usage/docker/docker-zh.md +101 -0
- package/docs/usage/docker/docker.md +106 -0
- package/package.json +65 -0
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# 飞书/Lark 开放平台开发文档检索 MCP
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp)
|
|
4
|
+
[](https://www.npmjs.com/package/@larksuiteoapi/lark-mcp)
|
|
5
|
+
[](https://nodejs.org/)
|
|
6
|
+
|
|
7
|
+
中文 | [English](./README.md)
|
|
8
|
+
|
|
9
|
+
> **⚠️ Beta版本提示**:当前工具处于Beta版本阶段,功能和API可能会有变更,请密切关注版本更新。
|
|
10
|
+
|
|
11
|
+
这是飞书/Lark官方 开放平台开发文档检索 MCP(Model Context Protocol)工具,旨在帮助用户输入自身诉求后迅速检索到自己需要的开发文档,帮助开发者在AI IDE中编写与飞书集成的代码。也可搭配 [飞书/Lark OpenAPI MCP](../../README_ZH.md) 来让 AI 助手运行自动化场景
|
|
12
|
+
|
|
13
|
+
>**说明**: 开放平台开发文档检索,检索范围是 [开发文档](https://open.feishu.cn/document/home/index) 下所有的开发指南、开发教程、服务端 API、客户端 API,帮助用户迅速检索到对应的 OpenApi 或者其他开发文档,非「飞书云文档」的检索。
|
|
14
|
+
|
|
15
|
+
## 使用准备
|
|
16
|
+
|
|
17
|
+
### 安装Node.js
|
|
18
|
+
|
|
19
|
+
在使用lark-mcp工具之前,您需要先安装Node.js环境。如已安装过 Node.js,可以跳过本步骤
|
|
20
|
+
1. **使用Homebrew安装(推荐)**:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
brew install node
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
2. **使用官方安装包**:
|
|
27
|
+
- 访问[Node.js官网](https://nodejs.org/)
|
|
28
|
+
- 下载并安装LTS版本
|
|
29
|
+
- 安装完成后,打开终端验证:
|
|
30
|
+
```bash
|
|
31
|
+
node -v
|
|
32
|
+
npm -v
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
#### Windows安装Node.js
|
|
36
|
+
|
|
37
|
+
1. **使用官方安装包**:
|
|
38
|
+
|
|
39
|
+
- 访问[Node.js官网](https://nodejs.org/)
|
|
40
|
+
- 下载并运行Windows安装程序(.msi文件)
|
|
41
|
+
- 按照安装向导操作,完成安装
|
|
42
|
+
- 安装完成后,打开命令提示符验证:
|
|
43
|
+
```bash
|
|
44
|
+
node -v
|
|
45
|
+
npm -v
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
2. **使用nvm-windows**:
|
|
49
|
+
- 下载[nvm-windows](https://github.com/coreybutler/nvm-windows/releases)
|
|
50
|
+
- 安装nvm-windows
|
|
51
|
+
- 使用nvm安装Node.js:
|
|
52
|
+
```bash
|
|
53
|
+
nvm install latest
|
|
54
|
+
nvm use <版本号>
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## 安装
|
|
58
|
+
|
|
59
|
+
全局安装lark-mcp工具:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npm install -g @larksuiteoapi/lark-mcp
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## 使用指南
|
|
66
|
+
|
|
67
|
+
### 在Trae/Cursor/Claude中使用
|
|
68
|
+
如需在Trae/Cursor或Claude等AI工具中集成飞书/Lark功能,你可以通过下方按钮安装到对应的工具:
|
|
69
|
+
|
|
70
|
+
[](https://cursor.com/install-mcp?name=lark_open_doc_search&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsYXJrc3VpdGVvYXBpL2xhcmstbWNwIiwicmVjYWxsLWRldmVsb3Blci1kb2N1bWVudHMiXX0=)
|
|
71
|
+
|
|
72
|
+
[](trae-cn://trae.ai-ide/mcp-import?source=lark&type=stdio&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsYXJrc3VpdGVvYXBpL2xhcmstbWNwIiwicmVjYWxsLWRldmVsb3Blci1kb2N1bWVudHMiXX0=) [](trae://trae.ai-ide/mcp-import?source=lark&type=stdio&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBsYXJrc3VpdGVvYXBpL2xhcmstbWNwIiwicmVjYWxsLWRldmVsb3Blci1kb2N1bWVudHMiXX0=)
|
|
73
|
+
|
|
74
|
+
也可以在配置文件中添加以下内容:
|
|
75
|
+
|
|
76
|
+
```json
|
|
77
|
+
{
|
|
78
|
+
"mcpServers": {
|
|
79
|
+
"lark-mcp": {
|
|
80
|
+
"command": "npx",
|
|
81
|
+
"args": [
|
|
82
|
+
"-y",
|
|
83
|
+
"@larksuiteoapi/lark-mcp",
|
|
84
|
+
"recall-developer-documents",
|
|
85
|
+
]
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### 高级配置
|
|
92
|
+
|
|
93
|
+
#### 命令行参数说明
|
|
94
|
+
|
|
95
|
+
`lark-mcp recall-developer-documents`工具提供了多种命令行参数,以便您灵活配置MCP服务:
|
|
96
|
+
|
|
97
|
+
| 参数 | 简写 | 描述 | 示例 |
|
|
98
|
+
|------|------|------|------|
|
|
99
|
+
| `--mode` | `-m` | 传输模式,可选值为stdio、streamable或sse,默认为stdio | `-m sse` |
|
|
100
|
+
| `--host` | | SSE\Streamable模式下的监听主机,默认为localhost | `--host 0.0.0.0` |
|
|
101
|
+
| `--port` | `-p` | SSE\Streamable模式下的监听端口,默认为3000 | `-p 3000` |
|
|
102
|
+
| `--version` | `-V` | 显示版本号 | `-V` |
|
|
103
|
+
| `--help` | `-h` | 显示帮助信息 | `-h` |
|
|
104
|
+
|
|
105
|
+
#### 参数使用示例
|
|
106
|
+
|
|
107
|
+
1. **传输模式**:
|
|
108
|
+
|
|
109
|
+
recall-developer-documents 支持两种传输模式:
|
|
110
|
+
|
|
111
|
+
1. **stdio模式(默认/推荐)**:适用于与Cursor或Claude等AI工具集成,通过标准输入输出流进行通信。
|
|
112
|
+
```bash
|
|
113
|
+
lark-mcp recall-developer-documents -m stdio
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
2. **SSE模式**:提供基于Server-Sent Events的HTTP接口,适用于Web应用或需要网络接口的场景。
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
# 默认只监听localhost
|
|
120
|
+
lark-mcp recall-developer-documents -m sse -p 3000
|
|
121
|
+
|
|
122
|
+
# 监听所有网络接口(允许远程访问)
|
|
123
|
+
lark-mcp recall-developer-documents -m sse --host 0.0.0.0 -p 3000
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
启动后,SSE端点将可在 `http://<host>:<port>/sse` 访问。
|
|
127
|
+
|
|
128
|
+
## 相关链接
|
|
129
|
+
|
|
130
|
+
- [飞书开放平台](https://open.feishu.cn/)
|
|
131
|
+
- [Lark国际版开放平台](https://open.larksuite.com/)
|
|
132
|
+
- [Node.js官网](https://nodejs.org/)
|
|
133
|
+
- [npm文档](https://docs.npmjs.com/)
|
|
134
|
+
|
|
135
|
+
## 反馈
|
|
136
|
+
|
|
137
|
+
欢迎提交Issues来帮助改进这个工具。如有问题或建议,请在GitHub仓库中提出。
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# 命令行参考
|
|
2
|
+
|
|
3
|
+
本文档提供了 lark-mcp 工具所有命令行参数的详细说明。
|
|
4
|
+
|
|
5
|
+
## 目录
|
|
6
|
+
|
|
7
|
+
- [lark-mcp login](#lark-mcp-login)
|
|
8
|
+
- [lark-mcp logout](#lark-mcp-logout)
|
|
9
|
+
- [lark-mcp mcp](#lark-mcp-mcp)
|
|
10
|
+
|
|
11
|
+
## lark-mcp login
|
|
12
|
+
|
|
13
|
+
`lark-mcp login` 命令用于进行用户身份认证,获取用户访问令牌以访问用户的个人数据。
|
|
14
|
+
|
|
15
|
+
### 参数说明
|
|
16
|
+
|
|
17
|
+
| 参数 | 简写 | 描述 | 示例 |
|
|
18
|
+
|------|------|------|------|
|
|
19
|
+
| `--app-id` | `-a` | 飞书/Lark应用的App ID | `-a cli_xxxx` |
|
|
20
|
+
| `--app-secret` | `-s` | 飞书/Lark应用的App Secret | `-s xxxx` |
|
|
21
|
+
| `--domain` | `-d` | 飞书/Lark API域名,默认为https://open.feishu.cn | `-d https://open.larksuite.com` |
|
|
22
|
+
| `--host` | | 监听主机,默认为localhost | `--host localhost` |
|
|
23
|
+
| `--port` | `-p` | 监听端口,默认为3000 | `-p 3000` |
|
|
24
|
+
| `--scope` | | 指定授权用户访问令牌的OAuth权限范围,默认为应用开通的全部权限,用空格或者逗号分割 | `--scope offline_access docx:document` |
|
|
25
|
+
|
|
26
|
+
### 使用示例
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
# 基础登录
|
|
30
|
+
npx -y @larksuiteoapi/lark-mcp login -a cli_xxxx -s your_secret
|
|
31
|
+
|
|
32
|
+
# 指定特定的OAuth权限范围登录
|
|
33
|
+
npx -y @larksuiteoapi/lark-mcp login -a cli_xxxx -s your_secret --scope offline_access docx:document
|
|
34
|
+
|
|
35
|
+
# 使用自定义域名登录(适用于Lark国际版)
|
|
36
|
+
npx -y @larksuiteoapi/lark-mcp login -a cli_xxxx -s your_secret -d https://open.larksuite.com
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## lark-mcp logout
|
|
40
|
+
|
|
41
|
+
`lark-mcp logout` 命令用于清除本地存储的用户访问令牌。
|
|
42
|
+
|
|
43
|
+
### 参数说明
|
|
44
|
+
|
|
45
|
+
| 参数 | 简写 | 描述 | 示例 |
|
|
46
|
+
|------|------|------|------|
|
|
47
|
+
| `--app-id` | `-a` | 飞书/Lark应用的App ID,可选。指定则只清除该应用的令牌,不指定则清除所有应用的令牌 | `-a cli_xxxx` |
|
|
48
|
+
|
|
49
|
+
### 功能说明
|
|
50
|
+
|
|
51
|
+
此命令用于清除本地存储的用户访问令牌。如果指定了 `--app-id` 参数,则只清除该应用的用户访问令牌;如果不指定,则清除所有应用的用户访问令牌。
|
|
52
|
+
|
|
53
|
+
### 使用示例
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
# 清除特定应用的令牌
|
|
57
|
+
npx -y @larksuiteoapi/lark-mcp logout -a cli_xxxx
|
|
58
|
+
|
|
59
|
+
# 清除所有应用的令牌
|
|
60
|
+
npx -y @larksuiteoapi/lark-mcp logout
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## lark-mcp mcp
|
|
64
|
+
|
|
65
|
+
`lark-mcp mcp` 工具提供了多种命令行参数,以便您灵活配置MCP服务。
|
|
66
|
+
|
|
67
|
+
### 参数说明
|
|
68
|
+
|
|
69
|
+
| 参数 | 简写 | 描述 | 示例 |
|
|
70
|
+
|------|------|------|------|
|
|
71
|
+
| `--app-id` | `-a` | 飞书/Lark应用的App ID | `-a cli_xxxx` |
|
|
72
|
+
| `--app-secret` | `-s` | 飞书/Lark应用的App Secret | `-s xxxx` |
|
|
73
|
+
| `--domain` | `-d` | 飞书/Lark API域名,默认为https://open.feishu.cn | `-d https://open.larksuite.com` |
|
|
74
|
+
| `--tools` | `-t` | 需要启用的API工具列表,用空格或者逗号分割 | `-t im.v1.message.create,im.v1.chat.create` |
|
|
75
|
+
| `--tool-name-case` | `-c` | 工具注册名称的命名格式,可选值为snake、camel、dot或kebab,默认为snake | `-c camel` |
|
|
76
|
+
| `--language` | `-l` | 工具语言,可选值为zh或en,默认为en | `-l zh` |
|
|
77
|
+
| `--user-access-token` | `-u` | 用户访问令牌,用于以用户身份调用API | `-u u-xxxx` |
|
|
78
|
+
| `--token-mode` | | API令牌类型,可选值为auto、tenant_access_token或user_access_token,默认为auto | `--token-mode user_access_token` |
|
|
79
|
+
| `--oauth` | | 开启 MCP Auth Server 获取user_access_token,且当Token失效时自动要求用户重新登录(Beta) | `--oauth` |
|
|
80
|
+
| `--scope` | | 指定授权用户访问令牌的OAuth权限范围,默认为应用开通的全部权限,用空格或者逗号分割 | `--scope offline_access docx:document` |
|
|
81
|
+
| `--mode` | `-m` | 传输模式,可选值为stdio、streamable或sse,默认为stdio | `-m streamable` |
|
|
82
|
+
| `--host` | | SSE\Streamable模式下的监听主机,默认为localhost | `--host 0.0.0.0` |
|
|
83
|
+
| `--port` | `-p` | SSE\Streamable模式下的监听端口,默认为3000 | `-p 3000` |
|
|
84
|
+
| `--config` | | 配置文件路径,支持JSON格式 | `--config ./config.json` |
|
|
85
|
+
| `--version` | `-V` | 显示版本号 | `-V` |
|
|
86
|
+
| `--help` | `-h` | 显示帮助信息 | `-h` |
|
|
87
|
+
|
|
88
|
+
## 相关文档
|
|
89
|
+
|
|
90
|
+
- [配置指南](../../usage/configuration/configuration-zh.md)
|
|
91
|
+
- [工具参考](../tool-presets/tools-zh.md)
|
|
92
|
+
- [故障排除](../../troubleshooting/faq-zh.md)
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Command Line Reference
|
|
2
|
+
|
|
3
|
+
This document provides detailed information about all command line parameters available for the lark-mcp tool.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
- [lark-mcp login](#lark-mcp-login)
|
|
8
|
+
- [lark-mcp logout](#lark-mcp-logout)
|
|
9
|
+
- [lark-mcp mcp](#lark-mcp-mcp)
|
|
10
|
+
|
|
11
|
+
## lark-mcp login
|
|
12
|
+
|
|
13
|
+
The `lark-mcp login` command is used to authenticate with user identity and obtain user access tokens for accessing user's personal data.
|
|
14
|
+
|
|
15
|
+
### Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Short | Description | Example |
|
|
18
|
+
|------|------|------|------|
|
|
19
|
+
| `--app-id` | `-a` | Feishu/Lark application App ID | `-a cli_xxxx` |
|
|
20
|
+
| `--app-secret` | `-s` | Feishu/Lark application App Secret | `-s xxxx` |
|
|
21
|
+
| `--domain` | `-d` | Feishu/Lark API domain, default is https://open.feishu.cn | `-d https://open.larksuite.com` |
|
|
22
|
+
| `--host` | | Host to listen, default is localhost | `--host localhost` |
|
|
23
|
+
| `--port` | `-p` | Port to listen, default is 3000 | `-p 3000` |
|
|
24
|
+
| `--scope` | | Specify OAuth scope for user access token, default is all permissions granted to the app, separated by spaces or commas | `--scope offline_access docx:document` |
|
|
25
|
+
|
|
26
|
+
### Usage Examples
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
# Basic login
|
|
30
|
+
npx -y @larksuiteoapi/lark-mcp login -a cli_xxxx -s your_secret
|
|
31
|
+
|
|
32
|
+
# Login with specific OAuth scope
|
|
33
|
+
npx -y @larksuiteoapi/lark-mcp login -a cli_xxxx -s your_secret --scope offline_access docx:document
|
|
34
|
+
|
|
35
|
+
# Login with custom domain (for Lark international)
|
|
36
|
+
npx -y @larksuiteoapi/lark-mcp login -a cli_xxxx -s your_secret -d https://open.larksuite.com
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## lark-mcp logout
|
|
40
|
+
|
|
41
|
+
The `lark-mcp logout` command is used to clear locally stored user access tokens.
|
|
42
|
+
|
|
43
|
+
### Parameters
|
|
44
|
+
|
|
45
|
+
| Parameter | Short | Description | Example |
|
|
46
|
+
|------|------|------|------|
|
|
47
|
+
| `--app-id` | `-a` | Feishu/Lark application App ID, optional. If specified, only clears the token for this app; if not specified, clears tokens for all apps | `-a cli_xxxx` |
|
|
48
|
+
|
|
49
|
+
### Description
|
|
50
|
+
|
|
51
|
+
This command is used to clear locally stored user access tokens. If the `--app-id` parameter is specified, it only clears the user access token for that application; if not specified, it clears user access tokens for all applications.
|
|
52
|
+
|
|
53
|
+
### Usage Examples
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
# Clear tokens for a specific app
|
|
57
|
+
npx -y @larksuiteoapi/lark-mcp logout -a cli_xxxx
|
|
58
|
+
|
|
59
|
+
# Clear tokens for all apps
|
|
60
|
+
npx -y @larksuiteoapi/lark-mcp logout
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## lark-mcp mcp
|
|
64
|
+
|
|
65
|
+
The `lark-mcp mcp` tool provides various command line parameters to flexibly configure the MCP service.
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Parameter | Short | Description | Example |
|
|
70
|
+
|------|------|------|------|
|
|
71
|
+
| `--app-id` | `-a` | Feishu/Lark application App ID | `-a cli_xxxx` |
|
|
72
|
+
| `--app-secret` | `-s` | Feishu/Lark application App Secret | `-s xxxx` |
|
|
73
|
+
| `--domain` | `-d` | Feishu/Lark API domain, default is https://open.feishu.cn | `-d https://open.larksuite.com` |
|
|
74
|
+
| `--tools` | `-t` | List of API tools to enable, separated by spaces or commas | `-t im.v1.message.create,im.v1.chat.create` |
|
|
75
|
+
| `--tool-name-case` | `-c` | Tool name format, options are snake, camel, dot, or kebab, default is snake | `-c camel` |
|
|
76
|
+
| `--language` | `-l` | Tools language, options are zh or en, default is en | `-l zh` |
|
|
77
|
+
| `--user-access-token` | `-u` | User access token for calling APIs as a user | `-u u-xxxx` |
|
|
78
|
+
| `--token-mode` | | API token type, options are auto, tenant_access_token, or user_access_token, default is auto | `--token-mode user_access_token` |
|
|
79
|
+
| `--oauth` | | Enable MCP Auth Server to get user_access_token and auto request user login when token expires (Beta) | `--oauth` |
|
|
80
|
+
| `--scope` | | Specify OAuth scope for user access token, default is all permissions granted to the app, separated by spaces or commas | `--scope offline_access docx:document` |
|
|
81
|
+
| `--mode` | `-m` | Transport mode, options are stdio, streamable, or sse, default is stdio | `-m streamable` |
|
|
82
|
+
| `--host` | | Listening host in SSE/Streamable mode, default is localhost | `--host 0.0.0.0` |
|
|
83
|
+
| `--port` | `-p` | Listening port in SSE/Streamable mode, default is 3000 | `-p 3000` |
|
|
84
|
+
| `--config` | | Configuration file path, supports JSON format | `--config ./config.json` |
|
|
85
|
+
| `--version` | `-V` | Display version number | `-V` |
|
|
86
|
+
| `--help` | `-h` | Display help information | `-h` |
|
|
87
|
+
|
|
88
|
+
## Related Documentation
|
|
89
|
+
|
|
90
|
+
- [Configuration Guide](../../usage/configuration/configuration.md)
|
|
91
|
+
- [Tools Reference](../tool-presets/tools-en.md)
|
|
92
|
+
- [Troubleshooting](../../troubleshooting/faq.md)
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# 预设工具集参考
|
|
2
|
+
|
|
3
|
+
本文档提供了 lark-mcp 中所有可用预设工具集的详细信息。预设是为特定用例预定义的工具集,可以一起启用。
|
|
4
|
+
|
|
5
|
+
## 概述
|
|
6
|
+
|
|
7
|
+
如无特殊需求,可保持默认 preset 即可使用常用功能。需要精细控制或了解完整列表时,可参考下面的预设表格。
|
|
8
|
+
|
|
9
|
+
## 如何使用预设
|
|
10
|
+
|
|
11
|
+
要使用预设,请在 `-t` 参数中指定:
|
|
12
|
+
|
|
13
|
+
```json
|
|
14
|
+
{
|
|
15
|
+
"mcpServers": {
|
|
16
|
+
"lark-mcp": {
|
|
17
|
+
"command": "npx",
|
|
18
|
+
"args": [
|
|
19
|
+
"-y",
|
|
20
|
+
"@larksuiteoapi/lark-mcp",
|
|
21
|
+
"mcp",
|
|
22
|
+
"-a", "<your_app_id>",
|
|
23
|
+
"-s", "<your_app_secret>",
|
|
24
|
+
"-t", "preset.light"
|
|
25
|
+
]
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
您也可以将预设与单个工具组合:
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"mcpServers": {
|
|
36
|
+
"lark-mcp": {
|
|
37
|
+
"command": "npx",
|
|
38
|
+
"args": [
|
|
39
|
+
"-y",
|
|
40
|
+
"@larksuiteoapi/lark-mcp",
|
|
41
|
+
"mcp",
|
|
42
|
+
"-a", "<your_app_id>",
|
|
43
|
+
"-s", "<your_app_secret>",
|
|
44
|
+
"-t", "preset.light,im.v1.message.create"
|
|
45
|
+
]
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## 预设工具集详表
|
|
52
|
+
|
|
53
|
+
| 工具名称 | 功能描述 | preset.light | preset.default (默认) | preset.im.default | preset.base.default | preset.base.batch | preset.doc.default | preset.task.default | preset.calendar.default |
|
|
54
|
+
| --- | --- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
|
|
55
|
+
| im.v1.chat.create | 创建群 | | ✓ | ✓ | | | | | |
|
|
56
|
+
| im.v1.chat.list | 获取群列表 | | ✓ | ✓ | | | | | |
|
|
57
|
+
| im.v1.chat.search | 搜索群 | ✓ | | | | | | | |
|
|
58
|
+
| im.v1.chatMembers.get | 获取群成员 | | ✓ | ✓ | | | | | |
|
|
59
|
+
| im.v1.message.create | 发送消息 | ✓ | ✓ | ✓ | | | | | |
|
|
60
|
+
| im.v1.message.list | 获取消息列表 | ✓ | ✓ | ✓ | | | | | |
|
|
61
|
+
| bitable.v1.app.create | 创建多维表格 | | ✓ | | ✓ | ✓ | | | |
|
|
62
|
+
| bitable.v1.appTable.create | 创建多维表格数据表 | | ✓ | | ✓ | ✓ | | | |
|
|
63
|
+
| bitable.v1.appTable.list | 获取多维表格数据表列表 | | ✓ | | ✓ | ✓ | | | |
|
|
64
|
+
| bitable.v1.appTableField.list | 获取多维表格数据表字段列表 | | ✓ | | ✓ | ✓ | | | |
|
|
65
|
+
| bitable.v1.appTableRecord.search | 搜索多维表格数据表记录 | ✓ | ✓ | | ✓ | ✓ | | | |
|
|
66
|
+
| bitable.v1.appTableRecord.create | 创建多维表格数据表记录 | | ✓ | | ✓ | | | | |
|
|
67
|
+
| bitable.v1.appTableRecord.batchCreate | 批量创建多维表格数据表记录 | ✓ | | | | ✓ | | | |
|
|
68
|
+
| bitable.v1.appTableRecord.update | 更新多维表格数据表记录 | | ✓ | | ✓ | | | | |
|
|
69
|
+
| bitable.v1.appTableRecord.batchUpdate | 批量更新多维表格数据表记录 | | | | | ✓ | | | |
|
|
70
|
+
| docx.v1.document.rawContent | 获取文档内容 | ✓ | ✓ | | | | ✓ | | |
|
|
71
|
+
| docx.builtin.import | 导入文档 | ✓ | ✓ | | | | ✓ | | |
|
|
72
|
+
| docx.builtin.search | 搜索文档 | ✓ | ✓ | | | | ✓ | | |
|
|
73
|
+
| drive.v1.permissionMember.create | 添加协作者权限 | | ✓ | | | | ✓ | | |
|
|
74
|
+
| wiki.v2.space.getNode | 获取知识库节点 | ✓ | ✓ | | | | ✓ | | |
|
|
75
|
+
| wiki.v1.node.search | 搜索知识库节点 | | ✓ | | | | ✓ | | |
|
|
76
|
+
| contact.v3.user.batchGetId | 批量获取用户ID | ✓ | ✓ | | | | | | |
|
|
77
|
+
| task.v2.task.create | 创建任务 | | | | | | | ✓ | |
|
|
78
|
+
| task.v2.task.patch | 修改任务 | | | | | | | ✓ | |
|
|
79
|
+
| task.v2.task.addMembers | 添加任务成员 | | | | | | | ✓ | |
|
|
80
|
+
| task.v2.task.addReminders | 添加任务提醒 | | | | | | | ✓ | |
|
|
81
|
+
| calendar.v4.calendarEvent.create | 创建日历事件 | | | | | | | | ✓ |
|
|
82
|
+
| calendar.v4.calendarEvent.patch | 修改日历事件 | | | | | | | | ✓ |
|
|
83
|
+
| calendar.v4.calendarEvent.get | 获取日历事件 | | | | | | | | ✓ |
|
|
84
|
+
| calendar.v4.freebusy.list | 查询忙闲状态 | | | | | | | | ✓ |
|
|
85
|
+
| calendar.v4.calendar.primary | 获取主日历 | | | | | | | | ✓ |
|
|
86
|
+
|
|
87
|
+
> **说明**:表格中"✓"表示该工具包含在对应的预设工具集中。使用`-t preset.xxx`参数时,会启用该列标有"✓"的工具。
|
|
88
|
+
|
|
89
|
+
## 预设说明
|
|
90
|
+
|
|
91
|
+
### preset.light
|
|
92
|
+
最小化预设,仅包含基本消息和文档操作的核心工具。适合轻量级集成。
|
|
93
|
+
|
|
94
|
+
### preset.default(默认)
|
|
95
|
+
默认预设,包含消息、文档、数据库和协作等常用工具。推荐大多数用户使用。
|
|
96
|
+
|
|
97
|
+
### preset.im.default
|
|
98
|
+
专注于即时消息功能,包括群聊创建、成员管理和消息处理。
|
|
99
|
+
|
|
100
|
+
### preset.base.default
|
|
101
|
+
包含多维表格的基础数据库操作,适用于数据管理场景。
|
|
102
|
+
|
|
103
|
+
### preset.base.batch
|
|
104
|
+
专门用于多维表格数据的批量操作,适合批量数据处理。
|
|
105
|
+
|
|
106
|
+
### preset.doc.default
|
|
107
|
+
以文档为中心的预设,包括文档读取、导入、搜索和协作功能。
|
|
108
|
+
|
|
109
|
+
### preset.task.default
|
|
110
|
+
任务管理预设,用于创建、修改和管理带有提醒和成员的任务。
|
|
111
|
+
|
|
112
|
+
### preset.calendar.default
|
|
113
|
+
日历管理预设,用于创建、修改事件和查询可用性。
|
|
114
|
+
|
|
115
|
+
## 相关文档
|
|
116
|
+
|
|
117
|
+
- [主要文档](../../../README_ZH.md)
|
|
118
|
+
- [工具参考](./tools-zh.md)
|
|
119
|
+
- [配置指南](../../usage/configuration/configuration-zh.md)
|
|
120
|
+
- [命令行参考](../cli/cli-zh.md)
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# Preset Tool Collections Reference
|
|
2
|
+
|
|
3
|
+
This document provides detailed information about all preset tool collections available in lark-mcp. Presets are predefined sets of tools that can be enabled together for specific use cases.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
If you have no special requirements, you can keep the default preset to use common functions. When you need fine control or want to understand the complete list, please refer to the preset table below.
|
|
8
|
+
|
|
9
|
+
## How to Use Presets
|
|
10
|
+
|
|
11
|
+
To use a preset, specify it in the `-t` parameter:
|
|
12
|
+
|
|
13
|
+
```json
|
|
14
|
+
{
|
|
15
|
+
"mcpServers": {
|
|
16
|
+
"lark-mcp": {
|
|
17
|
+
"command": "npx",
|
|
18
|
+
"args": [
|
|
19
|
+
"-y",
|
|
20
|
+
"@larksuiteoapi/lark-mcp",
|
|
21
|
+
"mcp",
|
|
22
|
+
"-a", "<your_app_id>",
|
|
23
|
+
"-s", "<your_app_secret>",
|
|
24
|
+
"-t", "preset.light"
|
|
25
|
+
]
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
You can also combine presets with individual tools:
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"mcpServers": {
|
|
36
|
+
"lark-mcp": {
|
|
37
|
+
"command": "npx",
|
|
38
|
+
"args": [
|
|
39
|
+
"-y",
|
|
40
|
+
"@larksuiteoapi/lark-mcp",
|
|
41
|
+
"mcp",
|
|
42
|
+
"-a", "<your_app_id>",
|
|
43
|
+
"-s", "<your_app_secret>",
|
|
44
|
+
"-t", "preset.light,im.v1.message.create"
|
|
45
|
+
]
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Preset Tool Collections
|
|
52
|
+
|
|
53
|
+
| Tool Name | Function Description | preset.light | preset.default (Default) | preset.im.default | preset.base.default | preset.base.batch | preset.doc.default | preset.task.default | preset.calendar.default |
|
|
54
|
+
| --- | --- | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
|
|
55
|
+
| im.v1.chat.create | Create a group chat | | ✓ | ✓ | | | | | |
|
|
56
|
+
| im.v1.chat.list | Get group chat list | | ✓ | ✓ | | | | | |
|
|
57
|
+
| im.v1.chat.search | Search group chats | ✓ | | | | | | | |
|
|
58
|
+
| im.v1.chatMembers.get | Get group members | | ✓ | ✓ | | | | | |
|
|
59
|
+
| im.v1.message.create | Send messages | ✓ | ✓ | ✓ | | | | | |
|
|
60
|
+
| im.v1.message.list | Get message list | ✓ | ✓ | ✓ | | | | | |
|
|
61
|
+
| bitable.v1.app.create | Create base | | ✓ | | ✓ | ✓ | | | |
|
|
62
|
+
| bitable.v1.appTable.create | Create base data table | | ✓ | | ✓ | ✓ | | | |
|
|
63
|
+
| bitable.v1.appTable.list | Get base data table list | | ✓ | | ✓ | ✓ | | | |
|
|
64
|
+
| bitable.v1.appTableField.list | Get base data table field list | | ✓ | | ✓ | ✓ | | | |
|
|
65
|
+
| bitable.v1.appTableRecord.search | Search base data table records | ✓ | ✓ | | ✓ | ✓ | | | |
|
|
66
|
+
| bitable.v1.appTableRecord.create | Create base data table records | | ✓ | | ✓ | | | | |
|
|
67
|
+
| bitable.v1.appTableRecord.batchCreate | Batch create base data table records | ✓ | | | | ✓ | | | |
|
|
68
|
+
| bitable.v1.appTableRecord.update | Update base data table records | | ✓ | | ✓ | | | | |
|
|
69
|
+
| bitable.v1.appTableRecord.batchUpdate | Batch update base data table records | | | | | ✓ | | | |
|
|
70
|
+
| docx.v1.document.rawContent | Get document content | ✓ | ✓ | | | | ✓ | | |
|
|
71
|
+
| docx.builtin.import | Import documents | ✓ | ✓ | | | | ✓ | | |
|
|
72
|
+
| docx.builtin.search | Search documents | ✓ | ✓ | | | | ✓ | | |
|
|
73
|
+
| drive.v1.permissionMember.create | Add collaborator permissions | | ✓ | | | | ✓ | | |
|
|
74
|
+
| wiki.v2.space.getNode | Get Wiki node | ✓ | ✓ | | | | ✓ | | |
|
|
75
|
+
| wiki.v1.node.search | Search Wiki nodes | | ✓ | | | | ✓ | | |
|
|
76
|
+
| contact.v3.user.batchGetId | Batch get user IDs | ✓ | ✓ | | | | | | |
|
|
77
|
+
| task.v2.task.create | Create task | | | | | | | ✓ | |
|
|
78
|
+
| task.v2.task.patch | Modify task | | | | | | | ✓ | |
|
|
79
|
+
| task.v2.task.addMembers | Add task members | | | | | | | ✓ | |
|
|
80
|
+
| task.v2.task.addReminders | Add task reminders | | | | | | | ✓ | |
|
|
81
|
+
| calendar.v4.calendarEvent.create | Create calendar event | | | | | | | | ✓ |
|
|
82
|
+
| calendar.v4.calendarEvent.patch | Modify calendar event | | | | | | | | ✓ |
|
|
83
|
+
| calendar.v4.calendarEvent.get | Get calendar event | | | | | | | | ✓ |
|
|
84
|
+
| calendar.v4.freebusy.list | Query free/busy status | | | | | | | | ✓ |
|
|
85
|
+
| calendar.v4.calendar.primary | Get primary calendar | | | | | | | | ✓ |
|
|
86
|
+
|
|
87
|
+
> **Note**: In the table, "✓" indicates the tool is included in that preset. Using `-t preset.xxx` will enable tools marked with "✓" in the corresponding column.
|
|
88
|
+
|
|
89
|
+
## Preset Descriptions
|
|
90
|
+
|
|
91
|
+
### preset.light
|
|
92
|
+
A minimal preset that includes only the most essential tools for basic messaging and document operations. Ideal for lightweight integrations.
|
|
93
|
+
|
|
94
|
+
### preset.default (Default)
|
|
95
|
+
The default preset that includes commonly used tools across messaging, documents, databases, and collaboration. Recommended for most users.
|
|
96
|
+
|
|
97
|
+
### preset.im.default
|
|
98
|
+
Focused on instant messaging functionality, including chat creation, member management, and message handling.
|
|
99
|
+
|
|
100
|
+
### preset.base.default
|
|
101
|
+
Includes basic database operations with BitTable (multi-dimensional tables) for data management scenarios.
|
|
102
|
+
|
|
103
|
+
### preset.base.batch
|
|
104
|
+
Specialized for batch operations on BitTable data, useful for bulk data processing.
|
|
105
|
+
|
|
106
|
+
### preset.doc.default
|
|
107
|
+
Document-focused preset including document reading, importing, searching, and collaboration features.
|
|
108
|
+
|
|
109
|
+
### preset.task.default
|
|
110
|
+
Task management focused preset for creating, modifying, and managing tasks with reminders and members.
|
|
111
|
+
|
|
112
|
+
### preset.calendar.default
|
|
113
|
+
Calendar management preset for creating, modifying events, and querying availability.
|
|
114
|
+
|
|
115
|
+
## Related Documentation
|
|
116
|
+
|
|
117
|
+
- [Main Documentation](../../../README.md)
|
|
118
|
+
- [Tools Reference](./tools-en.md)
|
|
119
|
+
- [Configuration Guide](../../usage/configuration/configuration.md)
|
|
120
|
+
- [Command Line Reference](../cli/cli.md)
|