Skip to content

Commit dd9f188

Browse files
committed
Add API Key Management and Tool Configuration to documentation
- Updated `README.md` to include a new section on API Key Management with an integrated settings panel for secure storage and tool configuration. - Enhanced `features.md` with detailed descriptions of the API key management system and its user-friendly interface for managing tools directly from the web UI. - Expanded `web-ui-guide.md` to provide step-by-step instructions for configuring tools and managing API keys, including benefits and usage examples. - Improved overall documentation clarity regarding tool configuration and API key management features.
1 parent 620862e commit dd9f188

3 files changed

Lines changed: 83 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,14 @@ Below are screenshots showing the evolution of the DeepSeek Wrapper web UI and f
108108
<li><b>Custom tool creation system</b></li>
109109
</ul>
110110
</div>
111+
<div style="flex: 1; min-width: 250px; border-left: 4px solid #2EC4B6; padding: 10px; background: #F0FFFC; margin: 5px 0;">
112+
<h3 style="color: #2EC4B6; margin-top: 0;">API Key Management</h3>
113+
<ul>
114+
<li><b>Integrated settings panel</b></li>
115+
<li><b>Secure API key storage in .env</b></li>
116+
<li><b>Tool configuration UI</b></li>
117+
</ul>
118+
</div>
111119
</div>
112120

113121
## Web UI (FastAPI)
@@ -128,6 +136,7 @@ Then open [http://localhost:8000](http://localhost:8000) in your browser.
128136
- **Markdown rendering in assistant responses**
129137
- Loading indicator while waiting for LLM
130138
- Error banner for API issues
139+
- **Tool configuration in settings panel with API key management**
131140

132141
For a comprehensive guide to using the web interface, see the [Web UI Guide](docs/web-ui-guide.md).
133142

docs/features.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,4 +222,27 @@ The system is designed to be easily extensible, allowing developers to create cu
222222
- Access real-time information for current events
223223
- Convert between units and currencies
224224
- Answer knowledge-based questions with factual data
225+
</div>
226+
227+
### API Key Management and Tool Configuration
228+
229+
<div style="padding: 20px; background: #f0fffc; border-radius: 8px; border-left: 4px solid #2EC4B6; margin-top: 20px;">
230+
The DeepSeek Wrapper provides an intuitive, user-friendly interface for managing API keys and configuring tools directly from the web UI. This feature allows users to enable, disable, and configure various AI tools without needing to edit configuration files manually.
231+
232+
Key features of the tool configuration system:
233+
- **Integrated settings panel**: Configure tools directly from the chat interface
234+
- **Toggle controls**: Easily enable or disable individual tools
235+
- **Secure API key storage**: API keys are saved in the server's `.env` file, not in browser storage
236+
- **Immediate activation**: Tools become available as soon as API keys are saved
237+
- **Environment variable integration**: Configuration automatically updates environment variables
238+
239+
The tool configuration panel is accessible from the settings menu and provides a complete overview of all available tools, their current status, and required API credentials. This makes it easy for users to manage which capabilities are available to the AI assistant.
240+
241+
**Configuration options include:**
242+
- Web Search API keys for accessing real-time information
243+
- Weather API credentials for forecasts and current conditions
244+
- Email SMTP server settings for sending messages
245+
- Toggle controls for built-in tools that don't require API keys
246+
247+
This user-friendly approach to tool configuration significantly improves the accessibility of advanced features, allowing non-technical users to fully utilize the AI's capabilities without developer assistance.
225248
</div>

docs/web-ui-guide.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,57 @@ Focus on writing efficient, readable code following best practices.
138138
Include error handling in your examples when appropriate.
139139
```
140140

141+
### Tool Configuration and API Keys
142+
143+
The DeepSeek Wrapper includes several AI tools that can be configured through the settings panel:
144+
145+
1. Click the settings icon in the top right corner
146+
2. Switch to the "Tools" tab
147+
3. Configure the available tools:
148+
- Enable or disable specific tools using the toggle switches
149+
- Enter API keys for tools that require external services
150+
- Configure additional settings for each tool (e.g., SMTP server for email)
151+
152+
![Tools Configuration](images/tools-config.png)
153+
154+
#### Available Tools
155+
156+
| Tool | Description | API Key Required |
157+
|------|-------------|------------------|
158+
| Web Search | Search the web for real-time information | Yes (WEBSEARCH_API_KEY) |
159+
| Weather | Get current weather and forecasts | Yes (WEATHER_API_KEY) |
160+
| Email | Compose and send emails | Yes (SMTP credentials) |
161+
| Calculator | Perform calculations | No |
162+
| Date & Time | Get current date and time information | No |
163+
164+
#### API Key Management
165+
166+
When you enter API keys in the tools configuration panel:
167+
168+
1. The keys are saved securely in your local `.env` file
169+
2. Tools are automatically registered with the appropriate API keys
170+
3. The AI can immediately use the configured tools in your conversations
171+
172+
This approach provides several benefits:
173+
- API keys are stored securely on your server, not in the browser
174+
- Configuration is persistent across server restarts
175+
- No need to manually edit configuration files
176+
- Tools can be easily enabled or disabled as needed
177+
178+
> **Note**: The API keys are stored in plaintext in your `.env` file. Ensure this file has appropriate permissions and is included in your `.gitignore` to prevent accidental exposure.
179+
180+
#### Using Tools in Conversations
181+
182+
Once tools are configured, you can use them in your conversations by asking questions that require their functionality:
183+
184+
- "What's the weather in Tokyo today?" (Weather tool)
185+
- "Search the web for the latest AI research papers" (Web Search tool)
186+
- "Help me draft an email to schedule a meeting" (Email tool)
187+
- "What is the square root of 144?" (Calculator tool)
188+
- "What's today's date?" (Date & Time tool)
189+
190+
The AI will automatically use the appropriate tool when needed to answer your questions.
191+
141192
### Conversation Management
142193

143194
- **Starting a new conversation**: Click the "New Chat" button

0 commit comments

Comments
 (0)