@firfi/huly-mcp 0.23.0 → 0.25.0
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/README.md +45 -10
- package/dist/index.cjs +4370 -1353
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -233,10 +233,10 @@ For a Smithery publish schema example, see [docs/SMITHERY_URL_PUBLISH.md](docs/S
|
|
|
233
233
|
| `HULY_PASSWORD` | Auth* | Account password |
|
|
234
234
|
| `HULY_TOKEN` | Auth* | API token (alternative to email/password) |
|
|
235
235
|
| `HULY_WORKSPACE` | Yes | Workspace identifier |
|
|
236
|
-
| `HULY_CONNECTION_TIMEOUT` | No | Connection timeout in ms
|
|
236
|
+
| `HULY_CONNECTION_TIMEOUT` | No | Connection timeout in ms. Omit to use the package default. |
|
|
237
237
|
| `MCP_TRANSPORT` | No | Transport type: `stdio` (default) or `http` |
|
|
238
238
|
| `MCP_HTTP_PORT` | No | HTTP server port (falls back to `PORT`, then 3000) |
|
|
239
|
-
| `MCP_HTTP_HOST` | No | HTTP server host
|
|
239
|
+
| `MCP_HTTP_HOST` | No | HTTP server host. Omit to bind to the package default loopback host. |
|
|
240
240
|
| `MCP_AUTH_TOKEN` | No | Optional bearer token required by HTTP clients for `/mcp`. This protects the MCP endpoint only; it is not a Huly API token. |
|
|
241
241
|
| `TOOLSETS` | No | Comma-separated tool categories to expose. If unset, all tools are exposed. Example: `issues,projects,search` |
|
|
242
242
|
|
|
@@ -271,7 +271,7 @@ Highest-value additions for coding agents:
|
|
|
271
271
|
|
|
272
272
|
- Generic space follow-ups: role assignment mutations, role/permission definition writes, generic space creation, and module-specific wrappers above the shared space foundation.
|
|
273
273
|
- SDK discovery phase 2: space types, roles, permissions, plugin configuration, sequence metadata, and richer tool hints.
|
|
274
|
-
- Drive
|
|
274
|
+
- Drive follow-ups: drive create/update/delete, item move/rename/delete, adding new versions to existing files, permissions, and comments/activity.
|
|
275
275
|
- Planner/ToDos: personal and project ToDo CRUD, scheduling, complete/reopen, priority, privacy/visibility, and document action items.
|
|
276
276
|
- Recruiting: vacancies, candidates, applications, application statuses, recruiter assignment, reviews, opinions, skills, and related comments/attachments/activity.
|
|
277
277
|
- Controlled documents and trainings: controlled document spaces/projects, review/approval workflows, templates, categories, snapshots/history, training assignments, attempts, scoring, and results.
|
|
@@ -283,7 +283,7 @@ Planned feature surfaces:
|
|
|
283
283
|
- Controlled Documents / TraceX documents: controlled spaces/projects, controlled document CRUD, quality/technical docs, co-authors/reviewers/approvers, e-signature workflows, release/effective-date metadata, change control, training linkage, controlled-document comments, and snapshots/history.
|
|
284
284
|
- Products and product versions: product spaces, members, descriptions, attachments, versions, version state transitions, and change-control links.
|
|
285
285
|
- Trainings, questions, and assessments: training revisions, releases, requests, due dates, max attempts, question banks, answer options, correct-answer data, submissions, scoring, and reporting.
|
|
286
|
-
- Drive: drives,
|
|
286
|
+
- Drive: first slice covers listing/getting drives, path traversal/list/get items, idempotent folder creation, uploads with parent creation, version listing, and restoring existing versions. Remaining gaps are drive create/update/delete, item move/rename/delete, adding new versions to existing files, comments/activity, and permissions/members.
|
|
287
287
|
- HR: departments, nested departments, staff mixins, managers, subscribers, team leads, request types, PTO/sick/overtime/remote requests, public holidays, and schedule/table reports.
|
|
288
288
|
- Recruiting: vacancies, talents/candidates, applications, matches, reviews, verdicts/opinions, vacancy-company lists, skills, and recruiting-specific custom fields/relations.
|
|
289
289
|
- Surveys and polls: survey CRUD, poll creation/attachment, survey question data, completion status, and results.
|
|
@@ -294,7 +294,7 @@ Planned feature surfaces:
|
|
|
294
294
|
- Contacts: person channels, social identities, provider discovery, contact statuses, notes/comments, person attachments, person merge, employee invite/create/kick/reinvite, and inactive employee management.
|
|
295
295
|
- Calendar: calendar CRUD/config, external calendar sync metadata, primary calendar management, schedule objects, participant mutations, and RSVP/status support when stable.
|
|
296
296
|
- Team planner and schedule reporting: team agendas, workload/capacity summaries, and visibility-aware free/busy views across members/projects.
|
|
297
|
-
- Virtual office and meetings: offices, floors, rooms, access/language/default recording/transcription settings, meeting schedules, active participants, room info, meeting minutes,
|
|
297
|
+
- Virtual office and meetings: offices, floors, rooms, access/language/default recording/transcription settings, meeting schedules, active participants, room info, meeting notes/transcript records (minutes), recordings, and device preferences.
|
|
298
298
|
- Chat and communication: direct-message send/update/delete, group DMs, channel member mutations, join/leave/request access, archive/unarchive, star/favorite channels, close/reopen conversations, pinned messages, message attachments, translation, applets, in-message polls, and guest communication settings.
|
|
299
299
|
- Notifications and activity: mark unread, unarchive, hide/unhide/mute contexts, unsubscribe per context/type, notification type settings, collaborators, pin/unpin activity messages, generic activity replies, filters, references, mentions, and update-message introspection.
|
|
300
300
|
- Attachments and media: saved attachments, photos, drawings, embeddings, previews/preview metadata, and friendly wrappers for additional object types.
|
|
@@ -322,7 +322,7 @@ SDK upgrade revisit:
|
|
|
322
322
|
<!-- AUTO-GENERATED from src/mcp/tools/ descriptions. Do not edit manually. Run `pnpm update-readme` to regenerate. -->
|
|
323
323
|
## Available Tools
|
|
324
324
|
|
|
325
|
-
**`TOOLSETS` categories:** `projects`, `issues`, `comments`, `milestones`, `documents`, `storage`, `attachments`, `contacts`, `channels`, `calendar`, `time tracking`, `search`, `associations`, `activity`, `notifications`, `workspace`, `cards`, `custom-fields`, `labels`, `leads`, `planner`, `processes`, `sdk-discovery`, `spaces`, `tag-categories`, `tags`, `task-management`, `test-management`, `user-statuses`
|
|
325
|
+
**`TOOLSETS` categories:** `projects`, `issues`, `comments`, `milestones`, `documents`, `storage`, `attachments`, `contacts`, `channels`, `calendar`, `time tracking`, `search`, `associations`, `activity`, `notifications`, `workspace`, `cards`, `custom-fields`, `drive`, `labels`, `leads`, `planner`, `processes`, `sdk-discovery`, `spaces`, `tag-categories`, `tags`, `task-management`, `test-management`, `user-statuses`, `virtual-office`
|
|
326
326
|
|
|
327
327
|
### Projects
|
|
328
328
|
|
|
@@ -480,6 +480,11 @@ SDK upgrade revisit:
|
|
|
480
480
|
| `create_event` | Create a new calendar event. Description supports markdown formatting. Optional calendarId targets a specific calendar; when omitted, the event uses the authenticated user's primary personal calendar. Returns the created event ID. |
|
|
481
481
|
| `update_event` | Update fields on an existing calendar event. Only provided fields are modified. Description updates support markdown. |
|
|
482
482
|
| `delete_event` | Permanently delete a calendar event. This action cannot be undone. |
|
|
483
|
+
| `list_schedules` | List calendar scheduling links/availability schedules. Optional owner accepts an employee/person ID, exact name, or email. |
|
|
484
|
+
| `get_schedule` | Retrieve one calendar schedule including owner, availability, calendar target, time zone, and room information when it is a meeting schedule. |
|
|
485
|
+
| `create_schedule` | Create a calendar schedule. Owner accepts an employee/person ID, exact name, or email; calendar can be targeted by calendarId or calendarName. |
|
|
486
|
+
| `update_schedule` | Update a calendar schedule. Supports owner, title, description, duration, interval, availability, timeZone, and calendar move by calendarId or calendarName. |
|
|
487
|
+
| `delete_schedule` | Delete a calendar schedule by scheduleId. |
|
|
483
488
|
| `list_recurring_events` | List recurring event definitions. Returns recurring events sorted by modification date (newest first). |
|
|
484
489
|
| `create_recurring_event` | Create a new recurring calendar event with RFC5545 RRULE rules. Description supports markdown. Optional calendarId targets a specific calendar; when omitted, the event uses the authenticated user's primary personal calendar. Returns the created event ID. |
|
|
485
490
|
| `list_event_instances` | List instances of a recurring event. Returns instances sorted by date. Supports filtering by date range. Use includeParticipants=true to fetch full participant info (extra lookups). |
|
|
@@ -557,7 +562,7 @@ SDK upgrade revisit:
|
|
|
557
562
|
| `get_user_profile` | Get the current user's profile information including bio, location, and social links. |
|
|
558
563
|
| `update_user_profile` | Update the current user's profile. Supports bio, city, country, website, social links, and public visibility. |
|
|
559
564
|
| `update_guest_settings` | Update workspace guest settings. Control read-only guest access and guest sign-up permissions. |
|
|
560
|
-
| `create_access_link` | Create a Huly workspace access link.
|
|
565
|
+
| `create_access_link` | Create a Huly workspace access link. When role is omitted, role=GUEST. Supports anonymous reusable guest links by setting personalized=false with notBefore and expiration, and can restrict access to specific Huly space IDs via spaces. |
|
|
561
566
|
| `get_regions` | Get available regions for workspace creation. Returns region codes and display names. |
|
|
562
567
|
|
|
563
568
|
### Cards
|
|
@@ -580,6 +585,19 @@ SDK upgrade revisit:
|
|
|
580
585
|
| `get_custom_field_values` | Read custom field values from a document. Pass the document's ID and class (from list_cards, list_issues, etc.). Returns all custom field values found on the document with their labels and types. |
|
|
581
586
|
| `set_custom_field` | Set a custom field value on a document. Requires the document ID, class, field ID (from list_custom_fields), and value. Values are auto-parsed: numbers from numeric strings, booleans from 'true'/'false', strings as-is. |
|
|
582
587
|
|
|
588
|
+
### Drive
|
|
589
|
+
|
|
590
|
+
| Tool | Description |
|
|
591
|
+
|------|-------------|
|
|
592
|
+
| `list_drives` | List Huly Drive spaces. When includeArchived is omitted, includeArchived=undefined. Use this before path operations when you do not know the exact drive id or exact drive name. |
|
|
593
|
+
| `get_drive` | Get one Huly Drive by exact drive id or exact drive name. If an exact name is ambiguous, the error includes candidate ids so the next call can use the id. |
|
|
594
|
+
| `list_drive_items` | List children under a folder path in a Drive. Paths are POSIX-like and normalized to absolute; '/' lists the root. Duplicate same-parent titles fail with candidate ids instead of guessing. |
|
|
595
|
+
| `get_drive_item` | Get one Drive folder or file by either exact itemId or path. Provide only one locator. File results include current version, size, MIME type, and download URL when available. |
|
|
596
|
+
| `create_drive_folder` | Idempotently create a Drive folder path, creating missing parents like mkdir -p. Returns created=false when the full folder path already exists. |
|
|
597
|
+
| `upload_drive_file` | Upload a file into Drive at a full path including filename. Provide exactly one source: filePath, fileUrl, or base64 data. By default createParents=true creates missing parent folders and reports them. |
|
|
598
|
+
| `list_drive_file_versions` | List versions for a Drive file resolved by file id or file path. Marks the current version and includes blob id, size, MIME type, lastModified, and download URL. |
|
|
599
|
+
| `restore_drive_file_version` | Restore an existing Drive file version by version id or numeric version. Idempotent when the requested version is already current and does not increment the file version counter. |
|
|
600
|
+
|
|
583
601
|
### Labels
|
|
584
602
|
|
|
585
603
|
| Tool | Description |
|
|
@@ -603,7 +621,7 @@ SDK upgrade revisit:
|
|
|
603
621
|
|------|-------------|
|
|
604
622
|
| `list_todos` | List Huly Planner ToDos. Empty input returns up to 50 ToDos in planner order with all completion states. Use owner, issue, title, due date, priority, visibility, or completion filters to narrow results. |
|
|
605
623
|
| `get_todo` | Get one Planner ToDo by raw todoId or by human locator such as issue + title + owner. Returns stable ToDo fields, owner, attachment context, description, labels count, and work slot count. |
|
|
606
|
-
| `create_todo` | Create a Planner ToDo. Omit attachedTo for a personal ToDo, or pass attachedTo.type=issue with project and identifier for an issue action item.
|
|
624
|
+
| `create_todo` | Create a Planner ToDo. Omit attachedTo for a personal ToDo, or pass attachedTo.type=issue with project and identifier for an issue action item. Omit owner to use the authenticated user. |
|
|
607
625
|
| `update_todo` | Update a Planner ToDo by human locator or raw todoId. Supports title, markdown description, owner, dueDate including null to clear, priority, and visibility. |
|
|
608
626
|
| `complete_todo` | Complete a Planner ToDo by setting doneOn. Huly may trim future work slots and run issue automation when the ToDo is attached to an issue. |
|
|
609
627
|
| `reopen_todo` | Reopen a completed Planner ToDo by clearing doneOn. Human locators search completed ToDos by default; raw todoId locators target that exact ToDo. |
|
|
@@ -634,7 +652,7 @@ SDK upgrade revisit:
|
|
|
634
652
|
|
|
635
653
|
| Tool | Description |
|
|
636
654
|
|------|-------------|
|
|
637
|
-
| `list_spaces` | List generic Huly spaces across modules.
|
|
655
|
+
| `list_spaces` | List generic Huly spaces across modules. When includeArchived is omitted, includeArchived=undefined. Returns raw space id, class, type, privacy, archived, autoJoin, member count, and owner count so module-specific tools can reuse the result. |
|
|
638
656
|
| `get_space` | Get one generic Huly space by raw space _id or exact space name. Resolution tries _id first, then exact name. If a name matches multiple spaces, pass class and/or type to narrow; ambiguous errors include matching ids/classes/types. |
|
|
639
657
|
| `list_space_types` | List configured Huly SpaceType records. Returns descriptor id, base class, target class, default members, autoJoin, and role count for discovering typed-space configuration. |
|
|
640
658
|
| `get_space_type` | Get one Huly SpaceType by raw SpaceType _id or exact name, including descriptor metadata, role definitions, role permission ids/labels, and available permissions. |
|
|
@@ -648,7 +666,7 @@ SDK upgrade revisit:
|
|
|
648
666
|
|
|
649
667
|
| Tool | Description |
|
|
650
668
|
|------|-------------|
|
|
651
|
-
| `list_tag_categories` | List tag/label categories in the workspace. Categories group labels (e.g., 'Priority Labels', 'Type Labels').
|
|
669
|
+
| `list_tag_categories` | List tag/label categories in the workspace. Categories group labels (e.g., 'Priority Labels', 'Type Labels'). Omit targetClass to include all classes. |
|
|
652
670
|
| `create_tag_category` | Create a new tag/label category. Idempotent: returns existing category if one with the same label and targetClass already exists (created=false). Defaults targetClass to tracker issues. |
|
|
653
671
|
| `update_tag_category` | Update a tag/label category. Accepts category ID or label name. Only provided fields are modified. |
|
|
654
672
|
| `delete_tag_category` | Permanently delete a tag/label category. Accepts category ID or label name. Labels in this category will be orphaned (not deleted). This action cannot be undone. |
|
|
@@ -715,6 +733,23 @@ SDK upgrade revisit:
|
|
|
715
733
|
|------|-------------|
|
|
716
734
|
| `list_user_statuses` | List Huly user presence records. Returns account UUIDs, online status, and last modified timestamp. Use this to check who is currently connected; presence is maintained by Huly server sessions. Filter by online or account UUID. |
|
|
717
735
|
|
|
736
|
+
### Virtual-Office
|
|
737
|
+
|
|
738
|
+
| Tool | Description |
|
|
739
|
+
|------|-------------|
|
|
740
|
+
| `list_office_floors` | List virtual office floors. |
|
|
741
|
+
| `get_office_floor` | Get one virtual office floor by floorId. |
|
|
742
|
+
| `list_office_rooms` | List virtual office rooms, including access mode, type, floor, floor-plan position/size, language, and recording/transcription defaults. |
|
|
743
|
+
| `get_office_room` | Get one virtual office room by roomId, including description when readable. |
|
|
744
|
+
| `list_offices` | List personal office rooms and their assigned people when readable. |
|
|
745
|
+
| `get_office` | Get one personal office room by roomId, including assigned person and description when readable. |
|
|
746
|
+
| `list_active_room_info` | List transient active room occupancy summaries. |
|
|
747
|
+
| `list_active_room_participants` | List transient active virtual-office participants and positions, optionally filtered by roomId. |
|
|
748
|
+
| `list_meeting_minutes` | List meeting notes/transcript records (minutes) by optional attachment target and created-on range. |
|
|
749
|
+
| `get_meeting_minutes` | Get one meeting notes/transcript record (minutes) by meetingMinutesId, including description when readable. |
|
|
750
|
+
| `list_device_preferences` | List readable virtual-office media device preferences. |
|
|
751
|
+
| `list_office_defaults` | List room-level language, default recording, and default transcription settings. |
|
|
752
|
+
|
|
718
753
|
<!-- tools:end -->
|
|
719
754
|
|
|
720
755
|
## Troubleshooting
|