Skip to content

Commit 415fee2

Browse files
author
Tony
committed
added security warning to doc
1 parent 473ab46 commit 415fee2

File tree

1 file changed

+77
-4
lines changed

1 file changed

+77
-4
lines changed

docs/agent-companion-chat.md

Lines changed: 77 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,61 @@ The Agent Companion Chat is an interactive AI assistant that provides a conversa
3232
- Quick diagnosis of individual document errors
3333
- One-time error analysis without conversation history
3434

35+
## Security and Privacy
36+
37+
### Code Intelligence and Third-Party Services
38+
39+
**⚠️ IMPORTANT: Read Before Using Code Intelligence**
40+
41+
The Agent Companion Chat includes an optional Code Intelligence Agent that can provide enhanced code assistance and technical documentation. However, this agent uses third-party MCP (Model Context Protocol) servers, which means your queries may be sent to external services.
42+
43+
**What This Means**:
44+
- When Code Intelligence is **enabled**, queries routed to this agent may be sent to external services (DeepWiki MCP server)
45+
- These external services are **not controlled by AWS** or your organization
46+
- Data sent to these services is subject to their privacy policies and terms of service
47+
48+
**Security Best Practices**:
49+
50+
**Safe to Discuss**:
51+
- General IDP features and capabilities
52+
- Public documentation and configuration examples
53+
- Generic code patterns and best practices
54+
- Non-sensitive technical questions
55+
- Publicly available information
56+
57+
**DO NOT Share**:
58+
- Customer names, email addresses, or personal information
59+
- AWS account IDs, API keys, credentials, or secrets
60+
- Proprietary business logic or confidential data
61+
- Internal system details or security configurations
62+
- Actual document content or extracted data
63+
- Customer-specific information or use cases
64+
- Private network configurations or IP addresses
65+
66+
**Built-in Protections**:
67+
- System prompts are configured to prevent the agent from sending sensitive data
68+
- The agent is instructed to refuse requests involving credentials or personal information
69+
- User-controlled toggle allows you to disable the feature entirely
70+
71+
**Recommendations**:
72+
1. **Review your questions** before sending to ensure they contain no sensitive information
73+
2. **Use other agents** (Analytics, Error Analyzer, General) for queries involving your actual system data
74+
3. **Enable only when needed** for generic code help, then disable it again
75+
76+
### Data Storage and Retention
77+
78+
**Conversation History**:
79+
- All conversations are stored in DynamoDB within your AWS account
80+
- Conversation history is retained for the duration of your session
81+
- Data remains within your AWS environment and is subject to your AWS security policies
82+
- No conversation data is sent to external services except when Code Intelligence is enabled and invoked
83+
84+
**Session Isolation**:
85+
- Each conversation has a unique session ID
86+
- Sessions are isolated from each other
87+
- Clearing chat creates a new session
88+
- Previous session data is not accessible from new sessions
89+
3590
## Architecture Overview
3691

3792
### System Design
@@ -433,17 +488,35 @@ Agent: "To prevent this validation error, update your configuration..."
433488
"What are the available configuration parameters?"
434489
```
435490

436-
**Privacy and Security**:
437-
- **User-Controlled**: Toggle on/off in the chat interface
491+
**⚠️ Privacy and Security - IMPORTANT**:
492+
493+
The Code Intelligence Agent uses a third-party MCP (Model Context Protocol) server (DeepWiki) to provide enhanced technical documentation and code assistance. This means some of your queries may be sent to external services.
494+
495+
**Security Considerations**:
438496
- **External Service**: Uses DeepWiki MCP server for documentation lookup
439-
- **Data Protection**: System prompts prevent sending sensitive data externally
440-
- **Explicit Consent**: Visual indicator shows when enabled
497+
- **Data Transmission**: When enabled, your queries may be sent to third-party services
498+
- **Built-in Protections**: System prompts are configured to prevent sending sensitive data externally
499+
- **User Control**: You must explicitly enable this feature via the toggle
500+
501+
**⚠️ DO NOT share sensitive information when Code Intelligence is enabled:**
502+
- Customer names, email addresses, or personal information
503+
- AWS account IDs, API keys, or credentials
504+
- Proprietary business logic or confidential data
505+
- Internal system details or security configurations
506+
- Actual document content or extracted data
507+
508+
**Safe to Share**:
509+
- General questions about IDP features and capabilities
510+
- Public documentation and configuration examples
511+
- Generic code patterns and best practices
512+
- Non-sensitive technical questions
441513

442514
**Enabling/Disabling**:
443515
1. Look for the "Code Intelligence" toggle in the chat interface
444516
2. Click to enable or disable
445517
3. When disabled, the orchestrator won't route queries to this agent
446518
4. Your preference is saved for the session
519+
5. **Recommendation**: Keep disabled unless you specifically need code assistance and are certain your queries contain no sensitive information
447520

448521
### General Agent
449522

0 commit comments

Comments
 (0)