@dotcms/mcp-server
Advanced tools
Model Context Protocol (MCP) server for dotCMS - enables AI assistants to interact with dotCMS content management capabilities
The dotCMS MCP (Model Context Protocol) Server enables AI assistants to interact directly with dotCMS content management capabilities. This powerful integration allows AI tools like Claude, GPT, and others to discover content schemas, create content types, manage content workflows, and perform complex content operations—all through natural language interactions.
For Production Use:
For Testing & Development:
For Local Development:
[!WARNING] This MCP server requires an API token with write permissions for Content Types, Content, and Workflows. Only use tokens with the minimum required permissions and secure them properly.
This integration requires an API Token with content management permissions:
For detailed instructions, please refer to the dotCMS API Documentation.
Build the MCP server from source:
# Clone the dotCMS repository
git clone https://github.com/dotCMS/core.git
cd core/core-web
# Install dependencies
yarn install
# Build the server
yarn nx build mcp-server
Here's how to set up and start using the dotCMS MCP Server:
Add the MCP server to your Claude Desktop configuration:
{
"mcpServers": {
"dotcms": {
"command": "node",
"args": [
"/path/to/dotcms/core/dist/apps/mcp-server/main.js"
],
"env": {
"DOTCMS_URL": "https://your-dotcms-instance.com",
"AUTH_TOKEN": "your-auth-token"
}
}
}
}
Once configured, you can interact with dotCMS through natural language:
You: "Initialize the context so you can learn about my dotCMS setup"
Claude: [Calls context_initialization tool and learns all your content types]
You: "Create a new Blog Post about AI in content management"
Claude: [Uses content_save tool to create and save the blog post]
You: "Search for all published blog posts from this year"
Claude: [Uses content_search tool with appropriate filters]
Add the MCP server to your Cursor:
{
"mcpServers": {
"dotcms": {
"command": "node",
"args": [
"/path/to/dotcms/core/dist/apps/mcp-server/main.js"
],
"env": {
"DOTCMS_URL": "https://your-dotcms-instance.com",
"AUTH_TOKEN": "your-auth-token"
}
}
}
}
You: "Write the UI component for the Youtube content"
Cursor: [Calls context_initialization tool and learns all your content types]
Cursor: [Generate youtube.tsx]
| Term | Description | Documentation |
|---|---|---|
| Context Initialization | Required first step that teaches AI about your content structure | Context Tools |
| Content Type | Schema definitions that define the structure of your content | Content Type API |
| Workflow Action | Operations like save, publish, archive, delete performed on content | Workflow API |
| Content Search | Lucene-based querying to find and filter content | Search API |
| MCP Tools | Individual functions the AI can call to perform dotCMS operations | MCP Specification |
The dotCMS MCP Server provides four core tools that enable comprehensive content management through AI:
Tool: context_initialization
Purpose: Must be called first to discover all available content types, sites, and workflow schemes
You: "Learn about my dotCMS setup"
AI: [Calls context_initialization and learns your complete content schema]
What it provides:
Tools: content_type_list, content_type_create
Purpose: Discover and create content type schemas
You: "Show me all my content types"
AI: [Calls content_type_list to display your content schemas]
You: "Create a new Product content type with name, price, and description fields"
AI: [Calls content_type_create with the appropriate schema]
Capabilities:
Tools: content_save, content_action
Purpose: Create, update, and manage content through workflow actions
You: "Create a new blog post about dotCMS MCP integration"
AI: [Calls content_save to create the content]
You: "Publish the blog post we just created"
AI: [Calls content_action with PUBLISH action]
Supported Actions:
Tool: content_search
Purpose: Query content using Lucene syntax
You: "Find all blog posts published this year that mention 'AI'"
AI: [Calls content_search with appropriate Lucene query]
Search Capabilities:
| Variable | Required | Description |
|---|---|---|
DOTCMS_URL | ✅ | Your dotCMS instance URL |
AUTH_TOKEN | ✅ | API authentication token |
VERBOSE | ❌ | Set to true for detailed logging |
mcp-server/
├── src/
│ ├── main.ts # Entry point and server initialization
│ ├── services/ # HTTP clients for dotCMS APIs
│ │ ├── client.ts # Base authenticated HTTP client
│ │ ├── contentype.ts # Content type operations
│ │ ├── workflow.ts # Content workflow actions
│ │ ├── search.ts # Content search functionality
│ │ └── site.ts # Site information
│ ├── tools/ # MCP tool implementations
│ │ ├── context/ # Context initialization
│ │ ├── content-types/ # Content type management
│ │ ├── workflow/ # Content operations
│ │ └── search/ # Search functionality
│ ├── types/ # TypeScript type definitions
│ └── utils/ # Shared utilities
├── jest.config.ts # Test configuration
└── project.json # Nx project configuration
Service Layer: All services extend AgnosticClient which provides:
Tool Registration: Each tool module exports a registration function that:
Type Safety: Extensive use of Zod schemas for:
# Run all tests
yarn nx test mcp-server
# Run tests in watch mode
yarn nx test mcp-server --watch
# Run with coverage
yarn nx test mcp-server --coverage
# Build for development
yarn nx build mcp-server
# Build for production
yarn nx build mcp-server --configuration=production
# Lint the code
yarn nx lint mcp-server
# Serve in development mode
yarn nx serve mcp-server
The MCP server includes comprehensive logging:
We offer multiple channels to get help with the dotCMS MCP Server:
dotcms-mcp when posting questionsWhen reporting issues, please include:
Enterprise customers can access premium support through the dotCMS Support Portal.
GitHub pull requests are the preferred method to contribute code to dotCMS. We welcome contributions to the dotCMS MCP Server! If you'd like to contribute, please follow these steps:
git checkout -b feature/amazing-mcp-feature)apps/mcp-server directoryyarn nx test mcp-server)git commit -m 'Add amazing MCP feature')git push origin feature/amazing-mcp-feature)When adding new MCP tools:
src/tools/ subdirectorysrc/main.tsdotCMS comes in multiple editions and as such is dual-licensed. The dotCMS Community Edition is licensed under the GPL 3.0 and is freely available for download, customization, and deployment for use within organizations of all stripes. dotCMS Enterprise Editions (EE) adds several enterprise features and is available via a supported, indemnified commercial license from dotCMS. For the differences between the editions, see the feature page.
This MCP Server is part of dotCMS's dual-licensed platform (GPL 3.0 for Community, commercial license for Enterprise).
Learn more at dotcms.com.
FAQs
Model Context Protocol (MCP) server for dotCMS - enables AI agents to interact with dotCMS content management capabilities
The npm package @dotcms/mcp-server receives a total of 11 weekly downloads. As such, @dotcms/mcp-server popularity was classified as not popular.
We found that @dotcms/mcp-server demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Node.js patched a crash bug where AsyncLocalStorage could cause stack overflows to bypass error handlers and terminate production servers.
Research
/Security News
A malicious Chrome extension steals newly created MEXC API keys, exfiltrates them to Telegram, and enables full account takeover with trading and withdrawal rights.
Security News
CVE disclosures hit a record 48,185 in 2025, driven largely by vulnerabilities in third-party WordPress plugins.