Craft MCP

https://github.com/stimmtdigital/craft-mcp
Admin
Craft MCP is an MCP server that accelerates AI-assisted development by giving your AI assistant...
Tokens:62,852
Snippets:385
Trust Score:5.4
License:MIT
Update:7 months ago
Show doc for...
Tokens:
Raw
### Run Craft MCP Installation Wizard

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/installation.md

Initiates the automatic setup wizard for configuring MCP clients. The wizard detects the environment, allows client selection, and generates necessary configuration files.

```bash
# Interactive wizard with auto-detection
php craft mcp/install

# Force DDEV environment
php craft mcp/install --environment=ddev

# Use a custom server name
php craft mcp/install --serverName=my-craft-site

# Non-interactive mode (use defaults)
php craft mcp/install --interactive=0
```

--------------------------------

### Install Craft MCP Locally for Development

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/installation.md

Installs the Craft MCP plugin from a local path, suitable for development or contributing to the plugin. This method involves configuring Composer to use a local repository.

```bash
# Add the local repository to your composer.json
composer config repositories.craft-mcp path ./plugins/craft-mcp

# Require the package with dev stability
composer require stimmt/craft-mcp:@dev

# Install the plugin in Craft
php craft plugin/install mcp
```

--------------------------------

### List All Sites

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/multisite.md

Retrieves a list of all sites configured in the Craft installation, providing an overview of the multi-site setup.

```APIDOC
## List Sites

### Description
Lists all sites configured in your Craft installation. This gives you a complete overview of your multi-site setup.

### Method
GET

### Endpoint
/sites

### Parameters
#### Query Parameters
None

### Request Example
```
list_sites
```

### Response
#### Success Response (200)
- **count** (int) - The total number of sites.
- **sites** (array) - An array of site objects.
  - **id** (int) - The unique identifier for the site.
  - **uid** (string) - The unique identifier for the site (UUID format).
  - **handle** (string) - The site's handle, used for identification.
  - **name** (string) - The display name of the site.
  - **language** (string) - The BCP 47 language tag for the site.
  - **primary** (boolean) - Indicates if this is the primary site.
  - **enabled** (boolean) - Indicates if the site is currently enabled.
  - **baseUrl** (string) - The base URL for the site.
  - **groupId** (int) - The ID of the site group the site belongs to.
  - **sortOrder** (int) - The order in which the site should be sorted.
  - **dateCreated** (string) - The date and time the site was created.
  - **dateUpdated** (string) - The date and time the site was last updated.

#### Response Example
```json
{
  "count": 3,
  "sites": [
    {
      "id": 1,
      "uid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "handle": "default",
      "name": "English",
      "language": "en-US",
      "primary": true,
      "enabled": true,
      "baseUrl": "https://example.com/",
      "groupId": 1,
      "sortOrder": 1,
      "dateCreated": "2024-01-01 00:00:00",
      "dateUpdated": "2024-01-15 10:30:00"
    },
    {
      "id": 2,
      "uid": "e5f6g7h8-i9j0-k1l2-m3n4-o5p6q7r8s9t0",
      "handle": "german",
      "name": "German",
      "language": "de",
      "primary": false,
      "enabled": true,
      "baseUrl": "https://example.com/de/",
      "groupId": 1,
      "sortOrder": 2,
      "dateCreated": "2024-01-01 00:00:00",
      "dateUpdated": "2024-01-15 10:30:00"
    }
  ]
}
```
```

--------------------------------

### Enable MCP Server Configuration

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/installation.md

Enables the MCP server by creating a configuration file. This is a basic configuration to enable the server; more advanced security options are available in the configuration guide.

```php
<?php

return [
    'enabled' => true,
];
```

--------------------------------

### Get Craft System Information

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/system.md

Retrieves a comprehensive overview of the Craft installation, including version numbers, database configuration, and multi-site setup. This tool is useful for debugging version-specific issues and understanding site structure.

```craft-tool
get_system_info
```

--------------------------------

### Get Guidance on Querying Entries

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/prompts.md

The `query_entries_guide` prompt offers best practices for efficiently querying entries from a specified Craft CMS section. It covers available filter parameters, pagination, performance optimization, and provides example queries.

```bash
query_entries_guide section="products"
```

--------------------------------

### Get Guidance on Creating Entries

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/prompts.md

The `create_entry_guide` prompt provides instructions for creating entries within a specific Craft CMS section. It details required fields, validation rules, and offers example payloads, optionally filtering by entry type.

```bash
create_entry_guide section="blog" entryType="article"
```

--------------------------------

### Install and Enable Craft MCP Plugin

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/README.md

Installs the Craft MCP plugin using Composer and enables it within the Craft CMS configuration. This is the initial setup step for integrating MCP with your Craft CMS project.

```bash
composer require stimmt/craft-mcp
php craft plugin/install mcp
```

--------------------------------

### System Information API

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/system.md

Retrieve a comprehensive snapshot of your Craft CMS installation, including version numbers, PHP details, database configuration, and multi-site setup.

