Skip to content

Commit 6c43ada

Browse files
committed
Update AI coding assistants documentation
- Fix Roo Code configuration file name to mcp_settings.json (with underscore) - Add comprehensive token refresh service integration documentation - Remove emojis for professional appearance - Remove multi-gateway support section - Add symbolic link setup option for automatic configuration updates - Enhance troubleshooting with token refresh service specific guidance
1 parent 7ee2a93 commit 6c43ada

File tree

1 file changed

+53
-17
lines changed

1 file changed

+53
-17
lines changed

docs/ai-coding-assistants-setup.md

Lines changed: 53 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,16 @@ Roo Code demonstrates the power of enterprise governance for AI development tool
5454
**Setup:**
5555
```bash
5656
# Copy Roo Code configuration
57-
cp .oauth-tokens/mcp.json ~/.vscode/mcp-settings.json
57+
cp .oauth-tokens/mcp.json ~/.vscode/mcp_settings.json
58+
```
59+
60+
**Alternative Setup Options:**
61+
```bash
62+
# Option 1: Direct copy (recommended)
63+
cp .oauth-tokens/mcp.json ~/.vscode/mcp_settings.json
64+
65+
# Option 2: Create symbolic link for automatic updates
66+
ln -sf "$(pwd)/.oauth-tokens/mcp.json" ~/.vscode/mcp_settings.json
5867
```
5968

6069
**Enterprise Use Case:**
@@ -88,22 +97,22 @@ cp .oauth-tokens/mcp.json ~/.vscode/mcp-settings.json
8897

8998
**Key Enterprise Benefits:**
9099

91-
🎯 **Centralized Control**
100+
**Centralized Control**
92101
- IT teams manage approved MCP servers across all development environments
93102
- Consistent tool availability regardless of developer setup
94103
- Rapid deployment of new tools to entire organization
95104

96-
🔐 **Secure Authentication**
105+
**Secure Authentication**
97106
- All tool access routes through enterprise identity systems (Amazon Cognito)
98107
- No individual API key management required
99-
- Automatic token refresh and rotation
108+
- Automatic token refresh and rotation via [Token Refresh Service](token-refresh-service.md)
100109

101-
📊 **Usage Analytics & Compliance**
110+
**Usage Analytics & Compliance**
102111
- Track which developers use which tools and when
103112
- Generate compliance reports for audit requirements
104113
- Monitor tool adoption and usage patterns across teams
105114

106-
**Developer Productivity**
115+
**Developer Productivity**
107116
- Zero configuration required for approved tools
108117
- Instant access to new enterprise tools as they're approved
109118
- Same experience across VS Code, Cursor, Claude Code, and other assistants
@@ -189,9 +198,30 @@ async with sse_client('https://gateway.com/mcpgw/sse', headers=headers) as (read
189198

190199
## Configuration Management
191200

192-
### Automatic Updates
201+
### Automatic Token Refresh
202+
203+
The MCP Gateway includes an [Automated Token Refresh Service](token-refresh-service.md) that provides continuous token management:
204+
205+
```bash
206+
# Start the token refresh service (runs in background)
207+
./start_token_refresher.sh
208+
209+
# Service automatically:
210+
# - Monitors token expiration (1-hour buffer by default)
211+
# - Refreshes tokens before they expire
212+
# - Updates all MCP client configurations
213+
# - Generates fresh configs for all AI assistants
214+
```
215+
216+
**Key Benefits:**
217+
- **Zero Downtime**: Tokens refresh automatically before expiration
218+
- **Continuous Operation**: AI assistants never lose access due to expired tokens
219+
- **Multiple Client Support**: Updates configurations for VS Code, Roo Code, Claude Code, etc.
220+
- **Background Operation**: Runs as a service with comprehensive logging
221+
222+
### Manual Configuration Updates
193223

194-
The credential generation script automatically updates configurations when run:
224+
If you need to manually regenerate configurations:
195225

196226
```bash
197227
# Regenerate all configurations
@@ -201,6 +231,8 @@ The credential generation script automatically updates configurations when run:
201231
./scripts/update-ai-assistants.sh # Custom script you can create
202232
```
203233

234+
**For AI assistants using symbolic links** (recommended setup), configuration updates are automatic since they point to the live `.oauth-tokens/` files.
235+
204236
### Environment-Specific Configurations
205237

206238
**Development Environment:**
@@ -217,21 +249,25 @@ ENVIRONMENT=prod ./credentials-provider/generate_creds.sh
217249
cp .oauth-tokens/prod-* ~/.vscode/
218250
```
219251

220-
### Multi-Gateway Support
252+
## Troubleshooting
221253

222-
For organizations with multiple MCP Gateway instances:
254+
### Authentication Issues
255+
256+
**Token Expired:**
223257

258+
*If using Token Refresh Service (recommended):*
224259
```bash
225-
# Configure multiple gateways
226-
cp .oauth-tokens/gateway-us-east-1.json ~/.vscode/settings-us-east-1.json
227-
cp .oauth-tokens/gateway-eu-west-1.json ~/.vscode/settings-eu-west-1.json
228-
```
260+
# Check if token refresh service is running
261+
ps aux | grep token_refresher
229262

230-
## Troubleshooting
263+
# Restart token refresh service if needed
264+
./start_token_refresher.sh
231265

232-
### Authentication Issues
266+
# Check service logs
267+
tail -f token_refresher.log
268+
```
233269

234-
**Token Expired:**
270+
*Manual token refresh:*
235271
```bash
236272
# Regenerate credentials
237273
./credentials-provider/generate_creds.sh

0 commit comments

Comments
 (0)