Skip to content

Commit 00edf42

Browse files
author
LittleCoinCoin
committed
docs(kiro): add Kiro to supported MCP hosts across all documentation
Complete documentation update to include Kiro IDE as supported MCP host platform: - README.md: Add Kiro to introduction, key features, and supported hosts section - MCPHostConfiguration.md: Add Kiro to supported platforms and validation lists - CLIReference.md: Add Kiro-specific CLI arguments and usage examples - Tutorial series: Add Kiro to all host platform references for consistency Ensures complete documentation consistency across user journey from project introduction through advanced tutorials and CLI reference. All host lists now include Kiro in alphabetical order with consistent description: 'Kiro IDE with MCP support'
1 parent 09776d2 commit 00edf42

File tree

6 files changed

+44
-261
lines changed

6 files changed

+44
-261
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
## Introduction
66

7-
Hatch is the package manager for managing Model Context Protocol (MCP) servers with environment isolation, multi-type dependency resolution, and multi-host deployment. Deploy MCP servers to Claude Desktop, VS Code, Cursor, and other platforms with automatic dependency management.
7+
Hatch is the package manager for managing Model Context Protocol (MCP) servers with environment isolation, multi-type dependency resolution, and multi-host deployment. Deploy MCP servers to Claude Desktop, VS Code, Cursor, Kiro, and other platforms with automatic dependency management.
88

99
The canonical documentation is at `docs/index.md` and published at <https://hatch.readthedocs.io/en/latest/>.
1010

1111
## Key Features
1212

1313
- **Environment Isolation** — Create separate, isolated workspaces for different projects without conflicts
1414
- **Multi-Type Dependency Resolution** — Automatically resolve and install system packages, Python packages, Docker containers, and Hatch packages
15-
- **Multi-Host Deployment** — Deploy MCP servers to Claude Desktop, Claude Code, VS Code, Cursor, LM Studio, and Google Gemini CLI
15+
- **Multi-Host Deployment** — Deploy MCP servers to Claude Desktop, Claude Code, VS Code, Cursor, Kiro, LM Studio, and Google Gemini CLI
1616
- **Package Validation** — Ensure packages meet schema requirements before distribution
1717
- **Development-Focused** — Optimized for rapid development and testing of MCP server ecosystems
1818

@@ -24,6 +24,7 @@ Hatch supports deployment to the following MCP host platforms:
2424
- **Claude Code** — Claude integration for VS Code with MCP capabilities
2525
- **VS Code** — Visual Studio Code with the MCP extension for tool integration
2626
- **Cursor** — AI-first code editor with built-in MCP server support
27+
- **Kiro** — Kiro IDE with MCP support
2728
- **LM Studio** — Local LLM inference platform with MCP server integration
2829
- **Google Gemini CLI** — Command-line interface for Google's Gemini model with MCP support
2930

docs/articles/users/CLIReference.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,9 @@ Syntax:
412412
| `--exclude-tools` | multiple | Tool blocklist - these tools will be excluded (Gemini). Space-separated values. | none |
413413
| `--env-file` | string | Path to environment file (Cursor, VS Code, LM Studio) | none |
414414
| `--input` | multiple | Input variable definitions format: type,id,description[,password=true] (VS Code) | none |
415+
| `--disabled` | flag | Disable the MCP server (Kiro) | false |
416+
| `--auto-approve-tools` | multiple | Tool names to auto-approve (Kiro). Can be used multiple times. | none |
417+
| `--disable-tools` | multiple | Tool names to disable (Kiro). Can be used multiple times. | none |
415418
| `--dry-run` | flag | Preview configuration without applying changes | false |
416419
| `--auto-approve` | flag | Skip confirmation prompts | false |
417420
| `--no-backup` | flag | Skip backup creation before configuration | false |
@@ -475,6 +478,37 @@ Configure MCP server 'my-server' on host 'gemini'? [y/N]: y
475478
[SUCCESS] Successfully configured MCP server 'my-server' on host 'gemini'
476479
```
477480

481+
**Example - Kiro Configuration**:
482+
483+
```bash
484+
$ hatch mcp configure my-server --host kiro --command python --args server.py --auto-approve-tools weather,calculator --disable-tools debug
485+
486+
Server 'my-server' created for host 'kiro':
487+
name: UPDATED None --> 'my-server'
488+
command: UPDATED None --> 'python'
489+
args: UPDATED None --> ['server.py']
490+
autoApprove: UPDATED None --> ['weather', 'calculator']
491+
disabledTools: UPDATED None --> ['debug']
492+
493+
Configure MCP server 'my-server' on host 'kiro'? [y/N]: y
494+
[SUCCESS] Successfully configured MCP server 'my-server' on host 'kiro'
495+
```
496+
497+
**Example - Kiro with Disabled Server**:
498+
499+
```bash
500+
$ hatch mcp configure my-server --host kiro --command python --args server.py --disabled
501+
502+
Server 'my-server' created for host 'kiro':
503+
name: UPDATED None --> 'my-server'
504+
command: UPDATED None --> 'python'
505+
args: UPDATED None --> ['server.py']
506+
disabled: UPDATED None --> True
507+
508+
Configure MCP server 'my-server' on host 'kiro'? [y/N]: y
509+
[SUCCESS] Successfully configured MCP server 'my-server' on host 'kiro'
510+
```
511+
478512
**Example - Remote Server Configuration**:
479513

480514
```bash