```APIDOC
## GET /system/info

### Description
Get a comprehensive overview of your Craft installation, including version numbers, database configuration, and multi-site setup details.

### Method
GET

### Endpoint
/system/info

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GET /system/info
```

### Response
#### Success Response (200)
- **craft** (object) - Craft CMS version, edition, and environment.
- **php** (object) - PHP version.
- **database** (object) - Database driver and version.
- **sites** (array) - List of configured sites with their details.

#### Response Example
```json
{
  "craft": {
    "version": "5.0.0",
    "edition": "pro",
    "environment": "dev"
  },
  "php": {
    "version": "8.3.0"
  },
  "database": {
    "driver": "mysql",
    "version": "8.0.35"
  },
  "sites": [
    {
      "name": "My Site",
      "handle": "default",
      "language": "en-US",
      "primary": true
    }
  ]
}
```
```

--------------------------------

### Get Installed Plugins

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/resources.md

Retrieves information about all installed plugins in the Craft CMS installation.

```APIDOC
## GET craft://config/plugins

### Description
Get information about all installed plugins.

### Method
GET

### Endpoint
`craft://config/plugins`

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **plugins** (array) - An array of plugin objects.
  - **handle** (string) - The plugin's handle.
  - **name** (string) - The plugin's name.
  - **version** (string) - The plugin's version.
  - **enabled** (boolean) - Whether the plugin is enabled.
  - **developer** (string) - The name of the plugin developer.

#### Response Example
```json
{
  "plugins": [
    {
      "handle": "seo",
      "name": "SEO",
      "version": "4.0.0",
      "enabled": true,
      "developer": "Ether Creative"
    },
    {
      "handle": "mcp",
      "name": "Craft MCP",
      "version": "1.0.1",
      "enabled": true,
      "developer": "Stimmt Digital"
    }
  ]
}
```
```

--------------------------------

### Verify Craft MCP Installation

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/installation.md

Checks if the Craft MCP plugin has been successfully installed and is listed by Craft CMS. This command lists all installed plugins and their statuses.

```bash
php craft plugin/list
```

--------------------------------

### Configure Craft MCP Server Natively for Claude Desktop

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/installation.md

This JSON configuration adds the Craft MCP server to Claude Desktop using a native PHP installation. It specifies the PHP executable path, arguments to run the MCP server script, and the working directory of your Craft project. Verify the PHP path and project directory are accurate.

```json
{
  "mcpServers": {
    "craft-cms": {
      "command": "/usr/bin/php",
      "args": ["vendor/stimmt/craft-mcp/bin/mcp-server"],
      "cwd": "/path/to/your/craft/project"
    }
  }
}
```

--------------------------------

### Get Installed Plugins Information

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/resources.md

Retrieves information about all installed plugins in the Craft CMS instance. This includes details such as the plugin's handle, name, version, enabled status, and developer. This endpoint is useful for understanding the available extensions and their configurations.

```json
{
  "plugins": [
    {
      "handle": "seo",
      "name": "SEO",
      "version": "4.0.0",
      "enabled": true,
      "developer": "Ether Creative"
    },
    {
      "handle": "mcp",
      "name": "Craft MCP",
      "version": "1.0.1",
      "enabled": true,
      "developer": "Stimmt Digital"
    }
  ]
}
```

--------------------------------

### Get Site Configurations

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/resources.md

Retrieves information about all configured sites within your Craft installation. This includes details such as handle, name, language, primary status, enabled state, and base URL.

```json
{
  "sites": [
    {
      "handle": "default",
      "name": "English",
      "language": "en",
      "primary": true,
      "enabled": true,
      "baseUrl": "https://example.com"
    },
    {
      "handle": "dutch",
      "name": "Nederlands",
      "language": "nl",
      "primary": false,
      "enabled": true,
      "baseUrl": "https://example.com/nl"
    }
  ]
}
```

--------------------------------

### Limiting Data Exposure Example (PHP)

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/extending.md

Illustrates a security best practice for Craft MCP tools: limiting data exposure. This example shows how to return only safe configuration data, omitting sensitive information like API keys that might be present in the full settings object.

```php
// Bad - exposes sensitive data\nreturn [
    'config' => $this->getSettings(), // May contain API keys
];

// Good - return only safe data
return [
    'config' => [
        'enabled' => $settings->enabled,
        'limit' => $settings->limit,
        // Omit sensitive fields
    ],
];
```

--------------------------------

### Basic Tool Class Example

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/extending.md

Demonstrates a basic tool class with two methods annotated with #[McpTool] for AI assistant usage.

```APIDOC
## POST /tools/myplugin_get_analytics

### Description
Retrieves analytics data for a specific entry, including page views and engagement metrics.

### Method
POST

### Endpoint
/tools/myplugin_get_analytics

### Parameters
#### Query Parameters
- **entryId** (int) - Required - The ID of the entry to get analytics for.
- **dateRange** (string) - Optional - The date range for analytics data (e.g., '30d'). Defaults to '30d'.

### Request Body
(Not applicable for this tool, parameters are passed as query parameters)

