Huly MCP
The Huly MCP server enables programmatic interaction with Huly's project management and collaboration platform through a standardized MCP interface.
Project Management
Create, list, update, and delete projects with custom identifiers and statuses
Preview deletion impacts before executing destructive operations
Issue Tracking
Full CRUD on issues with markdown support, filtering by project, status, assignee, component, parent, title, or description
Manage sub-issues, move issues between parents, add/remove labels and components
Create and manage issue templates; create issues from templates with overrides
Add/remove relations between issues (blocks, is-blocked-by, relates-to) and link/unlink documents
Components & Milestones
Create, update, and delete components and milestones with target dates
Comments
List, add, update, and delete comments on issues (markdown supported)
Labels & Tag Categories
Manage global labels and organize them into categories
Documents & Teamspaces
Full CRUD on teamspaces and documents with markdown and Mermaid diagram support
Edit documents via full-replace or targeted search-and-replace; list inline comment threads
File Storage & Attachments
Upload files via local path, URL, or base64; manage attachments on any Huly object
Pin/unpin attachments and get download URLs
Contacts & Organizations
List, create, update, and delete persons, employees, and organizations
Messaging & Channels
Full CRUD on channels; send and retrieve messages with thread reply support
List direct message conversations
Cards & Custom Fields
Manage card spaces, master tags, and cards with markdown content
List custom field definitions and read/set custom field values on any entity
Calendar & Events
Create, list, update, and delete calendar events including all-day, recurring (RFC5545 RRULE), and multi-participant events
Time Tracking
Log time on issues, retrieve time reports and breakdowns by issue/employee
Manage work slots; start and stop client-side timers
Search
Global full-text search across all Huly content (issues, documents, messages, etc.)
Activity, Reactions & Notifications
List activity messages; add/remove emoji reactions; save/bookmark messages; list @mentions
List, read, archive, and delete notifications; manage notification settings and get unread counts
Workspace Administration
List members, update roles, create/delete workspaces, manage user profiles and guest settings
Test Management
Manage test projects, suites, cases, plans, and runs
Execute test plans and track results (untested, blocked, passed, failed)
@firfi/huly-mcp
MCP server for Huly integration.
Installation
The standard configuration works with most MCP clients:
{
"mcpServers": {
"huly": {
"command": "npx",
"args": ["-y", "@firfi/huly-mcp@latest"],
"env": {
"HULY_URL": "https://huly.app",
"HULY_EMAIL": "your@email.com",
"HULY_PASSWORD": "yourpassword",
"HULY_WORKSPACE": "yourworkspace"
}
}
}
}Use Codex's MCP manager:
codex mcp add huly \
--env HULY_URL=https://huly.app \
--env HULY_EMAIL=your@email.com \
--env HULY_PASSWORD=yourpassword \
--env HULY_WORKSPACE=yourworkspace \
-- npx -y @firfi/huly-mcp@latestOr add it directly to ~/.codex/config.toml:
[mcp_servers.huly]
command = "npx"
args = ["-y", "@firfi/huly-mcp@latest"]
[mcp_servers.huly.env]
HULY_URL = "https://huly.app"
HULY_EMAIL = "your@email.com"
HULY_PASSWORD = "yourpassword"
HULY_WORKSPACE = "yourworkspace"claude mcp add huly \
-e HULY_URL=https://huly.app \
-e HULY_EMAIL=your@email.com \
-e HULY_PASSWORD=yourpassword \
-e HULY_WORKSPACE=yourworkspace \
-- npx -y @firfi/huly-mcp@latestOr add to ~/.claude.json using the standard config above.
Add the standard config to your claude_desktop_config.json:
macOS:
~/Library/Application Support/Claude/claude_desktop_config.jsonWindows:
%APPDATA%\Claude\claude_desktop_config.json
Add with Command Palette → "MCP: Add Server", or put this in a VS Code MCP config such as .vscode/mcp.json. Do not commit workspace config files that contain real credentials.
{
"servers": {
"huly": {
"command": "npx",
"args": ["-y", "@firfi/huly-mcp@latest"],
"env": {
"HULY_URL": "https://huly.app",
"HULY_EMAIL": "your@email.com",
"HULY_PASSWORD": "yourpassword",
"HULY_WORKSPACE": "yourworkspace"
}
}
}
}Add the standard config to ~/.cursor/mcp.json, or via Settings → Tools & Integrations → New MCP Server.
Add the standard config to your Windsurf MCP configuration file.
Open the global configuration file (~/.config/opencode/opencode.json) and merge this entry into your config:
{
"mcp": {
"huly": {
"type": "local",
"command": ["npx", "-y", "@firfi/huly-mcp@latest"],
"environment": {
"HULY_URL": "https://huly.app",
"HULY_EMAIL": "your@email.com",
"HULY_PASSWORD": "yourpassword",
"HULY_WORKSPACE": "yourworkspace"
}
}
}
}Updating
The @latest tag asks the package runner for the newest version. Some MCP clients keep server processes or resolved installs alive, so restart or re-add the server when updating:
Client | How to update |
Codex |
|
Claude Code |
|
Claude Desktop | Restart the app (it runs |
VS Code / Cursor | Restart the MCP server from the command palette/configured client or reload the window |
OpenCode | Restart OpenCode or start a new session after config changes |
npx (manual) |
|
HTTP Transport
By default, the server uses stdio transport. For HTTP transport (Streamable HTTP):
HULY_URL=https://huly.app \
HULY_EMAIL=your@email.com \
HULY_PASSWORD=yourpassword \
HULY_WORKSPACE=yourworkspace \
MCP_TRANSPORT=http \
npx -y @firfi/huly-mcp@latestServer listens on http://127.0.0.1:3000/mcp by default.
Configure with MCP_HTTP_PORT and MCP_HTTP_HOST:
MCP_TRANSPORT=http MCP_HTTP_PORT=8080 MCP_HTTP_HOST=0.0.0.0 npx -y @firfi/huly-mcp@latestFor hosted or tunneled HTTP deployments, you can require an MCP endpoint bearer token:
MCP_TRANSPORT=http \
MCP_AUTH_TOKEN="$(openssl rand -hex 32)" \
npx -y @firfi/huly-mcp@latestHTTP clients must then send:
Authorization: Bearer <MCP_AUTH_TOKEN>MCP_AUTH_TOKEN protects only the MCP HTTP /mcp endpoint. It is unrelated to HULY_TOKEN, does not authenticate to Huly, and does not replace HULY_EMAIL / HULY_PASSWORD / HULY_TOKEN. Huly credentials are still required through process env vars or, for hosted URL deployments, the supported x-huly-* headers. Stdio deployments do not use MCP_AUTH_TOKEN.
Hosted HTTP Header Configuration
For hosted URL deployments, keep the server process configured with MCP_TRANSPORT=http. A hosting layer can forward per-session Huly credentials as request headers, so one hosted server can serve different Huly workspaces without process-wide HULY_* env vars.
Supported v1 headers:
Header | Required | Description |
| Yes | Huly instance URL |
| Yes | Workspace identifier |
| Yes | Huly API token |
| No | Connection timeout in ms |
If any x-huly-* header is present, all required headers must be present. Missing values are not filled from environment variables. Email/password auth is not supported in hosted header configuration v1.
For a Smithery publish schema example, see docs/SMITHERY_URL_PUBLISH.md.
Environment Variables
Variable | Required | Description |
| Yes | Huly instance URL |
| Auth* | Account email |
| Auth* | Account password |
| Auth* | API token (alternative to email/password) |
| Yes | Workspace identifier |
| No | Connection timeout in ms (default: 30000) |
| No | Transport type: |
| No | HTTP server port (falls back to |
| No | HTTP server host (default: 127.0.0.1) |
| No | Optional bearer token required by HTTP clients for |
| No | Comma-separated tool categories to expose. If unset, all tools are exposed. Example: |
*Auth: Provide either HULY_EMAIL + HULY_PASSWORD or HULY_TOKEN.
Built-in Diagnostic Tools
get_version returns the current server version and latest npm version.
get_huly_context returns sanitized runtime/configuration context for the current MCP session without connecting to Huly. It reports package version, transport, auth mode, sanitized Huly URL origin/host/protocol, workspace, timeout, config sources, and toolset filtering. Tokens, passwords, email values, credential headers, URL paths, URL query strings, and URL credentials are never returned.
MCP Resources
The server exposes read-only MCP Resources as JSON context for clients that support resources/read.
Template | Name | Description | MIME Type |
|
| Read full details for a Huly tracker project by project identifier, for example huly://projects/HULY. |
|
|
| Read full details for a Huly issue by full issue identifier, for example huly://issues/HULY-123. |
|
|
| Read full details for a Huly issue by project identifier and issue number, for example huly://projects/HULY/issues/123. |
|
resources/list returns concrete active project resources. Issue resources are template-based: use resources/templates/list to discover supported issue URI templates, then read a known issue URI.
Resource roadmap:
Return resource links from list/search tool results for direct
resources/readfollow-up.Add document resources when document reads have a stable URI shape and context-friendly payload.
Consider scoped/paginated issue listing only when filters prevent very large
resources/listresponses.Consider resource
subscribeandlistChangedsupport after stateful sessions and a Huly change source are available.
Available Tools
TOOLSETS categories: projects, issues, comments, milestones, documents, storage, attachments, contacts, channels, calendar, time tracking, search, associations, activity, notifications, workspace, cards, custom-fields, labels, leads, processes, tag-categories, tags, task-management, test-management, user-statuses
Projects
Tool | Description |
| List all Huly projects. Returns projects sorted by name. Supports filtering by archived status. |
| Get full details of a Huly project including its statuses. Returns project name, description, archived flag, default status, and all available statuses. |
| List all issue statuses for a Huly project with workflow category and default info. Returns status name, category, and isDefault. Use this to discover valid statuses before creating or updating issues. |
| Create a new Huly tracker project. Idempotent: returns existing project if one with the same identifier already exists (created=false). Identifier must be 1-5 uppercase alphanumeric chars starting with a letter. |
| Update a Huly project. Only provided fields are modified. Set description to null to clear it. |
| Permanently delete a Huly project. All issues, milestones, and components in this project will be orphaned. This action cannot be undone. |
Issues
Tool | Description |
| Preview the impact of deleting a Huly entity before actually deleting it. Shows affected sub-entities, relations, and warnings. Supports issues, projects, components, and milestones. Use this to understand cascade effects before calling a delete operation. |
| Query Huly issues with optional filters. Returns issues sorted by modification date (newest first). Supports filtering by project, exact workflow status name (status), Huly SDK task.statusCategory key (statusCategory: UnStarted, ToDo, Active, Won, Lost), assignee, component, and parentIssue (to list children of a specific issue). Supports searching by title substring (titleSearch) and description content (descriptionSearch). |
| Retrieve full details for a Huly issue including markdown description. Use this to view issue content, comments, or full metadata. |
| Create a new issue in a Huly project. Optionally set taskType by ID or display name; it is resolved within the target project's project type, and status is validated against that task type's workflow. Use list_task_types or get_project_type to discover valid task types and statuses. Optionally create as a sub-issue by specifying parentIssue. Description supports markdown formatting. Returns the created issue identifier. |
| Update fields on an existing Huly issue. Optionally set taskType by ID or display name; it is resolved within the target project's project type, and the status is preserved only when valid for the new task type. Use list_task_types or get_project_type to discover valid task types and statuses. Only provided fields are modified. Description updates support markdown. |
| Add a tag/label to a Huly issue. Creates the tag if it doesn't exist in the project. |
| Remove a tag/label from a Huly issue. Detaches the label reference; does not delete the label definition. |
| Permanently delete a Huly issue. This action cannot be undone. |
| Move an issue to a new parent (making it a sub-issue) or to top-level (null). Updates parent/child relationships and sub-issue counts. |
| List components in a Huly project. Components organize issues by area/feature. Returns components sorted by modification date (newest first). |
| Retrieve full details for a Huly component. Use this to view component content and metadata. |
| Create a new component in a Huly project. Components help organize issues by area/feature. Returns the created component ID and label. |
| Update fields on an existing Huly component. Only provided fields are modified. |
| Set or clear the component on a Huly issue. Pass null for component to clear it. |
| Permanently delete a Huly component. This action cannot be undone. |
| List issue templates in a Huly project. Templates define reusable issue configurations. Returns templates sorted by modification date (newest first). |
| Retrieve full details for a Huly issue template including children (sub-task templates). Use this to view template content, default values, and child template IDs. |
| Create a new issue template in a Huly project. Templates define default values for new issues. Optionally include children (sub-task templates) that will become sub-issues when creating issues from this template. Returns the created template ID and title. |
| Create a new issue from a template. Applies template defaults, allowing overrides for specific fields. If the template has children (sub-task templates), sub-issues are created automatically unless includeChildren is set to false. Returns the created issue identifier and count of children created. |
| Update fields on an existing Huly issue template. Only provided fields are modified. |
| Permanently delete a Huly issue template. This action cannot be undone. |
| Add a child (sub-task) template to an issue template. The child defines default values for sub-issues created when using create_issue_from_template. Returns the child template ID. |
| Remove a child (sub-task) template from an issue template by its child ID. Get child IDs from get_issue_template response. |
| Add a relation between two issues. Relation types: 'blocks' (source blocks target — pushes into target's blockedBy), 'is-blocked-by' (source is blocked by target — pushes into source's blockedBy), 'relates-to' (bidirectional link — updates both sides). targetIssue accepts cross-project identifiers like 'OTHER-42'. No-op if the relation already exists. |
| Remove a relation between two issues. Mirrors add_issue_relation: 'blocks' pulls from target's blockedBy, 'is-blocked-by' pulls from source's blockedBy, 'relates-to' pulls from both sides. No-op if the relation doesn't exist. |
| List all relations of an issue. Returns blockedBy (issues blocking this one), blocks (issues this one blocks), relations (bidirectional issue links), and documents (linked documents with title/teamspace). |
| Link a Huly document to an issue. The link appears in the issue's Relations panel in the UI. Idempotent: no-op if the document is already linked. Use list_issue_relations to see linked documents. |
| Remove a document link from an issue. Idempotent: no-op if the document is not linked. |
Comments
Tool | Description |
| List comments on a Huly issue. Returns comments sorted by creation date (oldest first). |
| Add a comment to a Huly issue. Comment body supports markdown formatting. |
| Update an existing comment on a Huly issue. Comment body supports markdown formatting. |
| Delete a comment from a Huly issue. This action cannot be undone. |
Milestones
Tool | Description |
| List milestones in a Huly project. Returns milestones sorted by modification date (newest first). |
| Retrieve full details for a Huly milestone. Use this to view milestone content and metadata. |
| Create a new milestone in a Huly project. Returns the created milestone ID and label. |
| Update fields on an existing Huly milestone. Only provided fields are modified. |
| Set or clear the milestone on a Huly issue. Pass null for milestone to clear it. |
| Permanently delete a Huly milestone. This action cannot be undone. |
Documents
Tool | Description |
| List all Huly document teamspaces. Returns teamspaces sorted by name. Supports filtering by archived status. |
| Get details for a Huly document teamspace including document count. Finds by name or ID, including archived teamspaces. |
| Create a new Huly document teamspace. Idempotent: returns existing teamspace if one with the same name exists. |
| Update fields on an existing Huly document teamspace. Only provided fields are modified. Set description to null to clear it. |
| Permanently delete a Huly document teamspace. This action cannot be undone. |
| List documents in a Huly teamspace. Returns documents sorted by modification date (newest first). Each result includes a 'url' field pointing to the document in the Huly web app. Supports searching by title substring (titleSearch) and content (contentSearch). |
| Retrieve full details for a Huly document including markdown content and a 'url' field pointing to the document in the Huly web app. Use this to view document content and metadata. |
| Create a new document in a Huly teamspace. Content supports full markdown including native Mermaid diagrams (```mermaid blocks render interactively in Huly UI). Optionally pass parent as a document title or ID to create a nested child document; invalid parents fail instead of silently creating a top-level document. Returns the created document id and a 'url' field pointing to the document in the Huly web app. Use link_document_to_issue to associate the document with a tracker issue. |
| Edit an existing Huly document. Two content modes (mutually exclusive): (1) 'content' for full replace, (2) 'old_text' + 'new_text' for targeted search-and-replace. Multiple matches error unless replace_all is true. Empty new_text deletes matched text. Also supports renaming via 'title'. Content supports full markdown including native Mermaid diagrams. Returns a 'url' field pointing to the document in the Huly web app. |
| List inline comment threads from a Huly document. Extracts comments embedded in document content as ProseMirror marks. Each comment includes the highlighted text and thread ID. Set includeReplies=true to also fetch thread reply messages with sender names. |
| Permanently delete a Huly document. This action cannot be undone. |
Storage
Tool | Description |
| Upload a file to Huly storage. Provide ONE of: filePath (local file - preferred), fileUrl (fetch from URL), or data (base64 - for small files only). Returns blob ID and URL for referencing the file. |
Attachments
Tool | Description |
| List attachments on a Huly object (issue, document, etc.). Returns attachments sorted by modification date (newest first). |
| Retrieve full details for a Huly attachment including download URL. |
| Add an attachment to a Huly object. Provide ONE of: filePath (local file - preferred), fileUrl (fetch from URL), or data (base64). Returns the attachment ID and download URL. |
| Update attachment metadata (description, pinned status). |
| Permanently delete an attachment. This action cannot be undone. |
| Pin or unpin an attachment. |
| Get download URL for an attachment along with file metadata (name, type, size). |
| Add an attachment to a Huly issue. Convenience method that finds the issue by project and identifier. Provide ONE of: filePath, fileUrl, or data. |
| Add an attachment to a Huly document. Convenience method that finds the document by teamspace and title/ID. Provide ONE of: filePath, fileUrl, or data. |
Contacts
Tool | Description |
| List all persons in the Huly workspace. Returns persons sorted by modification date (newest first). Supports searching by name substring (nameSearch) and email substring (emailSearch). |
| Retrieve full details for a person including contact channels. Use personId or email to identify the person. |
| Create a new person in Huly. Returns the created person ID. |
| Update fields on an existing person. Only provided fields are modified. |
| Permanently delete a person from Huly. This action cannot be undone. |
| List employees (persons who are team members). Returns employees sorted by modification date (newest first). |
| List all organizations in the Huly workspace. Returns organizations sorted by modification date (newest first). |
| Create a new organization in Huly. Optionally add members by person ID or email. Fails if any requested member cannot be resolved. Returns the created organization ID. |
| Retrieve full details for an organization by ID or exact name when that name is unique - including city, description, member count, and modification timestamp. If multiple organizations share the same name, use the organization ID. |
| Update fields on an existing organization identified by ID or exact name when that name is unique. Only provided fields are modified. Description supports multi-line plain text and is the right place to store CRM notes / revenue summaries / context. Pass null to clear city or description. If multiple organizations share the same name, use the organization ID. |
| Permanently delete an organization identified by ID or exact name when that name is unique. Use with care - this cannot be undone. Useful for cleaning up duplicate organizations after merging their data elsewhere. If multiple organizations share the same name, use the organization ID. |
| Apply the Customer mixin to an organization so it appears in the Huly Leads > Customers view. Idempotent - safe to call on organizations that are already customers. Takes the organization ID or exact name when that name is unique. |
| Add a contact channel (phone, email, website/homepage, LinkedIn, Twitter, GitHub, Facebook, Telegram) to an organization identified by ID or exact unique name. Provider names: email, phone, linkedin, twitter, github, facebook, telegram, homepage. |
| Link a person as a member of an organization. The person appears under the org's Members tab in Huly. Use person ID or email to identify the person. Idempotent: returns added=false if that person is already a member. |
| List all persons who are members of an organization. Returns each member's person ID, name, and primary email (if any). When using a name instead of an ID, that name must identify exactly one organization. |
| List all organizations that a person is a member of. Provide personId or email. Returns each organization's ID and name. |
| Unlink a person from an organization's members. Reverses add_organization_member. Returns removed: false if the person was not a member. When using an organization name instead of an ID, that name must identify exactly one organization. |
Channels
Tool | Description |
| List all Huly channels. Returns channels sorted by name. Supports filtering by archived status. Supports searching by name substring (nameSearch) and topic substring (topicSearch). |
| Retrieve full details for a Huly channel including topic and member list. |
| Create a new channel in Huly. Returns the created channel ID and name. |
| Update fields on an existing Huly channel. Only provided fields are modified. |
| Permanently delete a Huly channel. This action cannot be undone. |
| List messages in a Huly channel. Returns messages sorted by date (newest first). |
| Send a message to a Huly channel. Message body supports markdown formatting. |
| Update a channel message. Only the body can be modified. |
| Permanently delete a channel message. This action cannot be undone. |
| List direct message conversations in Huly. Returns conversations sorted by date (newest first). |
| Open a one-to-one direct-message conversation with a workspace member. The |
| List messages in a direct-message conversation, newest first. The |
| Send a message to a direct-message conversation. The |
| Update a direct-message message. The |
| Permanently delete a direct-message message. The |
| List replies in a message thread. Returns replies sorted by date (oldest first). |
| Add a reply to a message thread. Reply body supports markdown formatting. |
| Update a thread reply. Only the body can be modified. |
| Permanently delete a thread reply. This action cannot be undone. |
Calendar
Tool | Description |
| List calendar events. Returns events sorted by date. Supports filtering by date range. |
| List writable, non-hidden calendars that can be used as create_event or create_recurring_event targets. Use this before creating events when you need to choose a target calendarId explicitly. |
| Retrieve full details for a calendar event including description. Use this to view event content and metadata. |
| 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. |
| Update fields on an existing calendar event. Only provided fields are modified. Description updates support markdown. |
| Permanently delete a calendar event. This action cannot be undone. |
| List recurring event definitions. Returns recurring events sorted by modification date (newest first). |
| 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. |
| 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). |
Time Tracking
Tool | Description |
| Log time spent on a Huly issue. Records a time entry with optional description. Time value is in minutes. |
| Get time tracking report for a specific Huly issue. Shows total time, estimation, remaining time, and all time entries. |
| List all time entries across issues. Supports filtering by project and date range. Returns entries sorted by date (newest first). |
| Get detailed time breakdown for a project. Shows total time grouped by issue and by employee. Supports date range filtering. |
| List scheduled work slots. Shows planned time blocks attached to ToDos. Supports filtering by employee and date range. |
| Create a scheduled work slot. Attaches a time block to a ToDo for planning purposes. |
| Start a client-side timer on a Huly issue. Validates the issue exists and returns a start timestamp. Use log_time to record the elapsed time when done. |
| Stop a client-side timer on a Huly issue. Returns the stop timestamp. Calculate elapsed time from start/stop timestamps and use log_time to record it. |
Search
Tool | Description |
| Perform a global fulltext search across all Huly content. Searches issues, documents, messages, and other indexed content. Returns matching items sorted by relevance (newest first). |
Associations
Tool | Description |
| List Huly association definitions: class-level typed links that define which document classes may be related. Use this before create_relation to discover association IDs, source/target classes, and whether relation writes are supported. |
| Idempotently create one Huly association definition between two non-system classes. Use sourceClass/targetClass with sourceRole/targetRole and cardinality; returns an existing identical association by default. |
| Idempotently delete one Huly association definition only when no concrete relations reference it. If relations exist, delete_relation must clean them up first; deleting an already-missing association is a successful no-op. |
| List concrete Huly relation instances under an association, optionally filtered by source and target documents. Endpoint locators support raw, issue, document, and card. Requires at least one filter to avoid broad workspace scans. |
| Idempotently create one concrete relation between two resolved documents for a writable association. Endpoint locators support raw, issue, document, and card. Enforces association endpoint classes, direction, duplicate handling, automation-only restrictions, and cardinality. |
| Idempotently delete one concrete relation by relation ID or by exact association/source/target triple. Triple endpoint locators support raw, issue, document, and card. Triple deletes use the same direction semantics as create_relation and fail if the selector is ambiguous. |
Activity
Tool | Description |
| List activity messages for a Huly issue, document, channel, or raw Huly object. Prefer friendly targets: project+issueIdentifier for issues, teamspace+document for documents, or channel for channels. Advanced callers may pass objectId+objectClass directly. Returns activity sorted by date (newest first). |
| Add an emoji reaction to an activity message. |
| Remove an emoji reaction from an activity message. |
| List reactions on an activity message. |
| Save/bookmark an activity message for later reference. |
| Remove an activity message from saved/bookmarks. |
| List saved/bookmarked activity messages. |
| List @mentions of the current user in activity messages. |
Notifications
Tool | Description |
| List inbox notifications. Returns notifications sorted by modification date (newest first). Supports filtering by read/archived status. |
| Retrieve full details for a notification. Use this to view notification content and metadata. |
| Mark a notification as read. |
| Mark all unread notifications as read. Returns the count of notifications marked. |
| Archive a notification. Archived notifications are hidden from the main inbox view. |
| Archive all notifications. Returns the count of notifications archived. |
| Permanently delete a notification. This action cannot be undone. |
| Get notification context for an entity. Returns tracking information for a specific object. |
| List notification contexts. Returns contexts sorted by last update timestamp (newest first). Supports filtering by pinned status. |
| Pin or unpin a notification context. Pinned contexts are highlighted in the inbox. |
| List notification provider settings. Returns current notification preferences. |
| Update notification provider setting. Enable or disable notifications for a specific provider. |
| Get the count of unread notifications. |
Workspace
Tool | Description |
| List members in the current Huly workspace with their roles. Returns members with account IDs and roles. |
| Update a workspace member's role. Requires appropriate permissions. Valid roles: READONLYGUEST, DocGuest, GUEST, USER, MAINTAINER, OWNER, ADMIN. |
| Get information about the current workspace including name, URL, region, and settings. |
| List all workspaces accessible to the current user. Returns workspace summaries sorted by last visit. |
| Create a new Huly workspace. Returns the workspace UUID and URL. Optionally specify a region. |
| Permanently delete the current workspace. This action cannot be undone. Use with extreme caution. |
| Get the current user's profile information including bio, location, and social links. |
| Update the current user's profile. Supports bio, city, country, website, social links, and public visibility. |
| Update workspace guest settings. Control read-only guest access and guest sign-up permissions. |
| Create a Huly workspace access link. Defaults to 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. |
| Get available regions for workspace creation. Returns region codes and display names. |
Cards
Tool | Description |
| List all Huly card spaces. Returns card spaces sorted by name. Card spaces are containers for cards. |
| List master tags (card types) available in a Huly card space. Master tags define the type/schema of cards that can be created in a space. |
| List cards in a Huly card space. Returns cards sorted by modification date (newest first). Supports filtering by type (master tag), title substring, and content search. |
| Retrieve full details for a Huly card including markdown content. Use this to view card content and metadata. |
| Create a new card in a Huly card space. Requires a master tag (card type). Content supports markdown formatting. Returns the created card id. |
| Update fields on an existing Huly card. Only provided fields are modified. Content updates support markdown. |
| Permanently delete a Huly card. This action cannot be undone. |
Custom-Fields
Tool | Description |
| List custom field definitions in the workspace. Returns fields with their labels, types, and owner class info. Custom fields are created in the Huly UI on Card types, Issue types, or other classes. Use targetClass to filter fields for a specific class. |
| 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. |
| 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. |
Labels
Tool | Description |
| List label/tag definitions in the workspace. Labels are global (not project-scoped). Returns labels for tracker issues sorted by modification date (newest first). |
| Create a new label/tag definition in the workspace. Labels are global and can be attached to any issue. Returns existing label if one with the same title already exists (created=false). Use add_issue_label to attach a label to a specific issue. |
| Update a label/tag definition. Accepts label ID or title. Only provided fields are modified. |
| Permanently delete a label/tag definition. Accepts label ID or title. This action cannot be undone. |
Leads
Tool | Description |
| List all Huly sales funnels (lead pipelines). Returns each funnel's stable ID and display name, sorted by name. Supports filtering by archived status. |
| Query Huly leads in a funnel with optional filters. Pass the funnel ID returned by list_funnels, or a funnel name for convenience lookup. Returns leads sorted by modification date (newest first). Supports filtering by status, assignee, and title search. |
| Retrieve full details for a Huly lead including markdown description, customer name, funnel ID and funnel name, and status. Lead identifiers follow the upstream Huly format like 'LEAD-1'. |
Processes
Tool | Description |
| List read-only Huly Process workflow definitions. Optionally filter by the master tag/card type that workflows attach to. Returns process IDs, names, attached card type, automation flags, and state/transition counts. |
| Get one Huly Process workflow definition by process ID or exact display name. If a name is ambiguous, the tool returns a typed error with candidate IDs instead of guessing. |
| List read-only Huly Process workflow executions. Supports filters by process ID/name, card/document ID/title, and status. Rows are enriched with process name, card title, and current state title when available. |
| Start a new active Huly Process workflow execution on a card/document. Accepts process ID or exact process name, and card/document ID or exact title; ambiguous names or titles fail with candidate IDs. This is not idempotent: each successful call creates a new execution unless the process forbids parallel active executions for the same card, in which case the existing active execution ID is returned in a typed error. |
| Idempotently cancel one Huly Process execution by execution ID. Active executions are marked cancelled; already-cancelled executions succeed with cancelled=false; completed executions fail without changing history. |
Tag-Categories
Tool | Description |
| List tag/label categories in the workspace. Categories group labels (e.g., 'Priority Labels', 'Type Labels'). Optional targetClass filter (defaults to all). |
| 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. |
| Update a tag/label category. Accepts category ID or label name. Only provided fields are modified. |
| 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. |
Tags
Tool | Description |
| List generic Huly tag definitions for one SDK target class. Use this for SDK-level tags such as recruiting skills or document labels. For Tracker issue labels, prefer list_labels. |
| Create a generic Huly tag definition for one targetClass. Idempotent by targetClass + title. This exposes the SDK tags model; for Tracker issue labels, prefer create_label. |
| Update a generic Huly tag definition. The tag argument accepts a tag ID or exact title, resolved within targetClass. |
| Delete a generic Huly tag definition by ID or exact title, resolved within targetClass. This deletes the tag definition, not only one object's tag reference. |
| List generic Huly TagReference rows attached to one raw object collection. Requires objectId, objectClass, space, and collection because this is an SDK-level tool. |
| Attach a generic Huly tag to one raw object collection. Requires targetClass for the tag definition and objectId/objectClass/space/collection for the TagReference. Idempotent for the same object, collection, and tag. |
| Detach a generic Huly tag from one raw object collection. Requires targetClass and objectId/objectClass/space/collection. Returns detached=false when the tag is not attached. |
Task-Management
Tool | Description |
| List Huly tracker project types/workflow templates. Returns ID, display name, descriptor, task type count, status count, and whether the type appears to be the default Classic tracker type. |
| Inspect one Huly tracker project type in a single call. Accepts projectType as ID or display name; when omitted, uses the unambiguous Classic tracker type. Returns task types, statuses, categories, and task-type-to-status mappings. |
| List Huly issue/task types. Optionally filter by projectType ID or display name. Returns task type identity, parent project type, kind, issue class, and available status count. |
| Add a Huly issue/task type to a project type idempotently by normalized name. Copies required workflow configuration from an existing template task type unless templateTaskType is supplied. Returns created, IDs, affected task type IDs, and a workspace-level workflow warning. |
| Add a Huly issue workflow status idempotently by normalized name within a project type and task type scope. Accepts category as a Huly SDK task.statusCategory key: UnStarted, ToDo, Active, Won, Lost; taskType may be ID or display name, and omission applies the status to every task type in the project type. |
Test-Management
Tool | Description |
| List test management projects. Returns test projects sorted by name. These are separate from tracker projects. |
| List test suites in a test project. Accepts project ID or name. Optional parent filter for nested suites. |
| Get a single test suite by ID or name within a test project. Returns suite details and test case count. |
| Create a test suite in a test project. Idempotent: returns existing suite if one with the same name exists (created=false). Optional parent for nesting. |
| Update a test suite. Accepts suite ID or name. Only provided fields are modified. |
| Permanently delete a test suite. Accepts suite ID or name. This action cannot be undone. |
| List test cases in a test project. Optional filters: suite (ID or name), assignee (name or email). |
| Get a single test case by ID or name within a test project. |
| Create a test case attached to a suite. Requires project and suite. Defaults: type=functional, priority=medium, status=draft. |
| Update a test case. Accepts test case ID or name. Only provided fields are modified. Set assignee to null to unassign. |
| Permanently delete a test case. Accepts test case ID or name. This action cannot be undone. |
| List test plans in a test management project. Returns plan names and IDs. Requires project ID or name. |
| Get test plan details including its items (test cases). Accepts plan ID or name within a project. |
| Create a test plan in a project. Idempotent: returns existing plan if one with the same name exists (created=false). |
| Update a test plan's name or description. Only provided fields are modified. Pass description=null to clear. |
| Permanently delete a test plan. This does not delete associated test runs. Cannot be undone. |
| Add a test case to a test plan. Resolves test case by ID or name. Optionally assign a person by email or name. |
| Remove a test case from a test plan by item ID. Get item IDs from get_test_plan. |
| List test runs in a test management project. Returns run names, IDs, and due dates. |
| Get test run details including all results. Accepts run ID or name within a project. |
| Create a test run in a project. For bulk creation from a plan, use run_test_plan instead. |
| Update a test run's name, description, or due date. Only provided fields are modified. Pass null to clear optional fields. |
| Permanently delete a test run. This does not delete associated test results. Cannot be undone. |
| List test results in a test run. Returns result names, statuses, and assignees. |
| Get test result details. Accepts result ID or name. |
| Create a test result in a run. Resolves test case by ID or name. Status defaults to 'untested'. |
| Update a test result's status, assignee, or description. Status values: untested, blocked, passed, failed. |
| Permanently delete a test result. Cannot be undone. |
| Execute a test plan: creates a test run and one test result per plan item. Returns the run ID and count of results created. Optionally name the run and set a due date. |
User-Statuses
Tool | Description |
| 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. |
Troubleshooting
Passwords with special characters
If your Huly password contains characters like *, %, !, or #, passing it via CLI environment flags such as -e or --env may fail because the shell interprets these characters before they reach the process.
Solution: Edit your MCP config file directly instead of passing the password through the shell:
Codex:
~/.codex/config.tomlClaude Code:
~/.claude.json(user scope) or.mcp.json(project scope)Claude Desktop:
claude_desktop_config.jsonin the location listed in the installation sectionVS Code and Cursor: use the client config location from the installation section; avoid committing workspace files that contain real credentials
Windsurf: edit your Windsurf MCP configuration file directly
OpenCode:
~/.config/opencode/opencode.json
For Claude JSON config, the shell-sensitive characters above can be written directly. JSON-reserved characters such as " and \ still need normal JSON escaping:
{
"mcpServers": {
"huly": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@firfi/huly-mcp@latest"],
"env": {
"HULY_URL": "https://your-huly-instance.com",
"HULY_EMAIL": "you@example.com",
"HULY_PASSWORD": "p@ss*w0rd!#%",
"HULY_WORKSPACE": "your-workspace"
}
}
}
}Alternatively, use HULY_TOKEN instead of email/password to bypass password auth entirely (see Environment Variables).
MCP client shows "Failed to reconnect"
After changing MCP configuration, some clients (including Claude Code) require a full restart — not just a reconnect. Exit the application completely and reopen it.
You can verify the connection works independently with:
claude mcp list # Should show "Connected"Self-hosted Huly: account locked after failed login attempts
Huly locks password login after 5 failed API authentication attempts. This commonly happens during initial setup when the password is misconfigured. The lock persists in the database across service restarts.
Symptoms: PasswordLoginLocked error from the MCP server, and the Huly web UI shows "Password login is locked due to too many failed attempts. Please use an OTP login method to unlock your account." (OTP won't work without SMTP configured.)
Fix — reset the lock counter in CockroachDB:
# Find your account UUID and check lock status
docker exec -e PGPASSWORD=<your_cockroach_password> <cockroach_container> \
cockroach sql --host=localhost --user=<db_user> --database=defaultdb --insecure \
-e "SELECT uuid, failed_login_attempts FROM global_account.account;"
# Reset the counter
docker exec -e PGPASSWORD=<your_cockroach_password> <cockroach_container> \
cockroach sql --host=localhost --user=<db_user> --database=defaultdb --insecure \
-e "UPDATE global_account.account SET failed_login_attempts = 0 WHERE uuid = '<your_account_uuid>';"The CockroachDB credentials can be found in your Huly compose.yml or via docker exec <cockroach_container> env | grep COCKROACH.
Windows-specific notes
Bash wrapper scripts (sourcing
.envfiles) may not work reliably when launched by MCP clients on Windows. Prefer setting env vars directly in the MCP config JSON.Docker pulls over SSH may fail on Windows due to credential manager issues. Pull images from the server desktop if needed.
Maintenance
Latest Blog Posts
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/dearlordylord/huly-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server