Files

1.5 KiB

CLAUDE.md

This file provides guidance to Claude Code when working with this repository.

Project Overview

dolibarr-api-mcp -- MCP server for Dolibarr ERP/CRM REST API operations

Field Value
Platform mcp-server
Language TypeScript
Default branch main
License GPL-3.0-or-later
Wiki dolibarr-api-mcp Wiki
Standards MokoStandards

Common Commands

npm install       # Install dependencies
npm run build     # Compile TypeScript
npm run dev       # Development mode

Architecture

This is an MCP (Model Context Protocol) server. Key files:

  • src/index.ts -- server entry point and tool registration
  • src/config.ts -- configuration loading
  • src/tools/ -- individual tool implementations
  • dist/ -- compiled output (gitignored)

Rules

  • Never commit .claude/, .mcp.json, TODO.md, or *.min.css/*.min.js
  • Attribution: use Authored-by: Moko Consulting in commits
  • Branch strategy: develop on dev, merge to main for release
  • Minification: handled at build time (CI) and runtime (MokoMinifyHelper for Joomla templates)
  • Wiki: documentation lives in the Gitea wiki, not in docs/ files
  • Standards: this repo follows MokoStandards