NPM
- javascript
1
GitHub Stars
javascript
Language
3 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"verybigsad-nginx-proxy-manager-mcp": {
"command": "uv",
"args": [
"run",
"nginx-proxy-manager-mcp"
],
"env": {
"NPM_URL": "http://your-npm-instance:81",
"NPM_EMAIL": "admin@example.com",
"NPM_PASSWORD": "your-password"
}
}
}
}You can manage Nginx Proxy Manager (NPM) instances using this MCP server, enabling Claude/AI assistants to perform common NPM actions through a wide set of tools. It streamlines tasks such as configuring proxy hosts, redirects, SSL certificates, streams, users, and audit information, all via simple commands issued by your assistant.
How to use
Install and run the MCP server, then connect your Claude client using the provided configuration. Once connected, you can perform practical actions by describing what you want to do in natural language. Examples include listing proxy hosts, creating a new proxy host for a domain, setting up a redirect, creating a TCP/UDP stream, requesting a Let’s Encrypt certificate, enabling a proxy host, or reviewing the audit log. The MCP exposes a full set of tools that map directly to NPM resources and operations, enabling you to automate day-to-day NPM management.
How to install
# Install via uvx (recommended)
uvx nginx-proxy-manager-mcp
# Or install from source
uv sync
uv run nginx-proxy-manager-mcp
Configuration
Set up the MCP server in your Claude Desktop configuration to provide the credentials and URL for your NPM instance. Use the following settings as a guide to create the configuration you will load in Claude:
{
"mcpServers": {
"nginx-proxy-manager": {
"command": "uvx",
"args": ["nginx-proxy-manager-mcp"],
"env": {
"NPM_URL": "http://your-npm-instance:81",
"NPM_EMAIL": "admin@example.com",
"NPM_PASSWORD": "your-password"
}
}
}
}
Notes
The MCP server is designed to reflect the full NPM API surface through a set of defined tools. Ensure your NPM instance is reachable from the MCP host, and that the credentials you provide have sufficient permissions to perform the requested actions. If you need to adjust access or networking, update the environment variables accordingly and restart the MCP service.
Troubleshooting and tips
- Verify that NPM is reachable at the URL you configured and that the credentials are correct.
- If an action fails, check the corresponding NPM resource's state in your NPM dashboard to ensure it exists and is in the expected state.
- When starting the MCP server after configuration changes, ensure the process starts without errors and that Claude is connected to the MCP endpoint.
Usage notes
After configuration, you can use natural language prompts to perform actions. Examples include asking to list all proxy hosts, create a new proxy host for a domain pointing to a specific backend, set up a 301 redirect, create and manage TCP streams, obtain SSL certificates, and retrieve audit information.
Available tools
list_proxy_hosts
List all proxy hosts available in your NPM instance.
get_proxy_host
Retrieve a specific proxy host by its ID.
create_proxy_host
Create a new proxy host with domain names and a backend forward target.
update_proxy_host
Update fields for an existing proxy host by ID.
delete_proxy_host
Remove a proxy host by ID.
enable_proxy_host
Enable a previously disabled proxy host.
disable_proxy_host
Disable an active proxy host.
list_redirection_hosts
List all HTTP redirection hosts.
get_redirection_host
Get a redirection host by ID.
create_redirection_host
Create an HTTP redirect with domain names and a forward target.
update_redirection_host
Update fields for an existing redirection host by ID.
delete_redirection_host
Delete a redirection host by ID.
enable_redirection_host
Enable a redirection host.
disable_redirection_host
Disable a redirection host.
list_streams
List all TCP/UDP streams.
get_stream
Get a stream by ID.
create_stream
Create a TCP/UDP stream proxy with port forwarding.
update_stream
Update fields for an existing stream by ID.
delete_stream
Delete a stream by ID.
enable_stream
Enable a stream.
disable_stream
Disable a stream.
list_dead_hosts
List all 404 dead hosts.
get_dead_host
Get a dead host by ID.
create_dead_host
Create a 404 dead host entry with domain names.
update_dead_host
Update fields for an existing dead host by ID.
delete_dead_host
Delete a dead host by ID.
enable_dead_host
Enable a dead host entry.
disable_dead_host
Disable a dead host entry.
list_certificates
List all SSL certificates.
get_certificate
Get a certificate by ID.
request_certificate
Request a Let's Encrypt certificate for domain names.
delete_certificate
Delete a certificate by ID.
renew_certificate
Renew a Let's Encrypt certificate by ID.
list_dns_providers
List supported DNS providers.
test_http_challenge
Test HTTP-01 ACME challenge reachability for domains.
list_access_lists
List all access lists.
get_access_list
Get an access list by ID.
create_access_list
Create a new access list with a name.
update_access_list
Update an access list by ID.
delete_access_list
Delete an access list by ID.
list_users
List all NPM users.
get_user
Get a user by ID.
create_user
Create a new NPM user with a name and email.
update_user
Update a user by ID.
delete_user
Delete a user by ID.
list_settings
List all NPM settings.
get_setting
Get a setting by ID.
update_setting
Update a setting by ID.
list_audit_log
List recent audit log entries.
get_host_report
Get a host count report.