docs/articles/users/MCPHostConfiguration.md

Lines changed: 3 additions & 256 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Hatch currently supports configuration for these MCP host platforms:
1919
- **Claude Code** - Anthropic's VS Code extension
2020
- **VS Code** - Microsoft Visual Studio Code with MCP extensions
2121
- **Cursor** - AI-powered code editor
22+
- **Kiro** - Kiro IDE with MCP support
2223
- **LM Studio** - Local language model interface
2324
- **Gemini** - Google's AI development environment
2425

@@ -184,7 +185,7 @@ hatch mcp configure my-server --host claude-desktop --command python --args serv
184185
hatch mcp configure my-server --host claude-desktop --command python --args server.py --no-backup
185186
```
186187

187-
### Manual Backup Management
188+
### Restore From Backups
188189

189190
```bash
190191
# List available backups
@@ -201,267 +202,13 @@ Backups are stored in `~/.hatch/mcp_host_config_backups/` with the naming patter
201202
mcp.json.<hostname>.<timestamp>
202203
```
203204

204-
## Troubleshooting
205-
206-
### Host Not Available
207-
208-
If a host is not detected:
209-
210-
```bash
211-
# Check which hosts are available
212-
hatch mcp hosts
213-
214-
# Get detailed host information
215-
hatch mcp hosts --verbose
216-
```
217-
218-
**Common solutions:**
219-
- Ensure the host application is installed
220-
- Check that configuration directories exist
221-
- Verify file permissions for configuration files
222-
223-
### Configuration Validation Errors
224-
225-
If server configuration is rejected:
226-
227-
```bash
228-
# Validate configuration before applying
229-
hatch mcp validate my-server \
230-
--host claude-desktop \
231-
--command python \
232-
--args server.py
233-
```
234-
235-
**Common issues:**
236-
- Claude hosts require absolute paths for commands
237-
- Some hosts don't support environment variables
238-
- URL format must include protocol (http:// or https://)
239-
240-
### Backup and Recovery Issues
241-
242-
If configuration changes fail:
243-
244-
```bash
245-
# Check backup status
246-
hatch mcp backup list --host claude-desktop
247-
248-
# Restore previous working configuration
249-
hatch mcp restore --host claude-desktop --latest
250-
```
251-
252-
### Permission Issues
253-
254-
If you encounter permission errors:
255-
256-
```bash
257-
# Check configuration file permissions
258-
ls -la ~/.config/Code/User/settings.json # VS Code example
259-
260-
# Fix permissions if needed
261-
chmod 644 ~/.config/Code/User/settings.json
262-
```
263-
264-
## Advanced Usage
265-
266-
### Batch Operations
267-
268-
Configure multiple servers efficiently:
269-
270-
```bash
271-
# Configure multiple servers from a configuration file
272-
hatch mcp configure --from-file servers.json --host claude-desktop
273-
274-
# Remove multiple servers
275-
hatch mcp remove server1,server2,server3 --host claude-desktop
276-
```
277-
278-
### Environment Integration
279-
280-
Integrate with Hatch environment management:
281-
282-
```bash
283-
# Configure servers for current environment
284-
hatch env use my-project
285-
hatch mcp sync --all-hosts
286-
287-
# Configure servers when switching environments
288-
hatch env use production
289-
hatch mcp sync --hosts claude-desktop,cursor
290-
```
291-
292-
### Automation and Scripting
293-
294-
Use Hatch MCP configuration in automation:
295-
296-
```bash
297-
# Non-interactive configuration
298-
hatch mcp configure my-server \
299-
--host claude-desktop \
300-
--command python \
301-
--args server.py \
302-
--auto-approve
303-
304-
# Check configuration status in scripts
305-
if hatch mcp list --host claude-desktop | grep -q "my-server"; then
306-
echo "Server is configured"
307-
fi
308-
```
309-
310-
## Best Practices
311-
312-
### Development Workflow
313-
314-
1. **Start with one host** - Configure and test on your primary development host first
315-
2. **Use absolute paths** - Especially for Claude hosts, use absolute paths to avoid issues
316-
3. **Test configurations** - Use `--dry-run` to preview changes before applying
317-
4. **Keep backups** - Don't use `--no-backup` unless you're certain about changes
318-
319-
### Production Considerations
320-
321-
1. **Environment synchronization** - Use `hatch mcp sync` to maintain consistency across hosts
322-
2. **Backup management** - Regularly clean up old backups to manage disk space
323-
3. **Configuration validation** - Validate configurations before deployment
324-
4. **Host availability** - Check host availability before attempting configuration
325-
326-
### Security Considerations
327-
328-
1. **Credential management** - Avoid storing sensitive credentials in configuration files
329-
2. **File permissions** - Ensure configuration files have appropriate permissions
330-
3. **Backup security** - Protect backup files containing configuration data
331-
4. **Network security** - Use HTTPS for remote server configurations
332-
333-
## Integration with Other Hatch Features
334-
335-
### Package Management
336-
337-
MCP host configuration integrates with Hatch package management:
338-
339-
```bash
340-
# Install package and configure MCP server
341-
hatch package add weather-toolkit
342-
hatch mcp sync --all-hosts # Sync package's MCP server to hosts
343-
```
344-
345-
### Environment Management
346-
347-
Configuration follows environment boundaries:
348-
349-
```bash
350-
# Different environments can have different MCP configurations
351-
hatch env create development
352-
hatch env use development
353-
hatch mcp configure dev-server --host claude-desktop --command python --args dev_server.py
354-
355-
hatch env create production
356-
hatch env use production
357-
hatch mcp configure prod-server --host claude-desktop --command python --args prod_server.py
358-
```
359-
360-
This ensures that MCP server configurations are isolated between different project environments, maintaining clean separation of development, testing, and production setups.
361-
362-
## Advanced Synchronization Patterns
363-
364-
### Pattern-Based Server Selection
365-
366-
Use regular expressions for flexible server selection during synchronization:
367-
368-
```bash
369-
# All API servers
370-
hatch mcp sync --from-env my_hatch_env --to-host claude-desktop --pattern ".*api.*"
371-
372-
# Development tools
373-
hatch mcp sync --from-env my_hatch_env --to-host cursor --pattern "^dev-"
374-
375-
# Production servers
376-
hatch mcp sync --from-host production-host --to-host staging-host --pattern ".*prod.*"
377-
```
378-
379-
### Multi-Host Batch Operations
380-
381-
Efficiently manage configurations across multiple host platforms:
382-
383-
```bash
384-
# Replicate configuration across all hosts
385-
hatch mcp sync --from-host claude-desktop --to-host all
386-
387-
# Selective multi-host deployment
388-
hatch mcp sync --from-env production --to-host claude-desktop,cursor,vscode
389-
390-
# Environment-specific multi-host sync
391-
hatch mcp sync --from-env development --to-host all --pattern "^dev-"
392-
```
393-
394-
### Complex Filtering Scenarios
395-
396-
Combine filtering options for precise control:
397-
398-
```bash
399-
# Multiple specific servers
400-
hatch mcp sync --from-env my_hatch_env --to-host all --servers api-server,db-server,cache-server
401-
402-
# Pattern-based with host filtering
403-
hatch mcp sync --from-host claude-desktop --to-host cursor --pattern ".*tool.*"
404-
```
405-
406-
## Management Operations
407-
408-
### Server Removal Workflows
409-
410-
Remove MCP servers from host configurations with safety features:
411-
412-
```bash
413-
# Remove from single host
414-
hatch mcp remove server <server_name> --host <host-name>
415-
416-
# Remove from multiple hosts
417-
hatch mcp remove server <server_name> --host <host1>,<host2>,<host3>
418-
419-
# Remove from all configured hosts
420-
hatch mcp remove server <server_name> --host all
421-
```
422-
423-
### Host Configuration Management
424-
425-
Complete host configuration removal and management:
426-
427-
```bash
428-
# Remove all MCP configuration for a host
429-
hatch mcp remove host <host-name>
430-
431-
# Remove with environment specification
432-
hatch mcp remove server <server_name> --host <host> --env-var <environment>
433-
```
434-
435-
### Safety and Backup Features
436-
437-
All management operations include comprehensive safety features:
438-
439-
**Automatic Backup Creation**:
440-
```bash
441-
# Backup created automatically
442-
hatch mcp remove server test-server --host claude-desktop
443-
# Output: Backup created: ~/.hatch/mcp_backups/claude-desktop_20231201_143022.json
444-
```
445-
446-
**Dry-Run Mode**:
447-
```bash
448-
# Preview changes without executing
449-
hatch mcp remove server test-server --host claude-desktop --dry-run
450-
hatch mcp sync --from-env prod --to-host all --dry-run
451-
```
452-
453-
**Skip Backup (Advanced)**:
454-
```bash
455-
# Skip backup creation (use with caution)
456-
hatch mcp remove server test-server --host claude-desktop --no-backup
457-
```
458-
459205
### Host Validation and Error Handling
460206

461207
The system validates host names against available MCP host types:
462208
- `claude-desktop`
463209
- `cursor`
464210
- `vscode`
211+
- `kiro`
465212
- `lmstudio`
466213
- `gemini`
467214
- Additional hosts as configured

docs/articles/users/tutorials/03-author-package/05-checkpoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@
1818

1919
You now have the fundamental skills to create, validate, and install Hatch packages.
2020

21-
**Continue to**: [Tutorial 04: MCP Host Configuration](../04-mcp-host-configuration/01-host-platform-overview.md) to learn how to deploy your packages to host platforms like Claude Desktop, VS Code, and Cursor with automatic dependency resolution.
21+
**Continue to**: [Tutorial 04: MCP Host Configuration](../04-mcp-host-configuration/01-host-platform-overview.md) to learn how to deploy your packages to host platforms like Claude Desktop, VS Code, Cursor, and Kiro with automatic dependency resolution.
2222

2323
For more advanced topics, explore the [CLI Reference](../../CLIReference.md) and [Security and Trust](../../SecurityAndTrust.md) guides.

docs/articles/users/tutorials/04-mcp-host-configuration/01-host-platform-overview.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
---
44
**Concepts covered:**
55

6-
- MCP host platforms (Claude Desktop, VS Code, Cursor, etc.)
6+
- MCP host platforms (Claude Desktop, VS Code, Cursor, Kiro, etc.)
77
- Hatch's role as package manager with host configuration features
88
- Host platform configuration files and formats
99
- Package-first vs. direct configuration approaches
@@ -53,6 +53,7 @@ Hatch currently supports configuration for these MCP host platforms:
5353
- [**Claude Code**](https://claude.com/product/claude-code) - Anthropic's AI Command Line Interface
5454
- [**Cursor**](https://cursor.com/) - AI-powered code editor
5555
- [**VS Code**](https://code.visualstudio.com/) - Microsoft Visual Studio Code
56+
- [**Kiro**](https://kiro.ai/) - Kiro IDE with MCP support
5657
- [**LM Studio**](https://lmstudio.ai/) - Local language model interface
5758
- [**Gemini**](https://github.com/google-gemini/gemini-cli) - Google's AI Command Line Interface
5859

docs/articles/users/tutorials/04-mcp-host-configuration/04-environment-synchronization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
---
1919

20-
This tutorial teaches you how to deploy MCP servers to multiple host platforms using environments as project isolation containers. You'll learn to maintain clean separation between different projects while efficiently deploying their servers to host applications like Claude Desktop, Cursor, and VS Code.
20+
This tutorial teaches you how to deploy MCP servers to multiple host platforms using environments as project isolation containers. You'll learn to maintain clean separation between different projects while efficiently deploying their servers to host applications like Claude Desktop, Cursor, Kiro, and VS Code.
2121

2222
## Understanding Project Isolation with Environments
2323

0 commit comments

Comments
 (0)