Skip to content

Commit ddc3fdd

Browse files
Update mcp/mcp-overview.mdx
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 5069753 commit ddc3fdd

File tree

1 file changed

+87
-149
lines changed

1 file changed

+87
-149
lines changed

mcp/mcp-overview.mdx

Lines changed: 87 additions & 149 deletions
Original file line numberDiff line numberDiff line change
@@ -124,198 +124,136 @@ Get organized:
124124
- **Notion**: Take notes and organize
125125
- **Custom Tools**: Your own productivity apps
126126

127-
## Server Management
127+
## Managing Connections
128128

129-
<AccordionGroup>
130-
<Accordion title="Adding Servers" icon="plus">
131-
### Manual Server Configuration
129+
### Adding New Services
132130

133-
Add custom MCP servers with full configuration control:
131+
Add your own custom connections:
134132

135-
- **Server Types**: STDIO, SSE, or HTTP connections
136-
- **Authentication**: API keys, tokens, and custom headers
137-
- **Environment Variables**: Runtime configuration
138-
- **Connection Testing**: Verify configuration before saving
133+
- Choose connection type (STDIO, SSE, or HTTP)
134+
- Enter your API keys or tokens
135+
- Set up any special settings
136+
- Test it before saving
139137

140-
</Accordion>
138+
### Checking Status
141139

142-
<Accordion title="Server Monitoring" icon="activity">
143-
### Connection Health
140+
See how your connections are doing:
144141

145-
Monitor the status of all connected servers:
142+
- Check if they're connected
143+
- See how many tools are available
144+
- Get alerts if something's wrong
145+
- Automatic reconnection if disconnected
146146

147-
- **Connection Status**: Real-time availability checking
148-
- **Tool Count**: Number of available tools per server
149-
- **Error Reporting**: Connection and authentication issues
150-
- **Auto-Reconnection**: Automatic retry on connection loss
147+
### Editing Connections
151148

152-
</Accordion>
149+
Manage your existing connections:
153150

154-
<Accordion title="Server Maintenance" icon="settings">
155-
### Configuration Management
151+
- Update login info
152+
- Delete ones you don't use
153+
- Manage multiple at once
154+
- Save and restore settings
156155

157-
Manage existing server configurations:
156+
## Using Tools
158157

159-
- **Edit Settings**: Update credentials and configuration
160-
- **Delete Servers**: Remove unused integrations
161-
- **Bulk Operations**: Manage multiple servers simultaneously
162-
- **Export/Import**: Backup and restore configurations
158+
### Finding Tools
163159

164-
</Accordion>
165-
</AccordionGroup>
160+
Look through available actions:
166161

167-
## Tool Execution Workflow
162+
- See all available tools
163+
- Search by name or type
164+
- See what info each tool needs
165+
- Read instructions for each tool
168166

169-
<AccordionGroup>
170-
<Accordion title="Tool Discovery" icon="search">
171-
### Finding Available Tools
167+
### Running Tools Safely
172168

173-
Browse and search through all available tools:
169+
Execute tools with safety checks:
174170

175-
- **Tool Registry**: Complete catalog of available operations
176-
- **Search & Filter**: Find tools by name, server, or category
177-
- **Parameter Preview**: View required and optional parameters
178-
- **Documentation**: Access tool descriptions and usage examples
171+
- Review before running
172+
- Check that inputs are correct
173+
- Auto-cancel after 30 seconds
174+
- Trust certain tools to run automatically
179175

180-
</Accordion>
176+
### Tracking Usage
181177

182-
<Accordion title="Approval Process" icon="check-circle">
183-
### Secure Tool Execution
178+
See what you've done:
184179

185-
Execute tools with built-in security controls:
180+
- History of all actions
181+
- How long things took
182+
- Errors and problems
183+
- Most-used tools
186184

187-
- **Approval Interface**: Review tool calls before execution
188-
- **Parameter Validation**: Ensure correct input values
189-
- **Timeout Protection**: Automatic denial after 30 seconds
190-
- **Trusted Tools**: Pre-approve frequently used operations
191-
192-
</Accordion>
193-
194-
<Accordion title="Execution Monitoring" icon="eye">
195-
### Track Tool Usage
196-
197-
Monitor and analyze tool execution patterns:
198-
199-
- **Execution History**: Complete log of all tool calls
200-
- **Performance Metrics**: Execution time and success rates
201-
- **Error Analysis**: Failed executions and error details
202-
- **Usage Statistics**: Most frequently used tools
203-
204-
</Accordion>
205-
</AccordionGroup>
206-
207-
## Advanced Features
208-
209-
<BadgeGroup>
210-
<Badge variant="secondary">Auto-Approval</Badge>
211-
<Badge variant="secondary">Bulk Operations</Badge>
212-
<Badge variant="secondary">Export/Import</Badge>
213-
<Badge variant="secondary">Real-time Monitoring</Badge>
214-
</BadgeGroup>
215-
216-
### Advanced Capabilities
217-
218-
- **Auto-Approval**: Pre-approve trusted tools for instant execution
219-
- **Bulk Operations**: Manage multiple servers and tools simultaneously
220-
- **Data Export**: Export execution history and configurations
221-
- **Real-time Updates**: Live status monitoring and notifications
222-
223-
## Best Practices
185+
## Tips for Success
224186

