# Quick Start Guide
## 1. Install Dependencies
```bash
cd mcp-odoo-server
npm install
```
## 2. Build the Server
```bash
npm run build
```
## 3. Configure Your MCP Client
### For Claude Desktop:
Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS):
```json
{
"mcpServers": {
"odoo": {
"command": "node",
"args": [
"/Users/malvernbright/development/Odoo/odoo-17.0+e.20251121/mcp-odoo-server/build/index.js"
]
}
}
}
```
Restart Claude Desktop after saving the configuration.
## 4. Get Your Odoo API Key
1. Log into your Odoo instance
2. Click on your user name (top right)
3. Go to **My Profile** → **Preferences**
4. Scroll to **Account Security**
5. Click **New API Key**
6. Give it a name (e.g., "MCP Server")
7. Copy the generated API key
## 5. Connect to Your Odoo Database
In Claude Desktop, use the connection tool:
```
Please connect to my Odoo database with these details:
- Host: localhost
- Database: mydb
- Username: admin@example.com
- API Key: [paste your api key]
- Port: 8069
- Protocol: http
```
## 6. Test Your Connection
Try these commands to verify everything works:
```
Show me the Odoo server version
```
```
List all installed modules (limit to 10)
```
```
Search for customers in my database
```
## Example Workflows
### View Customers
```
Search for all customers in res.partner and show me their names and emails
```
### Create a Sales Order
```
Create a new sales order for partner ID 14 with:
- Order date: today
- Add a line with product ID 25, quantity 5, price 100
```
### Check Module Status
```
Check if the sale_management module is installed
```
### Install a Module
```
Install the crm module
```
## Common Models
- `res.partner` - Customers and Suppliers
- `sale.order` - Sales Orders
- `product.product` - Products
- `account.move` - Invoices
- `stock.picking` - Deliveries
- `ir.module.module` - Modules
## Need Help?
- See `README.md` for detailed documentation
- Check `examples/` folder for more examples
- Review Odoo domain syntax in the main README
## Troubleshooting
**Can't connect?**
- Ensure Odoo is running
- Verify your credentials
- Check the port and protocol
**Module not found?**
- The technical name might be different
- Search for modules first: `odoo_search_read` on `ir.module.module`
**Permission denied?**
- Your user might not have the required access rights
- Use an admin account for testing