### Response
#### Success Response (200)
- **found** (bool) - Indicates if the entry was found.
- **entry** (object) - Information about the found entry.
  - **id** (int) - The ID of the entry.
  - **title** (string) - The title of the entry.
- **analytics** (object) - The retrieved analytics data.
- **dateRange** (string) - The date range used for fetching analytics.

#### Response Example
```json
{
  "found": true,
  "entry": {
    "id": 123,
    "title": "Example Entry"
  },
  "analytics": {
    "pageViews": 1500,
    "engagementRate": 0.75
  },
  "dateRange": "30d"
}
```

## POST /tools/myplugin_list_events

### Description
Lists tracked analytics events, with an option to filter by category.

### Method
POST

### Endpoint
/tools/myplugin_list_events

### Parameters
#### Query Parameters
- **category** (string) - Optional - Filters events by a specific category.
- **limit** (int) - Optional - The maximum number of events to return. Defaults to 50.

### Request Body
(Not applicable for this tool, parameters are passed as query parameters)

### Response
#### Success Response (200)
- **count** (int) - The total number of events returned.
- **category** (string|null) - The category filter used, if any.
- **events** (array) - A list of analytics events.

#### Response Example
```json
{
  "count": 10,
  "category": "page_view",
  "events": [
    {
      "id": "event1",
      "timestamp": "2023-10-27T10:00:00Z"
    },
    {
      "id": "event2",
      "timestamp": "2023-10-27T10:05:00Z"
    }
  ]
}
```
```

--------------------------------

### List Installed Craft CMS Plugins

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/system.md

Provides a list of all installed plugins in a Craft CMS project, including their version numbers, enabled status, and developer details. This is useful for auditing and understanding the extended functionality of a Craft installation. No parameters are required.

```shell
list_plugins
```

--------------------------------

### Complete MCP Configuration Options

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/configuration.md

Demonstrates all available configuration options for the Craft MCP plugin, including enabling/disabling the server, dangerous tools, disabling specific tools, and IP allowlisting. Defaults are provided for each option.

```php
<?php

return [
    // Enable or disable the MCP server entirely.
    // Default: false in production, true in other environments
    'enabled' => true,

    // Enable tools that can modify data or execute code.
    // Default: false in production, true in other environments
    'enableDangerousTools' => true,

    // Disable specific tools by their snake_case name.
    // Useful for fine-grained control over what AI assistants can access.
    // Default: [] (no tools disabled)
    'disabledTools' => [
        'tinker',
        'run_query',
    ],

    // Restrict MCP connections to specific IP addresses.
    // When empty, connections from any IP are allowed.
    // Default: [] (all IPs allowed)
    'allowedIps' => [
        '127.0.0.1',
        '::1',
    ],
];

