Skip to content

Commit 481f0de

Browse files
authored
feat: add comprehensive registry-based MCP management and internal tools documentation (#196)
* feat: enhance MCP command documentation with new registry features - Added new commands for `install`, `uninstall`, and `search` to the MCP CLI, enabling users to manage servers directly from the 1MCP registry. - Updated sidebar navigation in both English and Chinese documentation to include links for the new commands. - Enhanced the server management guide to reflect the registry-based approach, emphasizing installation and configuration best practices. - Introduced detailed documentation for each new command, including usage examples and options for installation and uninstallation. - Improved overall clarity and organization of the documentation to facilitate user understanding and accessibility. * feat: add internal tools documentation and sidebar updates - Introduced comprehensive documentation for MCP internal tools, including discovery, installation, and management tools. - Updated sidebar navigation in both English and Chinese to include new sections for internal tools, enhancing user accessibility. - Added detailed usage patterns, best practices, and tool interactions to facilitate understanding of internal tools for AI assistants. - Ensured consistency in documentation structure and clarity across all new content. * feat: add internal tools configuration options to documentation - Introduced new command-line options for enabling internal tools in MCP, including `--enable-internal-tools` and `--internal-tools`, with detailed descriptions and default values. - Updated documentation to include usage examples for enabling all internal tools or specific categories (discovery, installation, management, safe). - Enhanced both English and Chinese documentation to ensure consistency and clarity regarding internal tools functionality for AI assistants. * feat: add comprehensive English and Chinese documentation for 1MCP Agent - Introduced new documentation files for both English and Chinese, covering essential guides, CLI references, advanced configuration, and optional tools for the 1MCP Agent. - Enhanced user accessibility by providing structured documentation that includes installation, configuration, server management, and advanced deployment scenarios. - Ensured consistency across language versions to facilitate understanding for a broader audience. * feat: add AI automation section to documentation - Introduced a new section for AI automation tools in both English and Chinese documentation, detailing programmatic MCP server management capabilities. - Updated feature lists to include AI automation, enhancing user understanding of available tools for AI assistants. - Ensured consistency across language versions to improve accessibility and clarity for users. * feat: update MCP command documentation for clarity and consistency - Revised the `install`, `search`, and `uninstall` command documentation to enhance clarity and usability, including updated descriptions and examples. - Improved the interactive workflow section for the `install` command, streamlining the steps for user guidance. - Clarified the limitations of the `search` command as an alias for the `registry search`, emphasizing its basic functionality. - Enhanced the `uninstall` command options with clearer descriptions and default values for better user understanding. - Ensured consistency across English and Chinese documentation to improve accessibility for all users.
1 parent 275715d commit 481f0de

File tree

33 files changed

+5120
-101
lines changed

33 files changed

+5120
-101
lines changed

docs/.vitepress/config/en.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,9 @@ function sidebar(): DefaultTheme.Sidebar {
150150
text: 'mcp',
151151
link: '/commands/mcp/',
152152
items: [
153+
{ text: 'install', link: '/commands/mcp/install' },
154+
{ text: 'uninstall', link: '/commands/mcp/uninstall' },
155+
{ text: 'search', link: '/commands/mcp/search' },
153156
{ text: 'add', link: '/commands/mcp/add' },
154157
{ text: 'remove', link: '/commands/mcp/remove' },
155158
{ text: 'update', link: '/commands/mcp/update' },
@@ -159,6 +162,11 @@ function sidebar(): DefaultTheme.Sidebar {
159162
{ text: 'tokens', link: '/commands/mcp/tokens' },
160163
],
161164
},
165+
{
166+
text: 'registry',
167+
link: '/commands/registry/',
168+
items: [{ text: 'search', link: '/commands/registry/search' }],
169+
},
162170
{
163171
text: 'preset',
164172
link: '/commands/preset/',
@@ -208,6 +216,16 @@ function sidebar(): DefaultTheme.Sidebar {
208216
{ text: 'Pagination', link: '/reference/pagination' },
209217
],
210218
},
219+
{
220+
text: 'Internal Tools',
221+
link: '/reference/internal-tools/',
222+
items: [
223+
{ text: 'Overview', link: '/reference/internal-tools/' },
224+
{ text: 'Discovery Tools', link: '/reference/internal-tools/discovery' },
225+
{ text: 'Installation Tools', link: '/reference/internal-tools/installation' },
226+
{ text: 'Management Tools', link: '/reference/internal-tools/management' },
227+
],
228+
},
211229
{
212230
text: 'Configuration',
213231
items: [

docs/.vitepress/config/zh.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,9 @@ function sidebar(): DefaultTheme.Sidebar {
160160
text: 'mcp',
161161
link: '/zh/commands/mcp/',
162162
items: [
163+
{ text: 'install', link: '/zh/commands/mcp/install' },
164+
{ text: 'uninstall', link: '/zh/commands/mcp/uninstall' },
165+
{ text: 'search', link: '/zh/commands/mcp/search' },
163166
{ text: 'add', link: '/zh/commands/mcp/add' },
164167
{ text: 'remove', link: '/zh/commands/mcp/remove' },
165168
{ text: 'update', link: '/zh/commands/mcp/update' },
@@ -169,6 +172,11 @@ function sidebar(): DefaultTheme.Sidebar {
169172
{ text: 'tokens', link: '/zh/commands/mcp/tokens' },
170173
],
171174
},
175+
{
176+
text: 'registry',
177+
link: '/zh/commands/registry/',
178+
items: [{ text: 'search', link: '/zh/commands/registry/search' }],
179+
},
172180
{
173181
text: 'preset',
174182
link: '/zh/commands/preset/',
@@ -215,6 +223,16 @@ function sidebar(): DefaultTheme.Sidebar {
215223
text: 'API 参考',
216224
items: [{ text: '健康检查 API', link: '/zh/reference/health-check' }],
217225
},
226+
{
227+
text: '内部工具',
228+
link: '/zh/reference/internal-tools/',
229+
items: [
230+
{ text: '概述', link: '/zh/reference/internal-tools/' },
231+
{ text: '发现工具', link: '/zh/reference/internal-tools/discovery' },
232+
{ text: '安装工具', link: '/zh/reference/internal-tools/installation' },
233+
{ text: '管理工具', link: '/zh/reference/internal-tools/management' },
234+
],
235+
},
218236
{
219237
text: '配置',
220238
items: [

docs/en/commands/mcp/index.md

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,44 @@ head:
2020

2121
Manage MCP server configurations within your 1MCP instance.
2222

23-
These commands allow you to add, remove, update, and manage the lifecycle of the MCP servers that 1MCP will proxy.
23+
These commands allow you to discover, install, configure, and manage the lifecycle of MCP servers through both manual configuration and the 1MCP registry.
2424

25-
For a detailed guide on server management, including transport types and best practices, please see the **[Server Management Guide](../../guide/essentials/server-management)**.
25+
For a detailed guide on server management, including registry-based installation and best practices, please see the **[Server Management Guide](../../guide/essentials/server-management)**.
2626

27-
## Commands
27+
## Registry-Based Commands (Recommended)
28+
29+
### [install](./install)
30+
31+
Install MCP servers from the 1MCP registry with automatic dependency resolution and version management.
32+
33+
```bash
34+
npx -y @1mcp/agent mcp install filesystem
35+
npx -y @1mcp/agent mcp install --interactive
36+
```
37+
38+
### [uninstall](./uninstall)
39+
40+
Safely remove MCP servers with automatic backup creation and dependency validation.
41+
42+
```bash
43+
npx -y @1mcp/agent mcp uninstall filesystem
44+
npx -y @1mcp/agent mcp uninstall test-server --force
45+
```
46+
47+
### [search](./search)
48+
49+
Search the MCP registry for available servers.
50+
51+
```bash
52+
npx -y @1mcp/agent mcp search database
53+
npx -y @1mcp/agent mcp search --category=filesystem
54+
```
55+
56+
## Manual Configuration Commands
2857

2958
### [add](./add)
3059

31-
Add a new MCP server to the configuration.
60+
Manually add a new MCP server to the configuration.
3261

3362
```bash
3463
npx -y @1mcp/agent mcp add my-server --type=stdio --command="node server.js"
@@ -85,4 +114,5 @@ npx -y @1mcp/agent mcp tokens --model=gpt-3.5-turbo --format=summary
85114
## See Also
86115

87116
- **[Server Management Guide](../../guide/essentials/server-management)**
117+
- **[Registry Commands](../registry/)** - Server discovery and installation
88118
- **[App Consolidation Guide](../../guide/integrations/app-consolidation)**

docs/en/commands/mcp/install.md

Lines changed: 227 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,227 @@
1+
---
2+
title: mcp install
3+
description: Install MCP servers from the 1MCP registry
4+
head:
5+
- [
6+
'meta',
7+
{
8+
name: 'keywords',
9+
content: 'MCP install,registry server installation,interactive installation,server discovery',
10+
},
11+
]
12+
- ['meta', { property: 'og:title', content: '1MCP Install Command - Registry Server Installation' }]
13+
- [
14+
'meta',
15+
{
16+
property: 'og:description',
17+
content: 'Install MCP servers from the registry with interactive installation and version management.',
18+
},
19+
]
20+
---
21+
22+
# mcp install
23+
24+
Install MCP servers from the 1MCP registry with automatic dependency resolution and version management. The install command provides both interactive installation and direct server installation by name.
25+
26+
> **Note**: This is the recommended way to add MCP servers to your configuration. For manual configuration, see the [add command](add.md).
27+
28+
## Synopsis
29+
30+
Launch interactive installation wizard:
31+
32+
```bash
33+
npx -y @1mcp/agent mcp install
34+
```
35+
36+
Install a server by name from the registry:
37+
38+
```bash
39+
npx -y @1mcp/agent mcp install <server-name>
40+
```
41+
42+
Install with specific version:
43+
44+
```bash
45+
npx -y @1mcp/agent mcp install <server-name>@<version>
46+
```
47+
48+
Preview installation without making changes:
49+
50+
```bash
51+
npx -y @1mcp/agent mcp install <server-name> --dry-run
52+
```
53+
54+
Force reinstallation:
55+
56+
```bash
57+
npx -y @1mcp/agent mcp install <server-name> --force
58+
```
59+
60+
## Arguments
61+
62+
- **`<server-name>`** (optional)
63+
- Server name or name@version to install. Can include full registry ID (e.g., `io.github.user/filesystem`).
64+
- **Required**: No
65+
66+
## Global Options
67+
68+
This command supports all global options:
69+
70+
- **`--config, -c <path>`** - Specify configuration file path
71+
- **`--config-dir, -d <path>`** - Path to the config directory
72+
73+
## Command-Specific Options
74+
75+
- **`--interactive, -i`**
76+
- Launch interactive installation wizard. This is the default when no server name is provided.
77+
78+
- **`--force`**
79+
- Force installation even if the server already exists. Overwrites existing configuration.
80+
81+
- **`--dry-run`**
82+
- Show what would be installed without making any changes to your configuration.
83+
84+
- **`--verbose, -v`**
85+
- Display detailed installation information.
86+
87+
## Examples
88+
89+
### Basic Server Installation
90+
91+
Install the latest version of the filesystem server:
92+
93+
```bash
94+
npx -y @1mcp/agent mcp install filesystem
95+
```
96+
97+
Install a specific version:
98+
99+
```bash
100+
npx -y @1mcp/agent mcp install [email protected]
101+
```
102+
103+
### Interactive Installation
104+
105+
Launch the interactive installation wizard to browse and install servers:
106+
107+
```bash
108+
npx -y @1mcp/agent mcp install
109+
```
110+
111+
Or explicitly request interactive mode:
112+
113+
```bash
114+
npx -y @1mcp/agent mcp install --interactive
115+
```
116+
117+
The interactive mode will guide you through:
118+
119+
1. **Server Discovery** - Browse available servers by category
120+
2. **Version Selection** - Choose compatible versions
121+
3. **Configuration** - Set server-specific options
122+
4. **Installation** - Confirm and install with dependencies
123+
124+
### Installation Preview
125+
126+
Preview what would be installed without making changes:
127+
128+
```bash
129+
npx -y @1mcp/agent mcp install filesystem --dry-run
130+
131+
# Output:
132+
# 📦 Installation Preview: filesystem@latest
133+
# Server: filesystem - File system access and management
134+
# Use without --dry-run to perform actual installation
135+
```
136+
137+
### Force Reinstallation
138+
139+
Replace an existing server configuration:
140+
141+
```bash
142+
npx -y @1mcp/agent mcp install filesystem --force
143+
```
144+
145+
### Verbose Installation
146+
147+
See detailed installation process including dependency resolution:
148+
149+
```bash
150+
npx -y @1mcp/agent mcp install airtable --verbose
151+
152+
# Output:
153+
# 🔍 Resolving dependencies for [email protected]...
154+
# ✓ Dependency check complete
155+
# 📥 Downloading server metadata...
156+
# ✓ Validating server configuration
157+
# ⚙️ Generating configuration...
158+
# ✓ Server installed successfully as 'airtable'
159+
```
160+
161+
## Interactive Workflow
162+
163+
When using `--interactive` or running without arguments, the install command launches a guided wizard that helps you:
164+
165+
1. **Search** for servers by name or browse categories
166+
2. **Select** a server and review its capabilities
167+
3. **Choose** a version (stable vs latest)
168+
4. **Configure** server-specific parameters
169+
5. **Confirm** installation
170+
171+
## Registry Features
172+
173+
- **Server Discovery**: Search and browse available MCP servers
174+
- **Version Management**: Install specific versions with compatibility checking
175+
- **Dependency Resolution**: Automatically handle required dependencies
176+
- **Security Validation**: Verify server integrity and authenticity
177+
178+
## Configuration Output
179+
180+
Installed servers are added to your `mcp.json` configuration with registry metadata:
181+
182+
```json
183+
{
184+
"mcpServers": {
185+
"filesystem": {
186+
"command": "npx",
187+
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/home/user"],
188+
"tags": ["filesystem", "files", "local"],
189+
"_registry": {
190+
"name": "filesystem",
191+
"version": "1.2.0",
192+
"installedAt": "2024-01-15T10:30:00Z",
193+
"source": "1mcp-registry"
194+
}
195+
}
196+
}
197+
}
198+
```
199+
200+
## Error Handling
201+
202+
The install command provides helpful error messages for common scenarios:
203+
204+
```bash
205+
# Server not found
206+
npx -y @1mcp/agent mcp install nonexistent-server
207+
# Error: Server 'nonexistent-server' not found in registry
208+
# Suggestions: filesystem, git, database, search
209+
210+
# Version not available
211+
npx -y @1mcp/agent mcp install [email protected]
212+
# Error: Version 99.99.99 not available for 'filesystem'
213+
# Available versions: 1.2.0, 1.1.0, 1.0.0
214+
215+
# Already installed
216+
npx -y @1mcp/agent mcp install filesystem
217+
# Error: Server 'filesystem' already installed
218+
# Use --force to reinstall or mcp update to upgrade
219+
```
220+
221+
## See Also
222+
223+
- **[Registry Search](../registry/search.md)** - Search the registry for available servers
224+
- **[mcp uninstall](uninstall.md)** - Remove installed servers
225+
- **[mcp update](update.md)** - Update installed servers
226+
- **[Server Management Guide](../../guide/essentials/server-management.md)** - Complete server management overview
227+
- **[Registry Commands](../registry/)** - Full registry command documentation

0 commit comments

Comments
 (0)