Merge branch 'main' into codex/cleanup-unnecessary-files-and-scripts

This commit is contained in:
latinogino
2025-10-12 15:28:38 +02:00
committed by GitHub
2 changed files with 40 additions and 27 deletions

View File

@@ -4,11 +4,16 @@ All notable changes to the Dolibarr MCP Server are documented here. The project
follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and adopts the
[Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
## [Unreleased]
### Added
- Restored README.md and CHANGELOG.md after merge conflicts while preserving the streamlined structure shared with `prestashop-mcp`.
- Documented platform-specific setup covering Linux/macOS shells, Windows Visual Studio `vsenv`, and the Docker workflow.
### Changed
- Clarified the Windows (`vsenv`) workflow so Claude Desktop uses the correct virtual environment path and arguments.
- Added a concrete Claude Desktop configuration example covering `DOLIBARR_URL`/`DOLIBARR_API_KEY` usage and JSON path formatting.
- Reconciled feature and tool descriptions so they capture both the detailed ERP coverage and the new documentation bundle layout.
- Clarified configuration guidance around `pydantic-settings`, environment variables, and `.env` files.
### Removed
- Obsolete references to legacy helper scripts and superseded documentation variants that were dropped during the repository cleanup.
## [1.1.0] - 2024-05-22
@@ -21,6 +26,17 @@ follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and adopts th
- Rewrote the README to highlight the streamlined structure and provide concise installation/run instructions.
- Clarified that `dolibarr_mcp_server.py` is the definitive MCP entry point.
## [1.1.0] - 2024-05-22
### Removed
- Legacy helper scripts, installers and manual test programs that duplicated the automated test-suite
- Alternative server implementations (`simple_client`, `standalone_server`, `ultra_simple_server`) in favour of the single `dolibarr_mcp_server`
- Redundant documentation fragments and variant requirements files that no longer reflected the current project layout
### Changed
- Rewrote the README to highlight the streamlined structure and provide concise installation/run instructions
- Clarified that `dolibarr_mcp_server.py` is the definitive MCP entry point
## [1.0.0] - 2024-01-26
### 🎯 Major Restructuring

View File

@@ -6,7 +6,11 @@ the clean layout used by [`prestashop-mcp`](https://github.com/latinogino/presta
a single production-ready server implementation, an async HTTP client, and a
self-contained documentation bundle.
## 🚀 Overview
This MCP server enables complete management of your Dolibarr ERP/CRM through AI
tools such as Claude Desktop. With specialised tools you can manage customers,
products, invoices, orders, contacts, and system administration tasks from a
single MCP endpoint.
This MCP server enables complete management of your Dolibarr ERP/CRM through AI
tools such as Claude Desktop. With specialised tools you can manage customers,
@@ -121,29 +125,7 @@ Add an entry to `claude_desktop_config.json` that points to your virtual
environments Python executable and the `dolibarr_mcp.cli` module. After
installation, verify the executable path with `which python` (Linux/macOS) or
`where python` (Windows `vsenv`). Restart Claude Desktop so it picks up the new
MCP server. A working Windows configuration looks like this:
```json
{
"dolibarr-python": {
"command": "C:/Users/you/GitHub/dolibarr-mcp/.venv/Scripts/python.exe",
"args": [
"-m",
"dolibarr_mcp.cli",
"serve"
],
"cwd": "C:/Users/you/GitHub/dolibarr-mcp",
"env": {
"DOLIBARR_URL": "https://your-dolibarr.example.com/api/index.php",
"DOLIBARR_API_KEY": "your_api_key"
}
}
}
```
Use forward slashes in the JSON path or escape backslashes, and keep the
`command` value synchronized with the output of `where python` while the `.venv`
is activated.
MCP server.
## 🧪 Development workflow
@@ -154,6 +136,21 @@ is activated.
- Contributions follow the same structure and documentation conventions as
`prestashop-mcp` to keep the twin projects in sync.
```bash
python -m dolibarr_mcp.cli test --url https://your-dolibarr.example.com/api/index.php --api-key YOUR_KEY
```
## Available tools
- **System** `test_connection`, `get_status`
- **Users** `get_users`, `get_user_by_id`, `create_user`, `update_user`, `delete_user`
- **Customers / Third parties** `get_customers`, `get_customer_by_id`, `create_customer`, `update_customer`, `delete_customer`
- **Products** `get_products`, `get_product_by_id`, `create_product`, `update_product`, `delete_product`
- **Invoices** `get_invoices`, `get_invoice_by_id`, `create_invoice`, `update_invoice`, `delete_invoice`
- **Orders** `get_orders`, `get_order_by_id`, `create_order`, `update_order`, `delete_order`
- **Contacts** `get_contacts`, `get_contact_by_id`, `create_contact`, `update_contact`, `delete_contact`
- **Raw API access** `dolibarr_raw_api`
## 📄 License
This project is released under the [MIT License](LICENSE).