dolibarr-mcp-server: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

This is a compliant Dolibarr MCP (Model Context Protocol) Server built with Nitro. It implements the JSON-RPC 2.0 based MCP specification to provide structured access to Dolibarr ERP/CRM API endpoints for AI-assisted development.

Development Commands

• pnpm run dev - Start development server on http://localhost:3000
• pnpm run build - Build for production
• pnpm run start - Start production server
• pnpm run typecheck - Check TypeScript types

For n8n Docker integration, start the server with host binding:

NITRO_HOST=0.0.0.0 NITRO_PORT=3000 pnpm run dev

Architecture

• Framework: Nitro (TypeScript-based)
• Protocol: JSON-RPC 2.0 (MCP compliant)
• Source Directory: server/ (configured in nitro.config.ts)
• Package Manager: Uses pnpm for package management and execution
• Main Routes:
  • / - Default homepage route
  • /mcp - Main MCP JSON-RPC endpoint (supports initialize, tools/list, tools/call)
  • /mcp/describe - HTTP GET endpoint for server information
  • /mcp/tools/call - Direct tool execution endpoint
  • /mcp/proxy/[...path] - Legacy HTTP proxy route (deprecated)

Environment Configuration

The server requires these environment variables (configured in nitro.config.ts runtime config):

• NITRO_DOLI_URL - Dolibarr API base URL (default: "http://localhost/api/index.php")
• NITRO_DOLI_KEY - Dolibarr API key (default: "super_api_key")

For Docker/n8n integration:

• NITRO_HOST - Server host binding (use "0.0.0.0" for Docker access)
• NITRO_PORT - Server port (default: 3000)

MCP Protocol Implementation

The server implements the following MCP methods via JSON-RPC 2.0:

Initialization

{"jsonrpc": "2.0", "method": "initialize", "params": {}, "id": 1}

Tools Listing

{"jsonrpc": "2.0", "method": "tools/list", "params": {}, "id": 2}