Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type @ followed by the MCP server name and your instructions, e.g., "@Hudu MCP Server Search Hudu for VPN articles"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Connect Claude AI to your Hudu IT documentation platform. Once installed, Claude can search, read, create, and update your Hudu knowledge base, assets, passwords, companies, and more — directly from any Claude interface.
This server implements the Model Context Protocol (MCP), giving Claude secure, structured access to the Hudu REST API. It runs as a local stdio process that Claude Desktop or Claude Code launches on demand.
Category | Tools |
Articles | list, get, create, update, delete, archive, unarchive |
Assets | list (global + per-company), get, create, update, delete, archive, unarchive, move layout |
Asset Layouts | list, get, create, update |
Asset Passwords | list, get, create, update, delete, archive, unarchive |
Companies | list, get, create, update, delete, archive, unarchive |
Expirations | list, update, delete |
Exports | list, get, create |
S3 Exports | create |
Flag Types | list, get, create, update, delete |
Flags | list, get, create, update, delete |
Folders | list, get, create, update, delete |
Groups | list, get |
IP Addresses | list, get, create, update, delete |
Lists | list, get, create, update, delete |
Magic Dash | list, upsert, delete (by title or ID), update positions |
Matchers | list, update, delete |
Networks | list, get, create, update, delete |
Password Folders | list, get, create, update, delete |
Photos | list, get, create, update, delete |
Public Photos | list, get, create, update |
Procedures | list, get, create, update, delete, kickoff, duplicate, create from template |
Procedure Tasks | list, get, create, update, delete |
Rack Storages | list, get, create, update, delete |
Rack Storage Items | list, get, create, update, delete |
Relations | list, create, delete |
Uploads | list, get, delete |
Users | list, get |
VLANs | list, get, create, update, delete |
VLAN Zones | list, get, create, update, delete |
Websites | list, get, create, update, delete |
Activity Logs | list, delete |
Navigation | jump to card, jump to company |
API Info | get version |
Related MCP server: HaloPSA API Gateway MCP Server
Node.js 18 or newer — nodejs.org
Claude Desktop or Claude Code
A Hudu API key — generate one at Hudu Admin → Basic Information → API Keys
Clone the repo into the standard install location and build:
git clone https://github.com/Allied-Business-Solutions/hudu-mcp.git "$env:LOCALAPPDATA\Programs\HuduMCP"
cd "$env:LOCALAPPDATA\Programs\HuduMCP"
npm install
npm run buildThis compiles the TypeScript source into dist/.
Open (or create) your Claude Desktop config file:
Windows: %APPDATA%\Claude\claude_desktop_config.json
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Add the hudu entry under mcpServers:
{
"mcpServers": {
"hudu": {
"command": "node",
"args": ["C:/Users/YOUR_USERNAME/AppData/Local/Programs/HuduMCP/dist/index.js"],
"env": {
"HUDU_API_KEY": "your_api_key_here",
"HUDU_BASE_URL": "https://your-instance.huducloud.com/api/v1"
}
}
}
}Replace YOUR_USERNAME with your Windows username, then fill in your API key and Hudu URL. Restart Claude Desktop.
Add to ~/.claude/settings.json (or .claude/settings.json in your project):
{
"mcpServers": {
"hudu": {
"command": "node",
"args": ["C:/Users/YOUR_USERNAME/AppData/Local/Programs/HuduMCP/dist/index.js"],
"env": {
"HUDU_API_KEY": "your_api_key_here",
"HUDU_BASE_URL": "https://your-instance.huducloud.com/api/v1"
}
}
}
}Replace YOUR_USERNAME with your Windows username, then fill in your API key and Hudu URL.
Variable | Description |
| Your Hudu API key (from Hudu Admin → Basic Information → API Keys) |
| Your Hudu instance API base URL, e.g. |
See .env.example for a template.
Once connected, you can ask Claude things like:
"Search Hudu for any articles about VPN setup and summarize what we have"
"Find all assets for Acme Corp and list their serial numbers"
"Create a new article called 'Windows 11 Deployment Guide' under the Acme Corp company with these steps: [paste steps]"
"Look up the password entry for the Acme firewall admin account"
"What procedures do we have documented for onboarding new employees?"
"Show me all SSL certificate expirations coming up in the next 30 days"
Tools don't appear in Claude
Verify the config file is valid JSON and the path to dist/index.js is correct (e.g. C:/Users/YOUR_USERNAME/AppData/Local/Programs/HuduMCP/dist/index.js). Restart Claude Desktop after any config change.
HUDU_API_KEY is required error
The env block in your Claude config is missing or the key name is wrong. Check that it's exactly HUDU_API_KEY.
HUDU_BASE_URL is required error
Same — check that HUDU_BASE_URL is set and ends with /api/v1.
401 Unauthorized from Hudu Your API key is invalid or expired. Generate a new one from Hudu Admin → Basic Information → API Keys.
Node.js not found Install Node.js 18+ from nodejs.org and restart your terminal/Claude Desktop.
npm run build # compile TypeScript → dist/
npm run dev # watch mode (recompiles on save)
npm start # run the compiled serverhudu-mcp/
├── src/
│ ├── api.ts ← HTTP client helpers
│ ├── tools.ts ← MCP tool definitions
│ └── index.ts ← Server entry point + tool dispatch
├── dist/ ← Compiled output (git-ignored)
├── reference/
│ └── HuduRESTAPI.json ← Hudu OpenAPI spec
├── package.json
├── tsconfig.json
├── .env.example
├── .gitignore
└── README.mdTo add a new tool:
Add a Tool entry to the TOOLS array in src/tools.ts
Add the corresponding case to the callTool switch in src/index.ts
Run npm run build to verify it compiles
The Hudu API docs describe all available endpoints.
MIT
Archive a Knowledge Base Article by ID.
Inputs: id (required).
Archive an Asset.
Inputs: id (required), company_id (required).
Archive a Password by ID.
Inputs: id (required).
Archive a company by ID.
Inputs: id (required).
Create a Knowledge Base Article.
Inputs: name (required), content, folder_id, company_id, +1 more.
Create an Asset under a specific company. Use custom_fields array for custom field values.
Inputs: name (required), company_id (required), asset_layout_id (required), primary_mail, +4 more.
Create a new Asset Layout.
Inputs: icon (required), name (required), color (required), icon_color (required), +6 more.
Create a new Password entry.
Inputs: name (required), company_id (required), url, password, +8 more.
Create a new company.
Inputs: name (required), zip, city, notes, +11 more.
Initiate a PDF or CSV export of a company.
Inputs: format (required), company_id (required), include_websites (required), include_passwords (required), +6 more.
Create a Flag on a record.
Inputs: flagable_id (required), flag_type_id (required), flagable_type (required), description.
Create a new Flag Type.
Inputs: name (required), color (required).
Create a KB article folder.
Inputs: name (required), icon, company_id, description, +1 more.
Create a new IP address record.
Inputs: address (required), company_id (required), fqdn, notes, +5 more.
Create a new selectable List.
Inputs: name (required), list_items_attributes.
Create a new network.
Inputs: name (required), address (required), company_id (required), vlan_id, +4 more.
Create a new password folder.
Inputs: name (required), security (required), company_id, description, +1 more.
Upload a new Photo. Provide the local file path to the image file.
Inputs: caption (required), file_path (required), pinned, folder_id, +3 more.
Create a new Procedure (Process).
Inputs: name (required), company_id, description, company_template.
Create a new Procedure instance from an existing template.
Inputs: id (required), name, company_id, description.
Create a new Procedure Task.
Inputs: name (required), procedure_id (required), user_id, due_date, +4 more.
Upload a new public photo and attach it to a record. Provide the local file path to the image.
Inputs: file_path (required), record_id (required), record_type (required).
Create a new Rack Storage.
Inputs: name (required), company_id (required), width, height, +4 more.
Create a new Rack Storage Item.
Inputs: rack_storage_role_id (required), side, status, asset_id, +5 more.
Create a relation between two entities.
Inputs: toable_id (required), fromable_id (required), toable_type (required), fromable_type (required), +2 more.
Initiate an S3 export of your Hudu data.
Inputs: no named parameters.
Create a new VLAN.
Inputs: name (required), vlan_id (required), company_id (required), notes, +5 more.
Create a new VLAN Zone.
Inputs: name (required), company_id (required), vlan_id_ranges (required), archived, +1 more.
Add a website to monitor.
Inputs: name (required), company_id (required), notes, paused, +3 more.
Delete activity logs from a specific datetime. Set delete_unassigned_logs=true to only delete logs with no user.
Inputs: datetime (required), delete_unassigned_logs.
Delete a Knowledge Base Article by ID.
Inputs: id (required).
Delete an Asset.
Inputs: id (required), company_id (required).
Delete a Password by ID.
Inputs: id (required).
Delete a company by ID.
Inputs: id (required).
Permanently delete an expiration by ID.
Inputs: id (required).
Delete a Flag by ID.
Inputs: id (required).
Delete a Flag Type by ID.
Inputs: id (required).
Delete a folder by ID.
Inputs: id (required).
Delete an IP address by ID.
Inputs: id (required).
Delete a List by ID.
Inputs: id (required).
Delete a Magic Dash Item by title and company_name.
Inputs: title (required), company_name (required).
Delete a Magic Dash Item by ID.
Inputs: id (required).
Delete an integration matcher by ID.
Inputs: id (required).
Delete a network by ID.
Inputs: id (required).
Delete a password folder by ID.
Inputs: id (required).
Delete a Photo by ID.
Inputs: id (required).
Delete a Procedure by ID.
Inputs: id (required).
Delete a Procedure Task by ID.
Inputs: id (required).
Delete a Rack Storage by ID.
Inputs: id (required).
Delete a Rack Storage Item by ID.
Inputs: id (required).
Delete a Relation by ID.
Inputs: id (required).
Delete an upload by ID.
Inputs: id (required).
Delete a VLAN by ID.
Inputs: id (required).
Delete a VLAN Zone by ID.
Inputs: id (required).
Delete a monitored website by ID.
Inputs: id (required).
Duplicate an existing Procedure.
Inputs: id (required), company_id (required), name, description.
Retrieve Hudu instance version and date.
Inputs: no named parameters.
Get a single Knowledge Base Article by ID.
Inputs: id (required).
Get a single Asset by company_id and asset id.
Inputs: id (required), company_id (required).
Get a single Asset Layout by ID.
Inputs: id (required).
Get a single Password by ID.
Inputs: id (required).
Get a specific company by ID.
Inputs: id (required).
Get export metadata by ID.
Inputs: id (required), download.
Get a specific Flag by ID.
Inputs: id (required).
Get a specific Flag Type by ID.
Inputs: id (required).
Get a folder by ID.
Inputs: id (required).
Retrieve a group by ID.
Inputs: id (required).
Get a single IP address by ID.
Inputs: id (required).
Get a specific List by ID.
Inputs: id (required).
Get a single network by ID.
Inputs: id (required).
Retrieve a password folder by ID.
Inputs: id (required).
Get a specific Photo by ID. Set download=true to get a download URL.
Inputs: id (required), download.
Get a Procedure by ID.
Inputs: id (required).
Get a Procedure Task by ID.
Inputs: id (required).
Get a public photo by ID. Set download=true to get a download URL.
Inputs: id (required), download.
Get a Rack Storage by ID.
Inputs: id (required).
Get a Rack Storage Item by ID.
Inputs: id (required).
Get a specific upload by ID.
Inputs: id (required).
Get a user by ID.
Inputs: id (required).
Get a single VLAN by ID.
Inputs: id (required).
Get a VLAN Zone by ID.
Inputs: id (required).
Get a website by ID.
Inputs: id (required).
Get a redirect URL to jump directly to an asset/record matched by integration details.
Inputs: integration_slug (required), integration_type (required), integration_id, integration_identifier.
Get a redirect URL to jump directly to a company matched by integration details.
Inputs: integration_slug (required).
Start/kickoff a Procedure from a company process.
Inputs: id (required), name, asset_id.
Retrieve a list of activity logs with optional filtering.
Inputs: page, user_id, page_size, start_date, +4 more.
Get a list of Knowledge Base Articles.
Inputs: name, page, slug, draft, +5 more.
Get a list of Asset Layouts.
Inputs: name, page, slug, active, +1 more.
Get a list of Passwords.
Inputs: name, page, slug, search, +4 more.
Retrieve a list of assets across all companies or filtered by company.
Inputs: id, name, page, slug, +7 more.
Retrieve a list of companies.
Inputs: city, name, page, slug, +8 more.
Get a list of Assets specific to a Company.
Inputs: company_id (required), page, archived, page_size.
Retrieve expirations for the account (domains, SSL certs, warranties, asset fields, etc.).
Inputs: page, archived, page_size, company_id, +3 more.
Get available exports from the last 24 hours.
Inputs: no named parameters.
Get a list of Flags.
Inputs: page, page_size, description, flagable_id, +2 more.
Get a list of Flag Types.
Inputs: name, page, slug, color, +1 more.
Retrieve a list of KB article folders.
Inputs: name, page, page_size, company_id, +1 more.
Retrieve a list of groups (member lists exclude admins/super admins).
Inputs: name, page, search, default, +1 more.
Get a list of IP addresses.
Inputs: fqdn, status, address, asset_id, +4 more.
Get a list of selectable Lists used in asset fields.
Inputs: name, query.
Retrieve a list of Magic Dash Items.
Inputs: page, title, page_size, company_id.
List integration matchers (company mappings) for a specific integration.
Inputs: integration_id (required), page, matched, sync_id, +3 more.
Get a list of networks.
Inputs: name, slug, address, archived, +5 more.
Retrieve a list of password folders.
Inputs: name, page, search, page_size, +1 more.
Get a list of Photos with optional filtering.
Inputs: page, archived, folder_id, page_size, +5 more.
Get a list of Procedures (Processes).
Inputs: name, page, slug, page_size, +4 more.
Get a list of Procedure Tasks.
Inputs: name, company_id, procedure_id.
Get a list of public photos.
Inputs: page, page_size.
Get a list of Rack Storage Items.
Inputs: side, status, asset_id, end_unit, +4 more.
Get a list of Rack Storages.
Inputs: height, max_width, min_width, company_id, +3 more.
Get a list of all relations between entities.
Inputs: page, page_size.
Get a list of all file uploads.
Inputs: no named parameters.
Retrieve a list of users.
Inputs: page, email, search, archived, +5 more.
Get a list of VLANs.
Inputs: name, vlan_id, archived, company_id, +3 more.
Get a list of VLAN Zones.
Inputs: name, archived, company_id, created_at, +1 more.
Get a list of monitored websites.
Inputs: name, page, slug, search, +2 more.
Look up Hudu records by external integration details.
Inputs: integration_slug (required), integration_id, integration_identifier.
Move an Asset to a different Asset Layout, preserving matching field values.
Inputs: id (required), company_id (required), asset_layout_id (required).
Unarchive a Knowledge Base Article by ID.
Inputs: id (required).
Unarchive an Asset.
Inputs: id (required), company_id (required).
Unarchive a Password by ID.
Inputs: id (required).
Unarchive a company by ID.
Inputs: id (required).
Update a Knowledge Base Article.
Inputs: id (required), name, content, folder_id, +2 more.
Update an existing Asset.
Inputs: id (required), company_id (required), name, primary_mail, +4 more.
Update an Asset Layout including its fields. Include field id to update existing fields.
Inputs: id (required), icon, name, color, +7 more.
Update an existing Password entry.
Inputs: id (required), url, name, password, +9 more.
Update a specific company by ID.
Inputs: id (required), zip, city, name, +12 more.
Update an expiration's archived status.
Inputs: id (required), archived.
Update a Flag.
Inputs: id (required), description, flagable_id, flag_type_id, +1 more.
Update a Flag Type by ID.
Inputs: id (required), name, color.
Update a folder.
Inputs: id (required), icon, name, company_id, +2 more.
Update an existing IP address.
Inputs: id (required), fqdn, notes, status, +6 more.
Update a List. Include item id to update existing items; set _destroy: true to remove items.
Inputs: id (required), name, list_items_attributes.
Reorder multiple Magic Dash Items for a company by updating their positions.
Inputs: positions (required), company_id (required).
Update an integration matcher.
Inputs: id (required), sync_id, company_id, identifier, +1 more.
Update an existing network.
Inputs: id (required), name, address, vlan_id, +5 more.
Update an existing password folder.
Inputs: id (required), name, security, company_id, +2 more.
Update a Photo's metadata by ID.
Inputs: id (required), pinned, caption, folder_id, +3 more.
Update an existing Procedure.
Inputs: id (required), name, archived, company_id, +2 more.
Update an existing Procedure Task.
Inputs: id (required), name, user_id, due_date, +6 more.
Update a public photo's record association.
Inputs: id (required), record_id (required), record_type (required).
Update a Rack Storage.
Inputs: id (required), name, width, height, +4 more.
Update a Rack Storage Item.
Inputs: id (required), side, status, asset_id, +6 more.
Update a VLAN.
Inputs: id (required), name, notes, vlan_id, +6 more.
Update a VLAN Zone.
Inputs: id (required), name, archived, company_id, +2 more.
Update a monitored website.
Inputs: id (required), name, notes, paused, +4 more.
Create or update a Magic Dash Item (matched by title + company_name).
Inputs: title (required), message (required), company_name (required), icon, +4 more.
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
Scored across 147 tools
Most tools follow a clear resource+action pattern, making their purposes obvious. A few pairs like list_assets/list_company_assets and delete_magic_dash/delete_magic_dash_by_id could cause minor selection confusion, but the descriptions generally resolve the ambiguity.
The vast majority of tools use a consistent verb_noun pattern such as list_*, get_*, create_*, update_*, delete_*, archive_*, and unarchive_*. Minor deviations like kickoff_procedure, upsert_magic_dash, jump_to_card, and lookup_cards break the pattern slightly, but the overall convention remains predictable.
With 147 tools, this server is dramatically over-scoped for an MCP surface. Even though Hudu has many resource types, exposing every CRUD operation as a separate tool creates an unwieldy interface that could be consolidated or grouped.
The tool set covers CRUD and lifecycle operations for most major Hudu resources, including articles, assets, companies, procedures, networks, VLANs, and photos. Minor gaps exist, such as missing create_matcher, no delete for asset layouts, and limited user/group management, but agents can generally work around these.
Connect Claude to your Platform7n workspaces: chat, links, work and decks. One-click OAuth.
Connect Claude to your Platform7n workspaces: chat, links, work and decks. One-click OAuth.
Manage Redbooth tasks, task lists, comments, tags and files from Claude and other AI assistants.
Create contacts, move deals, send proposals and invoices, read your inbox, from Claude or ChatGPT.
