Skip to content

Commit c69668a

Browse files
author
Lasim
committed
Enhance device management documentation for MCP configuration, emphasizing automatic registration, security, and multi-device support.
1 parent 35dfcb2 commit c69668a

5 files changed

Lines changed: 411 additions & 17 deletions

File tree

docs/device-management.mdx

Lines changed: 303 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,303 @@
1+
---
2+
title: Device Management
3+
description: Understand how DeployStack manages devices across your organization for security, compliance, and seamless multi-device MCP configuration workflows.
4+
sidebar: Device Management
5+
icon: Monitor
6+
---
7+
8+
# Device Management
9+
10+
DeployStack automatically tracks and manages devices across your organization to enable secure multi-device MCP configurations, enterprise governance, and seamless user experiences. Every device that accesses DeployStack is registered and managed through our comprehensive device management system.
11+
12+
## Why Device Management Matters
13+
14+
Device management is essential for DeployStack's three-tier MCP configuration system and enterprise security:
15+
16+
**🏢 Enterprise Governance**
17+
- **Visibility**: Administrators can see which devices access which MCP servers across the organization
18+
- **Compliance**: Complete audit trails for regulatory requirements and security policies
19+
- **Access Control**: Ability to manage and revoke device access when needed
20+
- **Risk Management**: Identify and respond to unauthorized or compromised devices
21+
22+
**👥 Team Collaboration**
23+
- **Multi-Device Workflows**: Users seamlessly work across laptops, desktops, and cloud workstations
24+
- **Device-Specific Configurations**: Different MCP settings for different environments (development vs. production machines)
25+
- **Team Visibility**: Team administrators can see device usage patterns and optimize configurations
26+
27+
**🔒 Security & Trust**
28+
- **Device Authentication**: Each device is uniquely identified and authenticated
29+
- **Hardware Fingerprinting**: Secure device identification based on system characteristics
30+
- **Trust Management**: Mark devices as trusted or untrusted based on organizational policies
31+
- **Automatic Registration**: Devices are registered securely during OAuth2 login flow
32+
33+
## How Device Registration Works
34+
35+
Device registration happens automatically and securely during the CLI login process:
36+
37+
### Automatic Registration Process
38+
39+
1. **User Initiates Login**: User runs `deploystack login` command
40+
2. **OAuth2 Flow Begins**: Standard OAuth2 authorization with PKCE security
41+
3. **Device Detection**: Gateway automatically detects device information:
42+
- Device name (hostname)
43+
- Hardware fingerprint (unique identifier based on MAC addresses and system info)
44+
- Operating system and version
45+
- System architecture
46+
- Node.js version for compatibility
47+
4. **Secure Registration**: Device info is included in OAuth2 token exchange
48+
5. **Backend Processing**: Device is registered or updated in the database
49+
6. **User Confirmation**: User sees "📱 Device registered: [device-name]" message
50+
51+
### Security Benefits of Integrated Registration
52+
53+
- **No Separate Endpoints**: Device registration only happens during authenticated login sessions
54+
- **OAuth2 Security**: Leverages existing OAuth2 security with PKCE
55+
- **Hardware Fingerprinting**: Unique device identification without user input
56+
- **Automatic Process**: No manual device management required
57+
58+
For technical details on the OAuth2 integration, see [Gateway OAuth Implementation](/development/gateway/oauth#automatic-device-registration).
59+
60+
## Device Information Collected
61+
62+
DeployStack collects minimal device information necessary for identification and configuration management:
63+
64+
**🔍 Device Identification**
65+
- **Device Name**: User-friendly name (defaults to hostname, can be customized)
66+
- **Hardware ID**: Unique fingerprint based on MAC addresses and system characteristics
67+
- **Hostname**: System hostname for identification
68+
69+
**💻 System Information**
70+
- **Operating System**: Type and version (macOS, Windows, Linux)
71+
- **Architecture**: System architecture (x64, arm64, etc.)
72+
- **Node.js Version**: For compatibility tracking and troubleshooting
73+
- **User Agent**: CLI version and platform information
74+
75+
**📊 Usage Metadata**
76+
- **Last Login**: When the device was last used for authentication
77+
- **Last Activity**: Most recent MCP server interaction
78+
- **Trust Status**: Whether the device is marked as trusted
79+
- **Active Status**: Whether the device is currently active
80+
81+
## Multi-Device User Experience
82+
83+
Users can seamlessly work across multiple devices with device-specific configurations:
84+
85+
### Device-Specific MCP Configurations
86+
87+
Each device maintains its own personal MCP configuration while inheriting team settings:
88+
89+
**Example: Filesystem MCP Server**
90+
- **MacBook Pro**: `/Users/alice/Development`, `/Users/alice/Projects`
91+
- **Work Desktop**: `C:\Users\alice\Projects`, `C:\Company\Shared`
92+
- **Cloud Workstation**: `/home/alice/workspace`, `/data/projects`
93+
94+
**Shared Team Settings** (inherited on all devices):
95+
- Team API keys and credentials
96+
- Shared project directories
97+
- Team-wide configuration standards
98+
99+
### Device Management Interface
100+
101+
Users can manage their devices through the DeployStack interface:
102+
103+
```
104+
Your Devices
105+
106+
📱 MacBook Pro (Current Device)
107+
├─ Last Login: 2 minutes ago
108+
├─ Status: Active, Trusted
109+
├─ MCP Configurations: 5 active
110+
└─ [Configure] [View Details]
111+
112+
🖥️ Work Desktop
113+
├─ Last Login: Yesterday
114+
├─ Status: Active, Trusted
115+
├─ MCP Configurations: 3 active
116+
└─ [Configure] [View Details]
117+
118+
☁️ Cloud Workstation
119+
├─ Last Login: 3 days ago
120+
├─ Status: Inactive
121+
├─ MCP Configurations: 2 configured
122+
└─ [Configure] [Reactivate]
123+
```
124+
125+
## Administrator Perspective
126+
127+
### Enterprise Device Visibility
128+
129+
Administrators have comprehensive visibility into device usage across the organization:
130+
131+
**📊 Device Analytics Dashboard**
132+
- Total devices across all teams
133+
- Active vs. inactive device counts
134+
- Device types and operating systems
135+
- MCP server usage by device
136+
- Security alerts and untrusted devices
137+
138+
**🔍 Device Search and Filtering**
139+
- Search by user, team, or device name
140+
- Filter by operating system, trust status, or activity
141+
- View device-specific MCP configurations
142+
- Export device reports for compliance
143+
144+
### Security Management
145+
146+
**🛡️ Device Trust Management**
147+
- Mark devices as trusted or untrusted
148+
- Automatically trust devices from known networks
149+
- Require manual approval for new devices
150+
- Bulk trust management for organizational devices
151+
152+
**🚨 Security Monitoring**
153+
- Detect unusual device activity patterns
154+
- Alert on new device registrations
155+
- Monitor for potential security threats
156+
- Track device access to sensitive MCP servers
157+
158+
**⚙️ Device Policies**
159+
- Set maximum devices per user
160+
- Require device naming conventions
161+
- Enforce device trust requirements
162+
- Configure automatic device cleanup policies
163+
164+
## Team Administrator Perspective
165+
166+
### Team Device Overview
167+
168+
Team administrators can monitor device usage within their teams:
169+
170+
**👥 Team Device Dashboard**
171+
- All devices used by team members
172+
- Device-specific MCP configuration usage
173+
- Team member device patterns
174+
- Device compliance with team policies
175+
176+
**📈 Usage Analytics**
177+
- Which MCP servers are used on which devices
178+
- Device-specific configuration patterns
179+
- Team productivity insights
180+
- Resource utilization by device type
181+
182+
### Device-Aware Configuration Management
183+
184+
Team administrators can optimize configurations based on device usage:
185+
186+
**💡 Configuration Insights**
187+
- See how team members configure MCP servers across different devices
188+
- Identify common device-specific patterns
189+
- Optimize team configurations for different device types
190+
- Provide device-specific guidance and templates
191+
192+
## Security & Governance
193+
194+
### Compliance Benefits
195+
196+
**📋 Audit Trails**
197+
- Complete history of device access to MCP servers
198+
- Track configuration changes by device
199+
- Monitor team member device usage patterns
200+
- Generate compliance reports for auditors
201+
202+
**🔐 Access Control**
203+
- Revoke access for lost or stolen devices
204+
- Temporarily disable suspicious devices
205+
- Enforce device trust requirements
206+
- Control device access to sensitive MCP servers
207+
208+
### Data Protection
209+
210+
**🛡️ Device Security**
211+
- Hardware fingerprinting prevents device spoofing
212+
- Encrypted device information storage
213+
- Secure device authentication
214+
- Protection against unauthorized device access
215+
216+
**🔒 Privacy Controls**
217+
- Minimal device information collection
218+
- User control over device naming
219+
- Secure storage of device metadata
220+
- Clear data retention policies
221+
222+
For platform-level device security details, see [Security and Privacy](/security#device-security).
223+
224+
## Device Lifecycle Management
225+
226+
### Device States
227+
228+
**✅ Active Devices**
229+
- Recently used for MCP server access
230+
- Receiving configuration updates
231+
- Included in team analytics
232+
- Full access to team MCP installations
233+
234+
**⏸️ Inactive Devices**
235+
- Not used recently (configurable threshold)
236+
- Configurations preserved but not updated
237+
- Excluded from active analytics
238+
- Can be reactivated by user login
239+
240+
**🚫 Disabled Devices**
241+
- Manually disabled by administrators
242+
- No access to MCP servers
243+
- Configurations preserved for potential reactivation
244+
- Requires administrator action to re-enable
245+
246+
**🗑️ Removed Devices**
247+
- Permanently removed from the system
248+
- All configurations deleted
249+
- Cannot be recovered
250+
- Audit trail preserved for compliance
251+
252+
### Automatic Cleanup
253+
254+
**⏰ Inactive Device Management**
255+
- Automatically mark devices inactive after configurable period
256+
- Send notifications before marking devices inactive
257+
- Preserve configurations for potential reactivation
258+
- Clean up truly abandoned devices
259+
260+
**🧹 Data Retention**
261+
- Remove device data after extended inactivity
262+
- Preserve audit trails for compliance requirements
263+
- User notification before permanent deletion
264+
- Administrator override for important devices
265+
266+
## Integration with MCP Configuration System
267+
268+
Device management is deeply integrated with DeployStack's three-tier MCP configuration system:
269+
270+
### Device-Specific User Configurations
271+
272+
The user tier of the configuration system is inherently device-aware:
273+
274+
- **Template Level**: Global admin defines what can be configured (device-independent)
275+
- **Team Level**: Team admin sets shared settings (inherited by all user devices)
276+
- **User Level**: Individual users configure personal settings **per device**
277+
278+
For complete details on the three-tier system, see [MCP Configuration System](/mcp-configuration).
279+
280+
### Configuration Assembly by Device
281+
282+
When a user accesses MCP servers, configurations are assembled per device:
283+
284+
```
285+
Final Configuration = Template + Team + User (This Device)
286+
287+
Template (Global): Command, package, system flags
288+
+ Team (Shared): API keys, shared directories, team standards
289+
+ User Device (Personal): Device-specific paths, preferences, debug settings
290+
= Runtime Configuration for This Device
291+
```
292+
293+
## Related Documentation
294+
295+
For complete understanding of device management in context:
296+
297+
- [MCP Configuration System](/mcp-configuration) - How device-specific configurations work within the three-tier system
298+
- [MCP User Configuration](/mcp-user-configuration) - User experience for multi-device configuration
299+
- [Security and Privacy](/security) - Platform-level device security implementation
300+
- [Gateway OAuth Implementation](/development/gateway/oauth) - Technical details of device registration during login
301+
- [Teams](/teams) - Team structure and device visibility for team administrators
302+
303+
Device management enables DeployStack to provide secure, scalable, and user-friendly MCP server management across any number of devices while maintaining enterprise-grade governance and compliance capabilities.

docs/mcp-configuration.mdx

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ The system separates configuration into three distinct layers:
1414

1515
1. **Template Level** - Global schemas and locked elements defined by administrators
1616
2. **Team Level** - Shared team configurations with lock/unlock controls
17-
3. **User Level** - Personal configurations within team-defined boundaries
17+
3. **User Level** - Personal configurations within team-defined boundaries **per device**
1818

19-
This architecture enables teams to share common settings like API keys while allowing individual members to customize personal settings like local file paths.
19+
This architecture enables teams to share common settings like API keys while allowing individual members to customize personal settings like local file paths across multiple devices. Each user can have different configurations on different devices while maintaining team security and standards.
2020

2121
## How It Works
2222

@@ -42,11 +42,12 @@ This architecture enables teams to share common settings like API keys while all
4242
4343
4444
┌─────────────────────────────────────────────────────────────────────────────────┐
45-
│ TIER 3: USER (Individual)
45+
│ TIER 3: USER (Individual) - Device-Aware
4646
│ ┌─────────────────────────────────────────────────────────────────────────────┐ │
47-
│ │ 🔓 Personal Settings: Local paths, preferences │ │
48-
│ │ 💻 Multi-Device: Different configs per device │ │
49-
│ │ 🔗 Automatic Inheritance: Use team credentials seamlessly │ │
47+
│ │ 🔓 Personal Settings: Local paths, preferences (per device) │ │
48+
│ │ 💻 Multi-Device: Different configs per device with automatic registration │ │
49+
│ │ 🔗 Automatic Inheritance: Use team credentials seamlessly across devices │ │
50+
│ │ 🛡️ Device Security: Hardware fingerprinting and secure registration │ │
5051
│ └─────────────────────────────────────────────────────────────────────────────┘ │
5152
└─────────────────────────────────────────────────────────────────────────────────┘
5253
@@ -75,9 +76,10 @@ The heart of the system is sophisticated lock/unlock controls with precise categ
7576

7677
**User Access:**
7778
- **Personal Customization** - Modify only unlocked elements within boundaries set by global admin categorization
78-
- **Device-Specific Settings** - Configure personal settings across multiple devices
79+
- **Device-Specific Settings** - Configure personal settings across multiple devices with automatic device registration
7980
- **Secure Experience** - No access to locked configuration, team secrets, or template elements
8081
- **Focused Interface** - See only configuration elements designated as personally configurable
82+
- **Multi-Device Workflow** - Seamlessly work across different devices with device-specific configurations
8183

8284
## User Journey Workflows
8385

@@ -118,7 +120,7 @@ Here's how the three tiers combine into a final runtime configuration:
118120
}
119121
```
120122

121-
**User (Individual):**
123+
**User (Individual - i.e.: your MacBook Pro):**
122124
```json
123125
{
124126
"args": ["/Users/alice/Development", "/Users/alice/Projects"],
@@ -164,12 +166,34 @@ Here's how the three tiers combine into a final runtime configuration:
164166

165167
**Support Teams:** Share customer service API keys while allowing personal workspace customization
166168

169+
## Device-Aware Architecture Benefits
170+
171+
**🏢 Enterprise Governance**
172+
- Complete visibility into device usage across the organization
173+
- Device-specific audit trails for compliance and security
174+
- Centralized device management with trust-based access control
175+
176+
**👥 Team Collaboration**
177+
- Team administrators can see device usage patterns and optimize configurations
178+
- Device-specific insights help teams understand productivity patterns
179+
- Seamless collaboration across different device types and environments
180+
181+
**🔒 Enhanced Security**
182+
- Hardware fingerprinting prevents device spoofing
183+
- Automatic device registration during secure OAuth2 login
184+
- Device trust management and access revocation capabilities
185+
- No separate device registration endpoints (security by design)
186+
187+
For comprehensive device management details, see [Device Management](/device-management).
188+
167189
## Related Documentation
168190

169191
For complete system understanding:
170192

193+
- [Device Management](/device-management) - Comprehensive device management and security
171194
- [MCP Catalog](/mcp-catalog) - Browse and discover available MCP servers
172195
- [Teams](/teams) - Team structure and membership management
173196
- [MCP Installation](/mcp-installation) - Basic MCP server installation concepts
197+
- [Security and Privacy](/security) - Platform security including device security
174198

175-
The three-tier configuration system provides secure, scalable MCP server management that grows from individual developers to enterprise teams while maintaining simplicity and security at every level. Global administrators have sophisticated control over configuration boundaries through schema categorization, ensuring appropriate access and customization at each tier.
199+
The three-tier configuration system provides secure, scalable MCP server management that grows from individual developers to enterprise teams while maintaining simplicity and security at every level. Global administrators have sophisticated control over configuration boundaries through schema categorization, ensuring appropriate access and customization at each tier. The device-aware architecture enables seamless multi-device workflows while maintaining enterprise-grade security and governance.

0 commit comments

Comments
 (0)