```

--------------------------------

### Input Validation Example (PHP)

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/extending.md

Demonstrates a security best practice for Craft MCP tools: validating all inputs. This example shows how to check if an ID is a positive integer before proceeding with the operation, preventing potential errors and vulnerabilities.

```php
public function getRecord(int $id): array\n{\n    if ($id <= 0) {\n        return [\n            'success' => false,\n            'error' => 'Invalid ID: must be a positive integer'\n        ];\n    }\n\n    // Continue with valid input...\n}
```

--------------------------------

### Get Guidance on Bulk Entry Operations

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/prompts.md

The `bulk_entry_operations` prompt guides users on performing safe and efficient bulk operations on entries within a Craft CMS section. It includes advice on iteration, batch updates, error handling, and performance for large datasets.

```bash
bulk_entry_operations section="news"
```

--------------------------------

### Environment - Get Environment

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/debugging.md

Retrieves a comprehensive overview of the environment configuration, including PHP settings, Craft system settings, and important paths, while excluding sensitive information.

```APIDOC
## GET /get_environment

### Description
Get a comprehensive overview of your environment configuration, including PHP settings, Craft system settings, and important paths. Sensitive values like passwords and API keys are automatically excluded.

### Method
GET

### Endpoint
/get_environment

#### Parameters

No parameters are required for this endpoint.

### Response
#### Success Response (200)
- **environment** (object) - Craft environment variables.
  - **CRAFT_ENVIRONMENT** (string) - The current Craft environment (e.g., 'dev', 'production').
  - **CRAFT_DEV_MODE** (string) - Indicates if dev mode is enabled.
  - **CRAFT_ALLOW_ADMIN_CHANGES** (string) - Indicates if admin changes are allowed.
  - **CRAFT_RUN_QUEUE_AUTOMATICALLY** (string) - Indicates if the queue runs automatically.
- **php** (object) - PHP configuration settings.
  - **memory_limit** (string) - The memory limit for PHP scripts.
  - **max_execution_time** (string) - The maximum execution time for PHP scripts.
  - **display_errors** (string) - Whether to display errors.
  - **upload_max_filesize** (string) - The maximum upload file size.
  - **post_max_size** (string) - The maximum size of POST data.
  - **opcache.enable** (string) - Whether OPcache is enabled.
- **system** (object) - Craft system settings.
  - **isSystemLive** (boolean) - Whether the system is live.
  - **devMode** (boolean) - Whether dev mode is enabled.
  - **cpTrigger** (string) - The trigger for the control panel.
  - **runQueueAutomatically** (boolean) - Whether the queue runs automatically.
  - **allowAdminChanges** (boolean) - Whether admin changes are allowed.
  - **enableTemplateCaching** (boolean) - Whether template caching is enabled.
- **paths** (object) - Important file paths in the Craft installation.
  - **basePath** (string) - The base path of the application.
  - **configPath** (string) - The path to the configuration directory.
  - **storagePath** (string) - The path to the storage directory.
  - **templatesPath** (string) - The path to the templates directory.
  - **translationsPath** (string) - The path to the translations directory.

#### Response Example
```json
{
  "environment": {
    "CRAFT_ENVIRONMENT": "dev",
    "CRAFT_DEV_MODE": "true",
    "CRAFT_ALLOW_ADMIN_CHANGES": "true",
    "CRAFT_RUN_QUEUE_AUTOMATICALLY": "true"
  },
  "php": {
    "memory_limit": "256M",
    "max_execution_time": "120",
    "display_errors": "1",
    "upload_max_filesize": "128M",
    "post_max_size": "128M",
    "opcache.enable": "1"
  },
  "system": {
    "isSystemLive": true,
    "devMode": true,
    "cpTrigger": "admin",
    "runQueueAutomatically": true,
    "allowAdminChanges": true,
    "enableTemplateCaching": false
  },
  "paths": {
    "basePath": "/var/www/html",
    "configPath": "/var/www/html/config",
    "storagePath": "/var/www/html/storage",
    "templatesPath": "/var/www/html/templates",
    "translationsPath": "/var/www/html/translations"
  }
}
```
```

--------------------------------

### List Available Craft MCP Tools

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/mcp.md

Lists all tools accessible through the MCP plugin, including their descriptions, categories, and current enabled status. This serves as a definitive guide for AI assistants to understand and utilize the functionalities provided by the Craft installation.

```shell
list_mcp_tools
```

--------------------------------

### Multi-Environment MCP Configuration

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/configuration.md

Illustrates Craft's multi-environment configuration pattern for setting different MCP options across various environments (dev, staging, production). This provides granular control over access and functionality per environment.

```php
<?php

return [
    // Shared settings applied to all environments
    '*' => [
        'disabledTools' => ['tinker'],
    ],

    // Development environment - full access
    'dev' => [
        'enabled' => true,
        'enableDangerousTools' => true,
        'disabledTools' => [],
    ],

    // Staging environment - read-only access
    'staging' => [
        'enabled' => true,
        'enableDangerousTools' => false,
    ],

    // Production environment - disabled entirely
    'production' => [
        'enabled' => false,
    ],
];

```

--------------------------------

### Get Asset Volume Configurations

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/resources.md

Retrieves details for all configured asset volumes in your Craft installation. This includes the volume's handle, name, file system type, URL accessibility, and the number of assets it contains.

```json
{
  "volumes": [
    {
      "handle": "images",
      "name": "Images",
      "fsType": "Local",
      "hasUrls": true,
      "assetCount": 234
    },
    {
      "handle": "documents",
      "name": "Documents",
      "fsType": "Local",
      "hasUrls": true,
      "assetCount": 45
    }
  ]
}
```

--------------------------------

### get_environment

Source: https://context7.com/stimmtdigital/craft-mcp/llms.txt

Gets a comprehensive overview of your environment configuration.

```APIDOC
## GET /get_environment

### Description
Gets a comprehensive overview of your environment configuration, including PHP settings, Craft system settings, and important paths.

### Method
GET

### Endpoint
/get_environment

### Response
#### Success Response (200)
- **environment** (object) - Craft environment variables.
- **php** (object) - PHP configuration settings.
- **system** (object) - Craft system settings.
- **paths** (object) - Important file paths within the Craft installation.

#### Response Example
```json
{
  "environment": {
    "CRAFT_ENVIRONMENT": "dev",
    "CRAFT_DEV_MODE": "true",
    "CRAFT_ALLOW_ADMIN_CHANGES": "true",
    "CRAFT_RUN_QUEUE_AUTOMATICALLY": "true"
  },
  "php": {
    "memory_limit": "256M",
    "max_execution_time": "120",
    "display_errors": "1",
    "upload_max_filesize": "128M",
    "post_max_size": "128M",
    "opcache.enable": "1"
  },
  "system": {
    "isSystemLive": true,
    "devMode": true,
    "cpTrigger": "admin",
    "runQueueAutomatically": true,
    "allowAdminChanges": true,
    "enableTemplateCaching": false
  },
  "paths": {
    "basePath": "/var/www/html",
    "configPath": "/var/www/html/config",
    "storagePath": "/var/www/html/storage",
    "templatesPath": "/var/www/html/templates",
    "translationsPath": "/var/www/html/translations"
  }
}
```
```

--------------------------------

### List All Sections

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/resources.md

Retrieves a list of all sections in your Craft installation, including basic metadata such as handle, name, type, and entry count. This resource is useful for understanding the overall content structure.

```json
{
  "sections": [
    {
      "handle": "news",
      "name": "News",
      "type": "channel",
      "entryTypeCount": 2
    },
    {
      "handle": "homepage",
      "name": "Homepage",
      "type": "single",
      "entryTypeCount": 1
    }
  ]
}
```

--------------------------------

### Configure Craft MCP Server with DDEV for Claude Desktop

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/installation.md

This JSON configuration adds the Craft MCP server to Claude Desktop when using DDEV. It specifies the DDEV command, arguments to execute the MCP server script, and the working directory of your Craft project. Ensure the paths to DDEV and your project are correct.

```json
{
  "mcpServers": {
    "craft-cms": {
      "command": "/usr/local/bin/ddev",
      "args": ["exec", "php", "vendor/stimmt/craft-mcp/bin/mcp-server"],
      "cwd": "/path/to/your/craft/project"
    }
  }
}
```

--------------------------------

### execute_graphql

Source: https://context7.com/stimmtdigital/craft-mcp/llms.txt

Executes a GraphQL query or mutation against your Craft installation.

```APIDOC
## POST /execute_graphql

### Description
Executes a GraphQL query or mutation against your Craft installation. This is a dangerous tool that can modify data via mutations.

### Method
POST

### Endpoint
/execute_graphql

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query or mutation to execute.

### Request Example
```json
{
  "query": "{ entries(section: \"news\", limit: 5) { title, slug } }"
}
```

### Response
#### Success Response (200)
- **data** (object) - The result of the GraphQL query or mutation.
- **errors** (array) - Any errors encountered during execution.

#### Response Example
```json
{
  "data": {
    "entries": [
      { "title": "First News Item", "slug": "first-news-item" },
      { "title": "Second News Item", "slug": "second-news-item" }
    ]
  }
}
```
```

--------------------------------

### Install Craft MCP Plugin via Craft CLI

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/README.md

Installs the Craft MCP plugin after it has been added via Composer. This command is executed through the Craft CMS command-line interface.

```bash
php craft plugin/install mcp
```

--------------------------------

### Route and Command Listing

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/system.md

Endpoints for retrieving information about registered routes and available console commands within the Craft installation.

```APIDOC
## GET /list_routes

### Description
Get all registered routes in your Craft installation, including those from section URL formats, category groups, and your custom `config/routes.php` file. This is essential for debugging 404 errors or understanding URL mappings.

### Method
GET

### Endpoint
/list_routes

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
list_routes
```

### Response
#### Success Response (200)
- **count** (integer) - The total number of registered routes.
- **routes** (array) - An array of route objects.
  - **pattern** (string) - The URL pattern for the route.
  - **template** (string|null) - The template associated with the route.
  - **type** (string) - The source of the route (e.g., `config`, `section`, `category`).
  - **section** (string, optional) - The section associated with the route if type is `section`.

#### Response Example
```json
{
  "count": 15,
  "routes": [
    {
      "pattern": "news/<slug>",
      "template": "news/_entry",
      "type": "section",
      "section": "news"
    },
    {
      "pattern": "api/search",
      "template": null,
      "type": "config"
    }
  ]
}
```

**Available route types:**
- `config`: Defined in `config/routes.php`
- `section`: Auto-generated from a section's URL format
- `category`: Auto-generated from a category group's URL format
```

```APIDOC
## GET /list_console_commands

### Description
List all available CLI commands, including those added by plugins. This helps AI assistants understand what operations can be performed via the command line.

### Method
GET

### Endpoint
/list_console_commands

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
list_console_commands
```

### Response
#### Success Response (200)
- **count** (integer) - The total number of available console commands.
- **commands** (array) - An array of command objects.
  - **id** (string) - The unique identifier for the command.
  - **description** (string) - A brief description of what the command does.

#### Response Example
```json
{
  "count": 25,
  "commands": [
    {
      "id": "cache",
      "description": "Clear and manage caches"
    },
    {
      "id": "migrate",
      "description": "Run database migrations"
    },
    {
      "id": "project-config",
      "description": "Manage project config"
    }
  ]
}
```
```

--------------------------------

### MCP Configuration with Environment Variables

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/configuration.md

Shows how to use environment variables with Craft's `App::env()` helper to dynamically configure MCP settings like `enabled` and `enableDangerousTools`. This allows for environment-specific settings without modifying code.

```php
<?php

use craft\helpers\App;

return [
    'enabled' => App::env('MCP_ENABLED') ?? false,
    'enableDangerousTools' => App::env('MCP_DANGEROUS_TOOLS') ?? false,
];

```

```bash
# Enable the MCP server
MCP_ENABLED=true

# Enable dangerous tools (tinker, run_query, create_entry, etc.)
MCP_DANGEROUS_TOOLS=false

```

--------------------------------

### Query Entries with list_entries Tool

Source: https://context7.com/stimmtdigital/craft-mcp/llms.txt

Demonstrates the usage of the `list_entries` tool in Craft MCP for querying content. It shows examples of filtering entries by section, type, status, and applying limits for pagination.

```bash
# Get the 10 most recent news entries
list_entries section="news" limit=10

# Get all live blog posts of a specific type
list_entries section="blog" type="article" status="live"
```

--------------------------------

### List Craft CMS Sections

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/system.md

Retrieves information about all sections in a Craft CMS installation, detailing their types (single, channel, structure) and available entry types. This helps in understanding the content structure and organization of the site. This command takes no parameters.

```shell
list_sections
```

--------------------------------

### Run Craft MCP Installation Wizard

Source: https://context7.com/stimmtdigital/craft-mcp/llms.txt

Initiates the interactive configuration wizard for Craft MCP. This wizard helps in automatically generating MCP client configuration files and supports options for specifying the environment, server name, and interactive mode.

```bash
php craft mcp/install
php craft mcp/install --environment=ddev
php craft mcp/install --serverName=my-craft-site
php craft mcp/install --interactive=0
```

--------------------------------

### Explain MySQL/PostgreSQL Query Performance

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/debugging.md

The `explain_query` tool allows you to run MySQL or PostgreSQL's `EXPLAIN` command on a SELECT query. This helps identify performance bottlenecks by showing how the database will execute the query, whether indexes are used, and the estimated number of rows to be scanned. It only accepts SELECT statements and has security restrictions similar to `run_query`.

```shell
explain_query sql="SELECT * FROM craft_entries WHERE sectionId = 1"
```

--------------------------------

### Claude Code MCP Server Configuration (Native PHP)

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/installation.md

JSON configuration for Claude Code to connect to the MCP server with a native PHP installation. This specifies the direct command to execute the server.

```json
{
  "mcpServers": {
    "craft-cms": {
      "command": "php",
      "args": ["vendor/stimmt/craft-mcp/bin/mcp-server"]
    }
  }
}
```

--------------------------------

### explain_query

Source: https://context7.com/stimmtdigital/craft-mcp/llms.txt

Runs MySQL or PostgreSQL's `EXPLAIN` command on a SELECT query.

```APIDOC
## POST /explain_query

### Description
Runs MySQL or PostgreSQL's `EXPLAIN` command on a SELECT query to understand how the database will execute it.

### Method
POST

### Endpoint
/explain_query

### Parameters
#### Query Parameters
- **sql** (string) - Required - The SQL SELECT query to explain.

### Request Example
```
{
  "sql": "SELECT * FROM craft_entries WHERE sectionId = 1"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the explanation was successful.
- **driver** (string) - The database driver used (e.g., "mysql").
- **query** (string) - The original SQL query.
- **explain** (array) - An array of explanation details.
- **warnings** (array) - Any warnings generated during the explanation.

#### Response Example
```json
{
  "success": true,
  "driver": "mysql",
  "query": "SELECT * FROM craft_entries WHERE sectionId = 1",
  "explain": [
    {
      "id": 1,
      "select_type": "SIMPLE",
      "table": "craft_entries",
      "type": "ref",
      "possible_keys": "idx_entries_sectionId",
      "key": "idx_entries_sectionId",
      "rows": 45,
      "Extra": "Using where"
    }
  ],
  "warnings": []
}
```
```

--------------------------------

### Get Custom Routes Configuration

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/resources.md

Retrieves the custom route configurations defined in your Craft installation. This resource exposes how specific URIs are mapped to controller actions or templates.

```json
{
  "routes": {
    "api/v1/<action>": "api/handle",
    "sitemap.xml": "templates/sitemap"
  }
}
```

--------------------------------

### Complete Craft MCP Configuration Options

Source: https://context7.com/stimmtdigital/craft-mcp/llms.txt

Provides a comprehensive example of the `config/mcp.php` file, illustrating all available configuration options including enabling/disabling the server, dangerous tools, disabling specific tools, and restricting IP addresses.

```php
<?php
// config/mcp.php

return [
    // Enable or disable the MCP server entirely
    // Default: false in production, true in other environments
    'enabled' => true,

    // Enable tools that can modify data or execute code
    // Default: false in production, true in other environments
    'enableDangerousTools' => true,

    // Disable specific tools by their snake_case name
    'disabledTools' => [
        'tinker',
        'run_query',
    ],

    // Restrict MCP connections to specific IP addresses
    // When empty, connections from any IP are allowed
    'allowedIps' => [
        '127.0.0.1',
        '::1',
    ],
];
```

--------------------------------

### Query Performance - Explain Query

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/debugging.md

Analyzes a SELECT query using MySQL or PostgreSQL's EXPLAIN command to identify performance bottlenecks and suggest optimizations.

```APIDOC
## POST /explain_query

### Description
Run MySQL or PostgreSQL's `EXPLAIN` command on a SELECT query to understand how the database will execute it. This reveals whether indexes are being used, how many rows will be scanned, and where bottlenecks might occur.

### Method
POST

### Endpoint
/explain_query

#### Parameters

##### Query Parameters
- **sql** (string) - Required - The SELECT query to analyze

### Request Example
```json
{
  "sql": "SELECT * FROM craft_entries WHERE sectionId = 1"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **driver** (string) - The database driver used (e.g., 'mysql', 'pgsql').
- **query** (string) - The original SQL query that was analyzed.
- **explain** (array) - An array of objects detailing the query execution plan.
  - **id** (integer) - The select identifier.
  - **select_type** (string) - The type of select query.
  - **table** (string) - The table being accessed.
  - **type** (string) - The join type.
  - **possible_keys** (string) - Indicates possible indexes that could be used.
  - **key** (string) - The index actually used by the query.
  - **rows** (integer) - The estimated number of rows to be examined.
  - **Extra** (string) - Additional information about how the database will execute the query.
- **warnings** (array) - An array of warnings related to the query execution.

#### Response Example (MySQL)
```json
{
  "success": true,
  "driver": "mysql",
  "query": "SELECT * FROM craft_entries WHERE sectionId = 1",
  "explain": [
    {
      "id": 1,
      "select_type": "SIMPLE",
      "table": "craft_entries",
      "type": "ref",
      "possible_keys": "idx_entries_sectionId",
      "key": "idx_entries_sectionId",
      "rows": 45,
      "Extra": "Using where"
    }
  ],
  "warnings": []
}
```
```

--------------------------------

### Get Table Row Counts

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/database.md

Provides a quick overview of content volume in your Craft installation by returning row counts for all core Craft tables. This is useful for understanding the scale of the site.

```shell
get_table_counts
```

--------------------------------

### Claude Code MCP Server Configuration (DDEV)

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/installation.md

JSON configuration for Claude Code to connect to the MCP server when using DDEV. This specifies the command to execute the server within the DDEV environment.

```json
{
  "mcpServers": {
    "craft-cms": {
      "command": "ddev",
      "args": ["exec", "php", "vendor/stimmt/craft-mcp/bin/mcp-server"]
    }
  }
}
```

--------------------------------

### Get General Configuration

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/resources.md

Retrieves safe, non-sensitive general configuration values from your Craft installation. This includes settings like dev mode status, URL settings, and timezone. Sensitive data is excluded.

```json
{
  "general": {
    "devMode": false,
    "allowAdminChanges": false,
    "allowUpdates": false,
    "cpTrigger": "admin",
    "defaultWeekStartDay": 1,
    "enableGql": true,
    "headlessMode": false,
    "isSystemLive": true,
    "maxRevisions": 10,
    "omitScriptNameInUrls": true,
    "runQueueAutomatically": true,
    "timezone": "Europe/Amsterdam",
    "useEmailAsUsername": false
  }
}
```

--------------------------------

### Get Product by ID - Craft Commerce

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/commerce.md

Retrieves detailed information for a single product using its ID. Includes all variant data, inventory settings, and pricing. Requires Craft Commerce to be installed and enabled.

```shell
get_product id=123
```

--------------------------------

### Get Order Details (Commerce)

Source: https://context7.com/stimmtdigital/craft-mcp/llms.txt

This tool retrieves detailed information for a single order, including line items and addresses. It can be used with either the order ID or the order number. Requires Craft Commerce to be installed.

```shell
# Get by ID
get_order id=789

# Get by order number
get_order number="abc123def456"
```

--------------------------------

### Run Craft MCP Interactive Configuration Wizard

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/README.md

Executes the interactive configuration wizard for Craft MCP. This command automates the setup process for MCP clients like Claude Code, Cursor, and Claude Desktop, generating necessary configuration files.

```bash
php craft mcp/install
```

--------------------------------

### Craft MCP Multi-Environment Configuration

Source: https://context7.com/stimmtdigital/craft-mcp/llms.txt

Demonstrates how to configure Craft MCP for different environments (development, staging, production) using Craft CMS's multi-environment configuration pattern. This allows for granular control over plugin behavior based on the deployment environment.

```php
<?php
// config/mcp.php

return [
    // Shared settings applied to all environments
    '*' => [
        'disabledTools' => ['tinker'],
    ],

    // Development environment - full access
    'dev' => [
        'enabled' => true,
        'enableDangerousTools' => true,
        'disabledTools' => [],
    ],

    // Staging environment - read-only access
    'staging' => [
        'enabled' => true,
        'enableDangerousTools' => false,
    ],

    // Production environment - disabled entirely
    'production' => [
        'enabled' => false,
    ],
];
```

--------------------------------

### Get Order by ID or Number - Craft Commerce

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/commerce.md

Retrieves complete details for a single order, including line items and addresses. Can be fetched using either the order ID or the full order number. Requires Craft Commerce to be installed and enabled.

```shell
# Get by ID
get_order id=789

# Get by number
get_order number="abc123def456"
```

--------------------------------

### Explore Content Model Overview

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/prompts.md

Provides a comprehensive overview of the entire content model in Craft CMS, mapping all sections, entry types, and their field relationships. It helps in understanding the overall content architecture.

```json
[
  {
    "handle": "news",
    "name": "News",
    "type": "channel",
    "entryTypes": [
      {
        "handle": "article",
        "fieldCount": 8,
        "fields": [
          {"handle": "summary", "type": "PlainText"},
          {"handle": "body", "type": "Matrix"}
        ]
      }
    ]
  }
]
```

--------------------------------

### run_query

Source: https://context7.com/stimmtdigital/craft-mcp/llms.txt

Executes a raw SQL query against the Craft database.

```APIDOC
## POST /run_query

### Description
Executes a raw SQL query against the Craft database and returns the results.

### Method
POST

### Endpoint
/run_query

### Parameters
#### Query Parameters
- **sql** (string) - Required - The SQL query to execute.

### Request Example
```
{
  "sql": "SELECT e.id, el.title, el.slug FROM craft_entries e JOIN craft_elements el ON e.id = el.id WHERE e.sectionId = 2"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the query was successful.
- **count** (integer) - The number of rows returned.
- **columns** (array) - An array of column names.
- **rows** (array) - An array of objects, where each object represents a row.

#### Response Example
```json
{
  "success": true,
  "count": 5,
  "columns": ["id", "title"],
  "rows": [
    { "id": 1, "title": "First Entry" },
    { "id": 2, "title": "Second Entry" }
  ]
}
```
```

--------------------------------

### Get Asset

Source: https://context7.com/stimmtdigital/craft-mcp/llms.txt

Get detailed information about a single asset, including dimensions, file size, and custom field values.

```APIDOC
## GET /asset

### Description
Retrieves detailed information about a specific asset.

### Method
GET

### Endpoint
/asset

### Query Parameters
- **id** (integer) - Required - The ID of the asset to retrieve.

### Response
#### Success Response (200)
- **found** (boolean) - Indicates if the asset was found.
- **asset** (object) - The asset object if found.
  - **id** (integer) - The unique identifier of the asset.
  - **title** (string) - The title of the asset.
  - **filename** (string) - The filename of the asset.
  - **kind** (string) - The type of the asset.
  - **size** (integer) - The file size in bytes.
  - **mimeType** (string) - The MIME type of the asset.
  - **width** (integer) - The width of the asset in pixels (if applicable).
  - **height** (integer) - The height of the asset in pixels (if applicable).
  - **url** (string) - The URL to access the asset.
  - **volumeHandle** (string) - The handle of the volume the asset belongs to.
  - **folderId** (integer) - The ID of the folder the asset is in.
  - **folderPath** (string) - The path to the folder the asset is in.
  - **dateCreated** (string) - The date and time the asset was created.
  - **fields** (object) - An object containing custom field data for the asset.

#### Response Example
```json
{
  "found": true,
  "asset": {
    "id": 456,
    "title": "Hero Image",
    "filename": "hero-image.jpg",
    "kind": "image",
    "size": 245678,
    "mimeType": "image/jpeg",
    "width": 1920,
    "height": 1080,
    "url": "https://example.com/uploads/hero-image.jpg",
    "volumeHandle": "images",
    "folderId": 12,
    "folderPath": "uploads/banners",
    "dateCreated": "2024-01-10T09:15:00+00:00",
    "fields": {
      "altText": "A beautiful landscape",
      "credit": "Photo by John Doe"
    }
  }
}
```
```

--------------------------------

### List Database Backups

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/backup.md

Retrieves a list of all available database backups, sorted by creation date with the most recent first. Includes details like filename, path, size, and creation timestamp.

```APIDOC
## GET /backups/list

### Description
Lists all available database backups, sorted by date with the most recent first. The response includes details about each backup file.

### Method
GET

### Endpoint
/backups/list

### Parameters
#### Query Parameters
None

### Request Example
```
GET /backups/list
```

### Response
#### Success Response (200)
- **count** (integer) - The total number of backups found.
- **backups** (array) - An array of backup objects, each containing:
  - **filename** (string) - The name of the backup file.
  - **path** (string) - The full path to the backup file on the server.
  - **size** (string) - The human-readable size of the backup file (e.g., "2.45 MB").
  - **sizeBytes** (integer) - The size of the backup file in bytes.
  - **created** (string) - The timestamp when the backup was created (e.g., "YYYY-MM-DD HH:MM:SS").
- **path** (string) - The directory path where backups are stored.

#### Response Example
```json
{
  "count": 3,
  "backups": [
    {
      "filename": "mysite--2024-01-15-143022--v5.0.0.sql",
      "path": "/var/www/html/storage/backups/mysite--2024-01-15-143022--v5.0.0.sql",
      "size": "2.45 MB",
      "sizeBytes": 2569011,
      "created": "2024-01-15 14:30:22"
    }
  ],
  "path": "/var/www/html/storage/backups"
}
```

#### Empty Response Example (200)
```json
{
  "count": 0,
  "backups": [],
  "path": "/var/www/html/storage/backups"
}
```
```

--------------------------------

### List GraphQL Tokens (Command Line)

Source: https://github.com/stimmtdigital/craft-mcp/blob/master/docs/tools/graphql.md

This command retrieves a list of all GraphQL tokens and their associated schemas. It returns metadata like token ID, UID, name, enabled status, expiry date, schema details, creation date, and last used date. Token values are not exposed.

```bash
list_graphql_tokens
```
Tokens:
Raw