QUICKSTART.md•3.99 kB
# Quick Start Guide
This guide will help you get the Workspace ONE UEM MCP server running in 5 minutes.
## Step 1: Install Dependencies
```bash
cd workspace-one-uem-mcp
pip install -r requirements.txt
```
## Step 2: Configure Environment
Create a `.env` file with your credentials:
```bash
cp env.example .env
```
Edit `.env` and fill in at minimum:
```bash
WS1_UEM_BASE_URL=https://your-instance.awmdm.com
WS1_UEM_API_KEY=your-api-key-here
# Choose OAuth (recommended):
WS1_UEM_CLIENT_ID=your-client-id
WS1_UEM_CLIENT_SECRET=your-client-secret
WS1_UEM_TOKEN_URL=https://na.uemauth.vmwservices.com/connect/token
# OR Basic Auth:
WS1_UEM_USERNAME=admin@company.com
WS1_UEM_PASSWORD=your-password
```
## Step 3: Test the Server
Run the server standalone to verify it works:
```bash
python server.py
```
You should see output indicating the server is running.
## Step 4: Add to Claude Desktop
Edit your Claude Desktop config:
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
Add this configuration:
```json
{
"mcpServers": {
"workspace-one-uem": {
"command": "python",
"args": ["/full/path/to/workspace-one-uem-mcp/server.py"],
"env": {
"WS1_UEM_BASE_URL": "https://your-instance.awmdm.com",
"WS1_UEM_API_KEY": "your-api-key",
"WS1_UEM_CLIENT_ID": "your-client-id",
"WS1_UEM_CLIENT_SECRET": "your-client-secret",
"WS1_UEM_TOKEN_URL": "https://na.uemauth.vmwservices.com/connect/token"
}
}
}
}
```
## Step 5: Restart Claude Desktop
Completely quit and restart Claude Desktop to load the new server.
## Step 6: Test with Claude
Try these example queries in Claude:
```
"Search for all Apple devices in Workspace ONE UEM"
"Get details for device with serial number C02ABC123"
"Show me all users in the UEM console"
"What tags are available in organization group 123?"
```
## Common Use Cases
### 1. Device Inventory Report
```
"Search for all devices and give me a summary by platform"
```
### 2. Find Inactive Devices
```
"Find all devices that haven't been seen in the last 60 days"
```
### 3. User Device Lookup
```
"Find the user john.doe@company.com and show me their devices"
```
### 4. Compliance Check
```
"Check compliance status for device with serial number C02ABC123"
```
### 5. Bulk Device Actions
```
"Send a device query command to these serial numbers: SN001, SN002, SN003"
```
### 6. Application Inventory
```
"Search for Microsoft Teams app and show me where it's deployed"
```
### 7. Event Investigation
```
"Show me all device events from January 1 to January 31, 2024"
```
### 8. Smart Group Management
```
"List all smart groups and their device counts"
```
## Troubleshooting
### "Cannot connect to server"
- Check your BASE_URL has no trailing slash
- Verify network connectivity to UEM instance
- Check firewall rules
### "401 Unauthorized"
- Verify API key is correct
- Check OAuth credentials
- Ensure OAuth client is enabled
### "403 Forbidden"
- Verify API role has required permissions
- Check organization group access
### "Server not showing in Claude"
- Verify JSON syntax in config file
- Check file paths are absolute
- Restart Claude Desktop completely
## Next Steps
- Review the README.md for complete documentation
- Check the API reference at `https://your-instance.awmdm.com/api/help`
- Explore additional tools available in the server
- Set up automated workflows using the available APIs
## Getting Help
If you encounter issues:
1. Check the Workspace ONE UEM API help page
2. Review server logs for error messages
3. Verify credentials and permissions
4. Test API calls using Postman or curl first
5. Check Omnissa documentation and community forums
## Security Reminders
- Never commit `.env` files with real credentials
- Use OAuth instead of basic auth when possible
- Create dedicated API roles with least privilege
- Regularly rotate API credentials
- Monitor API usage in UEM audit logs