jlbyh2o/hudu-mcp

开发工具

本页由 AI 翻译，技术细节请以原文为准。查看原文

8 stars 7 forks 质量 70 趋势 16MIT

Repository Install

Hudu MCP

概览

A Model Context Protocol (MCP) server that integrates with HUDU for technical documentation and customer information management. This server allows Large Language Models (LLMs) to interact with HUDU's API to retrieve customer account information, knowledge base articles, assets, and more. - : Retrieve company information with advanced filtering - : Search and retrieve technical documentation articles with enhanced filters - : Access asset information with comprehensive search capabilities - : Retrieve user information and details - : Access network configurations and details - : Retrieve documented procedures and workflows - : Access detailed activity logs with filtering - : Retrieve asset layout definitions and schemas - : Access organizational folder structures - : Secure access to credential information - : Enhanced filtering across all resource types - : API key-based authentication with HUDU - : Built with TypeScript and Zod validation - : Comprehensive error handling and...

README

以下为原文 README 节选，完整内容请查看原文。

HUDU MCP Server

Features

Company/Customer Management: Retrieve company information with advanced filtering
Knowledge Base Access: Search and retrieve technical documentation articles with enhanced filters
Asset Management: Access asset information with comprehensive search capabilities
User Management: Retrieve user information and details
Network Management: Access network configurations and details
Procedure Management: Retrieve documented procedures and workflows
Activity Logging: Access detailed activity logs with filtering
Asset Layouts: Retrieve asset layout definitions and schemas
Folder Management: Access organizational folder structures
Password Management: Secure access to credential information
Advanced Search: Enhanced filtering across all resource types
Secure Authentication: API key-based authentication with HUDU
Type Safety: Built with TypeScript and Zod validation
Error Handling: Comprehensive error handling and logging

Prerequisites

Node.js 18.0.0 or higher
A HUDU instance with API access
HUDU API key (obtainable from your HUDU admin panel)

Installation

From NPM (Recommended)

npm install -g hudu-mcp

From Source

git clone https://github.com/jlbyh2o/hudu-mcp.git
cd hudu-mcp
npm install
npm run build

Configuration

The server requires two environment variables:

HUDU_API_KEY: Your HUDU API key (found in HUDU under Admin > API Keys)
HUDU_BASE_URL: Your HUDU instance base URL (domain only, do not include /api/v1)

Setting up Environment Variables

Copy the example environment file:
```
cp .env.example .env
```

Edit the .env file with your actual values:

HUDU_API_KEY=your_actual_api_key_here
HUDU_BASE_URL=https://your-company.huducloud.com

Important: The HUDU_BASE_URL should only contain your domain (e.g., https://your-company.huducloud.com). Do NOT include /api/v1 in the URL as this is automatically appended by the client.

Make sure your .env file is not committed to version control (it’s already in .gitignore)

Usage

Running the Server

Development mode:

npm run dev

Production mode:

npm start

Startup Validation

The MCP server automatically validates your API connection during startup by calling the /api_info endpoint. This ensures:

Your HUDU_API_KEY is valid and active
Your HUDU_BASE_URL is correct and accessible
Your API key has the necessary permissions

If validation fails, you’ll see a clear error message indicating the issue:

在 GitHub 查看完整 README

安装

This server does not publish a one-line install command.

Open the repository installation guide 新手？先看 mcpskill.org 教程 →

配置

{
  "mcpServers": {
    "hudu": {
      "command": "node",
      "args": ["/path/to/hudu-mcp/dist/index.js"],
      "env": {
        "HUDU_API_KEY": "your_api_key",
        "HUDU_BASE_URL": "https://your-hudu-instance.huducloud.com"
      }
    }
  }
}