huly-mcp-server
v1.0.9
Published
MCP Server implementation for Huly Platform API
Maintainers
Readme
Huly MCP Server
An MCP (Model Context Protocol) server implementation that provides access to Huly Platform API functionality. This server allows AI agents and LLM applications to interact with Huly projects, issues, and other platform features through the standardized MCP protocol.
Features
Tools
- list-issues: List issues in a Huly project with filtering and sorting options
- create-issue: Create new issues with title, description, priority, and assignment
- get-issue: Get detailed information about specific issues
- list-projects: List all available Huly projects
Resources
- project-info: Access detailed project information as JSON
- issue-details: Access detailed issue information as JSON
Prompts
- create-issue-template: Templates for creating well-structured issues (bug, feature, task, improvement)
- project-review-template: Templates for conducting project reviews (sprint, milestone, quarterly)
Installation
Using npx (Recommended)
No installation required! You can run the MCP server directly using npx:
npx -y huly-mcp-serverGlobal Installation
npm install -g huly-mcp-serverDevelopment Installation
git clone https://github.com/ThanabordeeN/hulyMCP.git
cd hulyMCP
npm install
npm run buildConfiguration
Copy the example environment file and configure your Huly connection:
cp .env.example .envEdit .env with your Huly server details:
# Huly server URL
HULY_URL=http://localhost:8087
# Workspace identifier
HULY_WORKSPACE=ws1
# Authentication (choose one method)
# Option 1: Token-based authentication
HULY_TOKEN=your_token_here
## Authentication
This project uses GitHub Packages for dependency management. To successfully download dependencies, you need to generate a GitHub personal access token and authenticate npm using that token.
1. Generate a GitHub Token
- Log in to your GitHub account
- Go to Settings > Developer settings > Personal access tokens (https://github.com/settings/personal-access-tokens)
- Click "Generate new token"
- Select the required scopes (at least `read:packages`)
- Generate the token and copy it
2. Authenticate with npm
```bash
npm login --registry=https://npm.pkg.github.comWhen prompted, enter your GitHub username and use the generated token as your password. Use your GitHub email when asked for an email address.
หมายเหตุ: ต้องทำขั้นตอนการยืนยันตัวตนนี้ถึงจะติดตั้ง dependencies ได้สำเร็จ
Option 2: Email/password authentication
[email protected] HULY_PASSWORD=your_password
## Usage
### Running directly with npx
```bash
npx -y huly-mcp-serverDevelopment Mode
npm run devProduction Mode
npm run build
npm startUsing with MCP Clients
This server communicates via stdin/stdout using the MCP protocol. You can integrate it with any MCP-compatible client.
Example with Claude Desktop
Option 1: Using npx (Recommended - No installation required)
Add to your Claude Desktop MCP configuration:
{
"mcpServers": {
"huly": {
"command": "npx",
"args": ["-y", "huly-mcp-server"],
"env": {
"HULY_URL": "http://localhost:8087",
"HULY_WORKSPACE": "ws1",
"HULY_EMAIL": "user1",
"HULY_PASSWORD": "1234"
}
}
}
}Option 2: Local installation
First install the package:
npm install -g huly-mcp-serverThen add to your Claude Desktop MCP configuration:
{
"mcpServers": {
"huly": {
"command": "huly-mcp-server",
"env": {
"HULY_URL": "http://localhost:8087",
"HULY_WORKSPACE": "ws1",
"HULY_EMAIL": "user1",
"HULY_PASSWORD": "1234"
}
}
}
}Option 3: Development/local build
Add to your Claude Desktop MCP configuration:
{
"mcpServers": {
"huly": {
"command": "node",
"args": ["/path/to/huly-mcp-server/dist/index.js"],
"env": {
"HULY_URL": "http://localhost:8087",
"HULY_WORKSPACE": "ws1",
"HULY_EMAIL": "user1",
"HULY_PASSWORD": "1234"
}
}
}
}Examples
List Issues
// Tool call: list-issues
{
"projectIdentifier": "HULY",
"limit": 10,
"sortBy": "modifiedOn",
"sortOrder": "desc"
}Create Issue
// Tool call: create-issue
{
"projectIdentifier": "HULY",
"title": "Fix login bug",
"description": "Users cannot log in with special characters in password",
"priority": "High"
}Get Project Information
// Resource: huly://project/HULY
// Returns detailed JSON information about the projectUse Issue Creation Template
// Prompt: create-issue-template
{
"projectType": "bug",
"urgency": "high"
}API Reference
Tools
list-issues
Lists issues in a specified Huly project.
Parameters:
projectIdentifier(string): Project identifier (e.g., "HULY")limit(number, optional): Maximum number of issues to return (default: 20)sortBy(enum, optional): Field to sort by - "modifiedOn", "createdOn", "title" (default: "modifiedOn")sortOrder(enum, optional): Sort order - "asc", "desc" (default: "desc")
create-issue
Creates a new issue in a Huly project.
Parameters:
projectIdentifier(string): Project identifiertitle(string): Issue titledescription(string, optional): Issue description in markdown formatpriority(enum, optional): Issue priority - "Urgent", "High", "Normal", "Low" (default: "Normal")assignee(string, optional): Assignee email or ID
get-issue
Gets detailed information about a specific issue.
Parameters:
issueIdentifier(string): Issue identifier (e.g., "HULY-123")
list-projects
Lists all available Huly projects.
Parameters:
limit(number, optional): Maximum number of projects to return (default: 50)
Resources
project-info
URI Pattern: huly://project/{identifier}
Returns detailed project information as JSON.
issue-details
URI Pattern: huly://issue/{identifier}
Returns detailed issue information as JSON.
Prompts
create-issue-template
Provides templates for creating well-structured issues.
Parameters:
projectType(enum): Type of issue - "bug", "feature", "task", "improvement"urgency(enum): Urgency level - "low", "medium", "high", "critical"
project-review-template
Provides templates for conducting project reviews.
Parameters:
projectIdentifier(string): Project identifier to reviewreviewType(enum): Type of review - "sprint", "milestone", "quarterly"
Requirements
- Node.js >= 18
- Access to a Huly Platform instance
- Valid Huly workspace and authentication credentials
Dependencies
This MCP server is built on:
- @modelcontextprotocol/sdk: MCP TypeScript SDK
- @hcengineering/*: Huly Platform API clients
License
MIT
