Spaces:
Running
Running
Adam Conway commited on
Update --name flag (#1239)
Browse files
docs/integrations/claude-code.mdx
CHANGED
|
@@ -114,7 +114,7 @@ fastmcp install claude-code server.py --project /path/to/my-project
|
|
| 114 |
If your server needs environment variables (like API keys), you must include them:
|
| 115 |
|
| 116 |
```bash
|
| 117 |
-
fastmcp install claude-code server.py --name "Weather Server" \
|
| 118 |
--env API_KEY=your-api-key \
|
| 119 |
--env DEBUG=true
|
| 120 |
```
|
|
@@ -122,7 +122,7 @@ fastmcp install claude-code server.py --name "Weather Server" \
|
|
| 122 |
Or load them from a `.env` file:
|
| 123 |
|
| 124 |
```bash
|
| 125 |
-
fastmcp install claude-code server.py --name "Weather Server" --env-file .env
|
| 126 |
```
|
| 127 |
|
| 128 |
<Warning>
|
|
|
|
| 114 |
If your server needs environment variables (like API keys), you must include them:
|
| 115 |
|
| 116 |
```bash
|
| 117 |
+
fastmcp install claude-code server.py --server-name "Weather Server" \
|
| 118 |
--env API_KEY=your-api-key \
|
| 119 |
--env DEBUG=true
|
| 120 |
```
|
|
|
|
| 122 |
Or load them from a `.env` file:
|
| 123 |
|
| 124 |
```bash
|
| 125 |
+
fastmcp install claude-code server.py --server-name "Weather Server" --env-file .env
|
| 126 |
```
|
| 127 |
|
| 128 |
<Warning>
|
docs/integrations/claude-desktop.mdx
CHANGED
|
@@ -136,7 +136,7 @@ Claude Desktop runs servers in a completely isolated environment with no access
|
|
| 136 |
If your server needs environment variables (like API keys), you must include them:
|
| 137 |
|
| 138 |
```bash
|
| 139 |
-
fastmcp install claude-desktop server.py --name "Weather Server" \
|
| 140 |
--env API_KEY=your-api-key \
|
| 141 |
--env DEBUG=true
|
| 142 |
```
|
|
@@ -144,7 +144,7 @@ fastmcp install claude-desktop server.py --name "Weather Server" \
|
|
| 144 |
Or load them from a `.env` file:
|
| 145 |
|
| 146 |
```bash
|
| 147 |
-
fastmcp install claude-desktop server.py --name "Weather Server" --env-file .env
|
| 148 |
```
|
| 149 |
<Warning>
|
| 150 |
- **`uv` must be installed and available in your system PATH**. Claude Desktop runs in its own isolated environment and needs `uv` to manage dependencies.
|
|
|
|
| 136 |
If your server needs environment variables (like API keys), you must include them:
|
| 137 |
|
| 138 |
```bash
|
| 139 |
+
fastmcp install claude-desktop server.py --server-name "Weather Server" \
|
| 140 |
--env API_KEY=your-api-key \
|
| 141 |
--env DEBUG=true
|
| 142 |
```
|
|
|
|
| 144 |
Or load them from a `.env` file:
|
| 145 |
|
| 146 |
```bash
|
| 147 |
+
fastmcp install claude-desktop server.py --server-name "Weather Server" --env-file .env
|
| 148 |
```
|
| 149 |
<Warning>
|
| 150 |
- **`uv` must be installed and available in your system PATH**. Claude Desktop runs in its own isolated environment and needs `uv` to manage dependencies.
|
docs/integrations/cursor.mdx
CHANGED
|
@@ -120,7 +120,7 @@ Cursor runs servers in a completely isolated environment with no access to your
|
|
| 120 |
If your server needs environment variables (like API keys), you must include them:
|
| 121 |
|
| 122 |
```bash
|
| 123 |
-
fastmcp install cursor server.py --name "Weather Server" \
|
| 124 |
--env API_KEY=your-api-key \
|
| 125 |
--env DEBUG=true
|
| 126 |
```
|
|
@@ -128,7 +128,7 @@ fastmcp install cursor server.py --name "Weather Server" \
|
|
| 128 |
Or load them from a `.env` file:
|
| 129 |
|
| 130 |
```bash
|
| 131 |
-
fastmcp install cursor server.py --name "Weather Server" --env-file .env
|
| 132 |
```
|
| 133 |
|
| 134 |
<Warning>
|
|
@@ -145,10 +145,10 @@ You can generate MCP JSON configuration for manual use:
|
|
| 145 |
|
| 146 |
```bash
|
| 147 |
# Generate configuration and output to stdout
|
| 148 |
-
fastmcp install mcp-json server.py --name "Dice Roller" --with pandas
|
| 149 |
|
| 150 |
# Copy configuration to clipboard for easy pasting
|
| 151 |
-
fastmcp install mcp-json server.py --name "Dice Roller" --copy
|
| 152 |
```
|
| 153 |
|
| 154 |
This generates the standard `mcpServers` configuration format that can be used with any MCP-compatible client.
|
|
|
|
| 120 |
If your server needs environment variables (like API keys), you must include them:
|
| 121 |
|
| 122 |
```bash
|
| 123 |
+
fastmcp install cursor server.py --server-name "Weather Server" \
|
| 124 |
--env API_KEY=your-api-key \
|
| 125 |
--env DEBUG=true
|
| 126 |
```
|
|
|
|
| 128 |
Or load them from a `.env` file:
|
| 129 |
|
| 130 |
```bash
|
| 131 |
+
fastmcp install cursor server.py --server-name "Weather Server" --env-file .env
|
| 132 |
```
|
| 133 |
|
| 134 |
<Warning>
|
|
|
|
| 145 |
|
| 146 |
```bash
|
| 147 |
# Generate configuration and output to stdout
|
| 148 |
+
fastmcp install mcp-json server.py --server-name "Dice Roller" --with pandas
|
| 149 |
|
| 150 |
# Copy configuration to clipboard for easy pasting
|
| 151 |
+
fastmcp install mcp-json server.py --server-name "Dice Roller" --copy
|
| 152 |
```
|
| 153 |
|
| 154 |
This generates the standard `mcpServers` configuration format that can be used with any MCP-compatible client.
|
docs/patterns/cli.mdx
CHANGED
|
@@ -253,7 +253,7 @@ The `install` command supports the same `file.py:object` notation as the `run` c
|
|
| 253 |
|
| 254 |
| Option | Flag | Description |
|
| 255 |
| ------ | ---- | ----------- |
|
| 256 |
-
| Server Name | `--name`, `-n` | Custom name for the server (defaults to server's name attribute or file name) |
|
| 257 |
| Editable Package | `--with-editable`, `-e` | Directory containing pyproject.toml to install in editable mode |
|
| 258 |
| Additional Packages | `--with` | Additional packages to install (can be used multiple times) |
|
| 259 |
| Environment Variables | `--env` | Environment variables in KEY=VALUE format (can be used multiple times) |
|
|
@@ -272,7 +272,7 @@ fastmcp install claude-desktop server.py
|
|
| 272 |
fastmcp install claude-desktop server.py:my_server
|
| 273 |
|
| 274 |
# With custom name and dependencies
|
| 275 |
-
fastmcp install claude-desktop server.py:my_server --name "My Analysis Server" --with pandas
|
| 276 |
|
| 277 |
# Install in Claude Code with environment variables
|
| 278 |
fastmcp install claude-code server.py --env API_KEY=secret --env DEBUG=true
|
|
|
|
| 253 |
|
| 254 |
| Option | Flag | Description |
|
| 255 |
| ------ | ---- | ----------- |
|
| 256 |
+
| Server Name | `--server-name`, `-n` | Custom name for the server (defaults to server's name attribute or file name) |
|
| 257 |
| Editable Package | `--with-editable`, `-e` | Directory containing pyproject.toml to install in editable mode |
|
| 258 |
| Additional Packages | `--with` | Additional packages to install (can be used multiple times) |
|
| 259 |
| Environment Variables | `--env` | Environment variables in KEY=VALUE format (can be used multiple times) |
|
|
|
|
| 272 |
fastmcp install claude-desktop server.py:my_server
|
| 273 |
|
| 274 |
# With custom name and dependencies
|
| 275 |
+
fastmcp install claude-desktop server.py:my_server --server-name "My Analysis Server" --with pandas
|
| 276 |
|
| 277 |
# Install in Claude Code with environment variables
|
| 278 |
fastmcp install claude-code server.py --env API_KEY=secret --env DEBUG=true
|