directus-mcp-server: Instructions file for GitHub Copilot

GitHub Copilot Instructions

Project Overview

This is a Model Context Protocol (MCP) server that provides comprehensive tools for managing Directus schema and content. It enables AI assistants and other MCP clients to interact with Directus instances programmatically.

Key Technologies:

• TypeScript (ES2022, Node16 modules)
• Model Context Protocol SDK (@modelcontextprotocol/sdk)
• Directus SDK (@directus/sdk)
• Zod for runtime validation
• Vitest for testing
• ESLint for linting

Project Structure

src/
├── index.ts                    # Main MCP server entry point
├── directus-client.ts          # Directus API client with auth & resource factories
├── directus-client.test.ts     # Client tests
├── tools/                      # MCP tool implementations & utilities
│   ├── tool-helpers.ts         # Helper functions for creating tools
│   ├── validators.ts           # Shared Zod schemas and validators
│   ├── schema-tools.ts         # Collection, field, relation management
│   ├── schema-tools.test.ts
│   ├── content-tools.ts        # CRUD operations for items
│   ├── content-tools.test.ts
│   ├── flow-tools.ts           # Directus flow management
│   └── flow-tools.test.ts
└── types/                      # TypeScript type definitions
    └── index.ts

Development Workflow

Building

npm run build          # Compile TypeScript to dist/
npm run dev           # Watch mode for development

Testing

npm test              # Run all tests with Vitest
npm run test:watch    # Watch mode
npm run test:coverage # With coverage report

Linting

npm run lint          # Check for issues
npm run lint:fix      # Auto-fix issues

Code Style and Conventions

TypeScript

• Use ES2022 features with Node16 module resolution
• Strict mode is enabled - leverage full type safety
• Use explicit return types for exported functions
• Avoid any types (allowed in tests only)
• Use interface for public API types, type for unions/intersections