START_HERE.mdā¢4.67 kB
# š START HERE - Simplicate MCP Server v2.0
## š Welcome!
You have a **complete, production-ready MCP server** for Simplicate with **63 tools** and **13 resources** covering **ALL Simplicate modules**.
---
## ā” Quick Start (3 Steps)
### Step 1: Update .env
Edit `.env` file and ensure this line is correct:
```env
SIMPLICATE_API_BASE_URL=https://act.simplicate.com/api/v2
```
### Step 2: Add to Claude Desktop
Copy this to your Claude Desktop config:
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
```json
{
"mcpServers": {
"simplicate": {
"command": "node",
"args": ["/Users/dwayne/Documents/Playground/Simplicate/dist/index.js"],
"env": {
"SIMPLICATE_API_KEY": "cDfOE6LLYzFk4F2rZyBkVur5mp4qri4S",
"SIMPLICATE_API_SECRET": "H2yMIChUpKutBYtT52q7XvDrNqZhXpKM",
"SIMPLICATE_API_BASE_URL": "https://act.simplicate.com/api/v2"
}
}
}
}
```
### Step 3: Restart Claude Desktop
**That's it!** š
---
## š Documentation Guide
### For Getting Started:
1. **READY_TO_USE.md** - Final checklist and quick start
2. **QUICKSTART.md** - Detailed setup guide
3. **CONFIGURATION.md** - Configuration for act.simplicate.com
### For Understanding What You Have:
4. **FINAL_SUMMARY.md** ā - Complete overview (READ THIS!)
5. **UPGRADE_SUMMARY.md** - v1.0 ā v2.0 changes
6. **IMPLEMENTATION_SUMMARY.md** - Technical details
### For Using the Server:
7. **FULL_API_REFERENCE.md** ā - All 63 tools with examples (MAIN REFERENCE!)
8. **README.md** - General documentation
---
## šÆ What Can You Do?
### Complete Access to ALL Simplicate Modules:
ā
**Projects** - Create, read, update, delete projects
ā
**CRM** - Manage organizations and contact persons
ā
**Sales** - Handle quotes and sales
ā
**Hours** - Time tracking and timesheets
ā
**Invoices** - Invoice management and payments
ā
**HRM** - Employee management and absences
ā
**Services** - Service catalog
ā
**Tasks** - Project task management
ā
**Costs** - Expense and mileage tracking
ā
**Documents** - Document access
ā
**Contracts** - Contract management
ā
**Search** - Search across everything
---
## š¬ Try These in Claude
Once configured, ask Claude:
**Basic Queries:**
- "Show me all projects from Simplicate"
- "List my CRM organizations"
- "Get recent timesheet hours"
- "Show me unpaid invoices"
**Creating Things:**
- "Create a new organization called 'Acme Corp'"
- "Create a project for that organization"
- "Log 8 hours for today on project X"
- "Create a task called 'Review design'"
**Complex Workflows:**
- "Set up a complete new project with tasks and quote"
- "Show me this week's team hours and costs"
- "Create an invoice for project X and show payment status"
---
## š Stats
| Metric | Value |
|--------|-------|
| **Tools** | 63 |
| **Resources** | 13 |
| **Modules** | 12 |
| **Operations** | Create, Read, Update, Delete |
| **Code Lines** | 1,763 |
| **Build Status** | ā
SUCCESS |
---
## š File Navigation
### Source Code:
- `src/config/config.ts` - Configuration management
- `src/simplicate/client.ts` - HTTP client
- `src/simplicate/services-extended.ts` ā - Complete API (593 lines)
- `src/mcp/server-full.ts` ā - Complete MCP server (1,170 lines)
- `src/index.ts` - Entry point
### Compiled Code:
- `dist/` - Production-ready JavaScript ā
### Documentation:
- All .md files in root directory
---
## ā
Verification Checklist
Before using:
- [ ] `.env` file updated with act.simplicate.com
- [ ] Claude Desktop config added
- [ ] Claude Desktop restarted
- [ ] Server builds successfully (`npm start` works)
---
## š¬ Your Next Action
1. **Option A**: Jump right in
- Add config to Claude Desktop
- Restart Claude
- Ask Claude: "Show me all projects from Simplicate"
2. **Option B**: Learn more first
- Read **FULL_API_REFERENCE.md** for all capabilities
- Read **FINAL_SUMMARY.md** for complete overview
- Then configure Claude Desktop
---
## š Recommended Reading Order
1. **START_HERE.md** (this file) ā
2. **FINAL_SUMMARY.md** - Complete overview
3. **FULL_API_REFERENCE.md** - All tools and examples
4. **READY_TO_USE.md** - Final checklist
---
## š You're Ready!
Everything is built, compiled, and ready to use.
**Just add the config to Claude Desktop and restart!**
Questions? Check:
- **FULL_API_REFERENCE.md** for tool examples
- **CONFIGURATION.md** for setup help
- **README.md** for troubleshooting
---
**š Enjoy your complete Simplicate integration!**
*Server Version: 2.0.0 (Full Implementation)*
*Status: Production Ready ā
*