Directus MCP

🚀 Directus MCP Server

A Node.js-based server that integrates the Model Context Protocol (MCP) with Directus CMS. It allows AI clients to interactively access the Directus API via the Model Context Protocol (MCP).

🚀 Quick Start

Prerequisites

• Node.js
• NPM
• Directus Instance

Steps

1. Get your Directus API credentials

   • Access your Directus instance.
   • Create a static access token or use your email and password.
   • Ensure the security of your credentials.

2. Add to your AI editor

Using access token

{
    "mcpServers": {
        "directus": {
            "command": "npx",
            "args": ["-y", "@pixelsock/directus-mcp@latest"],
            "env": {
                "DIRECTUS_URL": "https://your-directus-instance.com",
                "DIRECTUS_ACCESS_TOKEN": "YOUR_ACCESS_TOKEN"
            }
        }
    }
}

Using email/password authentication

{
    "mcpServers": {
        "directus": {
            "command": "npx",
            "args": ["-y", "@pixelsock/directus-mcp@latest"],
            "env": {
                "DIRECTUS_URL": "https://your-directus-instance.com",
                "DIRECTUS_EMAIL": "your-email@example.com",
                "DIRECTUS_PASSWORD": "your-password"
            }
        }
    }
}

🚨 Troubleshooting

If you encounter issues, please check the following:

• Ensure that your Directus instance is running properly.
• Check your network connection to ensure that you can access the Directus API.
• Confirm the correctness of your credentials.

If the problem persists, please refer to the Directus documentation or contact the support team.

✨ Features

Here is a list of some features provided by the server:

• Data Management: Create, read, update, and delete data records.
• API Calls: Execute custom API requests.
• System Information: Get server status and configuration details.
• Log Viewing: Retrieve activity logs and error information.

🔧 Development Mode

To run the server in development mode:

1. Clone the code and install dependencies:

git clone https://github.com/pixelsock/directus-mcp.git
cd directus-mcp
npm install

2. Add credentials to the .env file:

# .env
DIRECTUS_URL=https://your-directus-instance.com
DIRECTUS_ACCESS_TOKEN=your_token_here
# Or use email/password
DIRECTUS_EMAIL=your-email@example.com
DIRECTUS_PASSWORD=your-password

3. Start the development server:

npm run dev

📚 Documentation

• Directus API Documentation
• Directus API Endpoints
• Directus JavaScript SDK Guide