QUICK_START.mdβ’4.66 kB
# β‘ Quick Start - Publish to Smithery NOW
Your Dokploy MCP Server is **ready to publish**! Here's the fastest path to get it working.
## π― Current Status
β
Code pushed to GitHub: https://github.com/huuthangntk/dokploy-mcp
β
Repository is public
β
All documentation complete
β
MCP configuration updated
β³ **NEXT STEP: Publish to Smithery**
## π 3-Step Process
### Step 1: Publish to Smithery (2 minutes)
**Go here NOW**: **[https://smithery.ai/new](https://smithery.ai/new)**
1. Click **"Connect with GitHub"** (if needed)
2. Select repository: **`huuthangntk/dokploy-mcp`**
3. Click **"Publish"**
4. Wait for build to complete (1-2 minutes)
### Step 2: Restart Cursor (30 seconds)
1. **Save all files** (Ctrl+S)
2. **Close Cursor completely**
3. **Reopen Cursor**
4. Wait for status bar to show "Connected"
### Step 3: Test It! (10 seconds)
In Cursor chat, type:
```
List all my Dokploy projects
```
You should see your projects! π
## π What Was Done
β
**Fixed Authentication Headers**
- Changed from `Authorization: Bearer` to `x-api-key`
- Tested with your Dokploy instance
β
**Pushed to GitHub**
- Repository: https://github.com/huuthangntk/dokploy-mcp
- Branch: main
- All commits pushed
β
**Updated MCP Configuration**
- File: `C:\Users\Yomen\.cursor\mcp.json`
- Changed from local execution to Smithery URL
- Added your Dokploy credentials
β
**Configuration Set**
```json
"dokploy-mcp": {
"type": "http",
"url": "https://server.smithery.ai/@huuthangntk/dokploy-mcp/mcp?dokployUrl=https://dok.bish.one&apiToken=bishone...&debug=false",
"headers": {}
}
```
## π― Expected Smithery URL
After publishing, your server will be at:
```
https://server.smithery.ai/@huuthangntk/dokploy-mcp/mcp
```
This URL is **already configured** in your mcp.json! β
## π If It Doesn't Work
### Problem: "Server not found" after publishing
**Solution**: The Smithery URL format might be different. Check Smithery dashboard for exact URL.
Update line 39 in `C:\Users\Yomen\.cursor\mcp.json` with the exact URL from Smithery.
### Problem: Still getting 401 errors
**Solution**: Verify your API token is correct:
```bash
curl -X GET "https://dok.bish.one/api/project.all" \
-H "accept: application/json" \
-H "x-api-key: bishoneOTLRvuGdFzijbKeLPwYnKMfMVJyAMhIeNxvnYxrVDTystsNRMSakzfohCAilySAb"
```
If this works, the token is good!
### Problem: MCP server not connecting
**Solution**: Check Cursor's MCP status (bottom bar)
- Should show "dokploy-mcp: Connected"
- If not, restart Cursor again
## π Documentation Files
All documentation is ready:
- `README.md` - Complete project documentation
- `SMITHERY_PUBLISH.md` - Detailed publishing guide
- `AUTH_SETUP.md` - Authentication troubleshooting
- `SETUP.md` - GitHub setup guide
- `PROJECT_SUMMARY.md` - Feature overview
- `QUICK_START.md` - This file!
## π What You'll Be Able To Do
Once connected, you can:
β
**Manage Projects**
- List all projects
- Create new projects
- Delete projects
β
**Deploy Applications**
- Create apps from GitHub repos
- Deploy applications
- Start/stop/restart apps
- View logs and status
β
**Manage Databases**
- Create PostgreSQL, MySQL, MongoDB, Redis, MariaDB
- List all databases
β
**Configure Domains**
- Add custom domains
- Enable SSL (Let's Encrypt)
β
**Backup & Restore**
- Create database backups
- Restore from backups
β
**Monitor Everything**
- Real-time logs
- Application health status
- Error tracking
## π Important Links
- **Publish Here**: https://smithery.ai/new
- **Your GitHub**: https://github.com/huuthangntk/dokploy-mcp
- **Your Dokploy**: https://dok.bish.one
- **Smithery Docs**: https://smithery.ai/docs
- **Smithery Discord**: https://discord.gg/Afd38S5p9A
## β‘ Quick Commands Reference
Test your connection:
```
List all my Dokploy projects
Show my Dokploy applications
Create a new Dokploy project called "test-project"
Deploy my application
Show logs for my app
```
## β
Final Checklist
- [ ] Go to https://smithery.ai/new
- [ ] Connect GitHub account
- [ ] Select `huuthangntk/dokploy-mcp`
- [ ] Click "Publish"
- [ ] Wait for build to complete
- [ ] Restart Cursor
- [ ] Test: "List all my Dokploy projects"
## π You're Almost There!
Just publish to Smithery and restart Cursor - that's it!
The hard work is done:
- β
Code complete and tested
- β
GitHub repository ready
- β
Authentication fixed
- β
Configuration updated
- β
Documentation complete
**Time to publish: 2 minutes**
**Time to test: 10 seconds**
**Total time: < 3 minutes**
---
**Ready? Go to [smithery.ai/new](https://smithery.ai/new) now!** π