> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mcp-use.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Cli
> CLI tool to scaffold a new MCP server project using mcp-use API Documentation
export const RandomGradientBackground = ({className, color, children, grayscaled = false}) => {
const saturation = useMemo(() => {
if (color) {
const values = color.split("(")[1].split(")")[0].trim().split(/\s+/);
return parseFloat(values[1] || "0");
}
return grayscaled ? 0 : 0.2;
}, [color, grayscaled]);
const lightness = useMemo(() => {
if (color) {
const values = color.split("(")[1].split(")")[0].trim().split(/\s+/);
return parseFloat(values[0] || "0.5");
}
return grayscaled ? 0.3 : 0.4;
}, [color, grayscaled]);
const randomHue = useMemo(() => {
if (color) {
const values = color.split("(")[1].split(")")[0].trim().split(/\s+/);
return parseFloat(values[2] || "0");
}
return Math.floor(Math.random() * 360);
}, [color]);
const randomColor = useMemo(() => {
if (color) {
return color;
}
return `oklch(${Math.min(lightness, 1)} ${saturation} ${randomHue})`;
}, [randomHue, saturation, lightness]);
const lightColor = useMemo(() => {
return `oklch(${Math.min(lightness * 2, 1)} ${saturation} ${randomHue})`;
}, [randomHue, saturation, lightness, color]);
const direction = useMemo(() => {
return Math.floor(Math.random() * 360);
}, [randomHue]);
const brightnessFilter = useMemo(() => {
return "1000%";
}, []);
return ;
};
View the source code for this module on GitHub: [https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp\_use/server/templates/cli.py](https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/server/templates/cli.py)
CLI tool to scaffold a new MCP server project using mcp-use.
## copy\_template
### `function` copy\_template
Copy the template to the target folder after replacing placeholders.
```python theme={null}
from mcp_use.server.templates.cli import copy_template
```
**Parameters**
> Parameter value
> Parameter value
> Dictionary of key-value pairs
**Signature**
```python wrap theme={null}
def copy_template(template_dir: pathlib.Path, target_dir: pathlib.Path, context: dict[str, str]):
```
## detect\_installer
### `function` detect\_installer
Detect the best available package installer. Returns (name, install\_command).
```python theme={null}
from mcp_use.server.templates.cli import detect_installer
```
**Returns**
>
**Signature**
```python wrap theme={null}
def detect_installer():
```
## get\_available\_templates
### `function` get\_available\_templates
Returns the list of available templates.
```python theme={null}
from mcp_use.server.templates.cli import get_available_templates
```
**Returns**
>
**Signature**
```python wrap theme={null}
def get_available_templates():
```
## install\_dependencies
### `function` install\_dependencies
Prompt user to install dependencies and run the installer. Returns True if installed.
```python theme={null}
from mcp_use.server.templates.cli import install_dependencies
```
**Parameters**
> Parameter value
**Returns**
>
**Signature**
```python wrap theme={null}
def install_dependencies(target_dir: pathlib.Path):
```
## main
### `function` main
```python theme={null}
from mcp_use.server.templates.cli import main
```
**Signature**
```python wrap theme={null}
def main():
```
## render\_template
### `function` render\_template
Replace \{\{KEY}} placeholders with context values.
```python theme={null}
from mcp_use.server.templates.cli import render_template
```
**Parameters**
> String value
> Dictionary of key-value pairs
**Returns**
>
**Signature**
```python wrap theme={null}
def render_template(content: str, context: dict[str, str]):
```
## run\_install
### `function` run\_install
Run the installer, capturing output. Returns True on success.
```python theme={null}
from mcp_use.server.templates.cli import run_install
```
**Parameters**
> Name identifier
> List of items
> Parameter value
**Returns**
>
**Signature**
```python wrap theme={null}
def run_install(name: str, cmd: list[str], target_dir: pathlib.Path):
```
## validate\_project\_name
### `function` validate\_project\_name
Check if the inserted name is a valid project name.
```python theme={null}
from mcp_use.server.templates.cli import validate_project_name
```
**Parameters**
> Name identifier
**Returns**
>
**Signature**
```python wrap theme={null}
def validate_project_name(name: str):
```