225187
<Callout type="info">
226-
**Security First**: Always review tool parameters before approval, especially for operations that modify data or
227-
execute commands.
188+
**Safety First**: Always check what a tool will do before approving it, especially if it changes data.
228189
</Callout>
229190

230191
<Callout type="tip">
231-
**Start Small**: Begin with marketplace templates for popular services, then add custom integrations as needed.
192+
**Start Simple**: Use ready-made connections first, then add custom ones later.
232193
</Callout>
233194

234195
<Callout type="warning">
235-
**Credential Management**: Store API keys and tokens securely. MCP configurations are stored locally and never
236-
transmitted to external servers.
196+
**Keep Secrets Safe**: Store API keys securely. MCP keeps everything on your computer and doesn't send it anywhere.
237197
</Callout>
238198

239-
## Troubleshooting
240-
241-
<AccordionGroup>
242-
<Accordion title="Connection Issues" icon="wifi-off">
243-
### Server Connection Problems
244-
245-
Common connection issues and solutions:
246-
247-
- **Network Errors**: Check internet connectivity and firewall settings
248-
- **Authentication Failures**: Verify API keys and credentials
249-
- **Server Unavailable**: Check service status and retry later
250-
- **Configuration Errors**: Validate server URLs and parameters
251-
252-
</Accordion>
253-
254-
<Accordion title="Tool Execution" icon="alert-triangle">
255-
### Tool Execution Problems
256-
257-
Issues with tool execution and approval:
199+
## Fixing Problems
258200

259-
- **Approval Timeouts**: Tools auto-deny after 30 seconds
260-
- **Parameter Errors**: Check required field validation
261-
- **Permission Issues**: Verify API permissions and scopes
262-
- **Rate Limiting**: Respect API rate limits and retry logic
201+
### Can't Connect
263202

264-
</Accordion>
203+
Common connection problems:
265204

266-
<Accordion title="Performance" icon="gauge">
267-
### Performance Optimization
205+
- **No internet**: Check your internet and firewall
206+
- **Wrong password**: Check your API keys
207+
- **Service down**: Check if the service is working
208+
- **Wrong settings**: Double-check your URLs and settings
268209

269-
Improve MCP system performance:
210+
### Tools Won't Run
270211

271-
- **Connection Pooling**: Reuse connections for better performance
272-
- **Caching**: Cache frequently accessed data
273-
- **Batch Operations**: Group multiple operations when possible
274-
- **Monitoring**: Track performance metrics and bottlenecks
212+
Problems running tools:
275213

276-
</Accordion>
277-
</AccordionGroup>
214+
- **Timeout**: Tools cancel after 30 seconds
215+
- **Wrong info**: Check required fields
216+
- **No permission**: Make sure your API key has permission
217+
- **Too many requests**: Wait a bit and try again
278218

279-
## Integration Examples
219+
### Running Slow
280220

281-
<AccordionGroup>
282-
<Accordion title="Database Integration" icon="database">
283-
### Connecting to Supabase
221+
Make things faster:
284222

285-
```typescript
286-
// Example: Query user data from Supabase
287-
const users = await mcp.executeTool('supabase', 'query_users', {
288-
table: 'users',
289-
filter: { status: 'active' }
290-
});
291-
```
223+
- Reuse connections
224+
- Save frequently-used data
225+
- Do multiple things at once when possible
226+
- Watch for slow spots
292227

293-
</Accordion>
228+
## Examples
294229

295-
<Accordion title="Payment Processing" icon="credit-card">
296-
### Stripe Integration
230+
### Database Example
297231

298-
```typescript
299-
// Example: Process a payment
300-
const payment = await mcp.executeTool('stripe', 'create_payment_intent', {
301-
amount: 1000,
302-
currency: 'usd',
303-
customer_id: 'cus_123'
304-
});
305-
```
232+
```typescript
233+
// Get user data from Supabase
234+
const users = await mcp.executeTool('supabase', 'query_users', {
235+
table: 'users',
236+
filter: { status: 'active' }
237+
});
238+
```
306239

307-
</Accordion>
240+
### Payment Example
308241

309-
<Accordion title="AI Integration" icon="sparkle">
310-
### Claude Code Integration
242+
```typescript
243+
// Process a payment with Stripe
244+
const payment = await mcp.executeTool('stripe', 'create_payment_intent', {
245+
amount: 1000,
246+
currency: 'usd',
247+
customer_id: 'cus_123'
248+
});
249+
```
311250

312-
```typescript
313-
// Example: Generate code with AI
314-
const code = await mcp.executeTool('claude-code', 'generate_component', {
315-
component_type: 'React',
316-
description: 'User profile form'
317-
});
318-
```
251+
### AI Example
319252

320-
</Accordion>
321-
</AccordionGroup>
253+
```typescript
254+
// Generate code with AI
255+
const code = await mcp.executeTool('claude-code', 'generate_component', {
256+
component_type: 'React',
257+
description: 'User profile form'
258+
});
259+
```

0 commit comments

Comments
 (0)