Crownpeak DQM

You deploy and run a portable MCP server that wraps the Crownpeak DQM CMS REST API. It gives you task‑oriented tools for quality checking, asset handling, and monitoring, while supporting both local development (stdio) and cloud hosting (HTTP).

How to use

Use a client that speaks MCP to connect to the server running in stdio mode on your desktop, or run the HTTP server for remote access. In stdio mode you launch the server locally and pass your API key via environment variables. In HTTP server mode you start the server on a port and expose it for remote clients. You can perform actions such as running quality checks on URLs, managing assets, and listing websites and checkpoints through the available tools.

To use from a desktop MCP client, start the server locally and then point the client at the local process. You can also configure an integration in your agent or automation tool to call the server’s tools directly.

Claude Desktop users can configure a local MCP entry that runs the local Node.js runtime and points to the built distribution. The example below shows how to wire the local process and pass your API key.

How to install

# Prerequisites
node --version
npm --version

# Clone the MCP server project
git clone <repository-url>
cd crownpeak-dqm-node-mcp

# Install dependencies
npm install

# Copy environment template and configure API key
cp .env.example .env
# Edit .env and add your API key
# DQM_API_KEY=your_api_key_here

# Build the project for distribution
npm run build

Additional notes

Configuration is environment‑variable driven. The primary required variable is DQM_API_KEY. Optional settings include DQM_API_BASE_URL to override the DQM API base URL, PORT for the HTTP server port, ENABLE_DESTRUCTIVE_TOOLS to allow delete operations, DQM_REQUEST_TIMEOUT for request timeouts, and MAX_CONCURRENT_QUALITY_CHECKS to limit concurrent checks.

Deployment options span local stdio mode for desktop usage and HTTP server mode for cloud hosting. You can run a container with Docker, deploy to AWS, Azure, GCP, Vercel, Netlify, Fly.io, and Kubernetes, or run locally.

If you encounter issues, ensure your API key is loaded, the server port is accessible, and the dependency versions match the requirements (for example, Node.js 20+). The health check endpoint is available to verify the server is running correctly.

Security and robustness

All operations leverage read‑only defaults and require explicit opt‑in for destructive actions. Requests include timeouts and rate limiting to prevent hangs or abuse. Secrets like API keys are loaded from environment variables and never hardcoded.

For production deployments, run the HTTP server behind standard security controls and consider placing the MCP server behind a gateway or API management layer that enforces authentication and access controls.

Troubleshooting

DQM_API_KEY environment variable is required. If missing, you will see an error indicating the API key is not set. Provide the key in the environment or in your .env file and restart the server.

Connection timeouts can be adjusted by setting DQM_REQUEST_TIMEOUT to a higher value in milliseconds and reloading the server.

Health checks: ensure the server is listening on the expected port (default 3000) and accessible at the healthz endpoint when using HTTP mode.

Available tools

list_websites

List all websites in your DQM account

get_website

Get details of a specific website

list_checkpoints

List all quality checkpoints, optionally filtered by website

get_checkpoint

Get details of a specific checkpoint

search_assets

Search for assets with optional filters

get_asset

Get details of a specific asset

get_asset_status

Check the status of an asset scan

get_asset_issues

Get all quality issues for an asset

get_asset_content

Get the HTML content for an asset

get_asset_errors

Get asset errors for a specific checkpoint with highlighted content

get_asset_pagehighlight

(Beta) Get asset content with all page highlightable issues highlighted

update_asset

Update the content of an existing asset

delete_asset

Delete a specific asset from DQM storage

run_quality_check

Run a quality check on a URL or HTML content

spellcheck_asset

Run spellcheck on an asset