mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-09 23:29:10 +02:00
2c451bf6baCo-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com>
62 lines
2 KiB
Text
62 lines
2 KiB
Text
---
|
|
title: claude_desktop
|
|
sidebarTitle: claude_desktop
|
|
---
|
|
|
|
# `fastmcp.cli.install.claude_desktop`
|
|
|
|
|
|
Claude Desktop integration for FastMCP install using Cyclopts.
|
|
|
|
## Functions
|
|
|
|
### `get_claude_config_path` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/cli/install/claude_desktop.py#L20" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
get_claude_config_path(config_path: Path | None = None) -> Path | None
|
|
```
|
|
|
|
|
|
Get the Claude config directory based on platform.
|
|
|
|
**Args:**
|
|
- `config_path`: Optional custom path to the Claude Desktop config directory
|
|
|
|
|
|
### `install_claude_desktop` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/cli/install/claude_desktop.py#L49" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
install_claude_desktop(file: Path, server_object: str | None, name: str) -> bool
|
|
```
|
|
|
|
|
|
Install FastMCP server in Claude Desktop.
|
|
|
|
**Args:**
|
|
- `file`: Path to the server file
|
|
- `server_object`: Optional server object name (for \:object suffix)
|
|
- `name`: Name for the server in Claude's config
|
|
- `with_editable`: Optional list of directories to install in editable mode
|
|
- `with_packages`: Optional list of additional packages to install
|
|
- `env_vars`: Optional dictionary of environment variables
|
|
- `python_version`: Optional Python version to use
|
|
- `with_requirements`: Optional requirements file to install from
|
|
- `project`: Optional project directory to run within
|
|
- `config_path`: Optional custom path to Claude Desktop config directory
|
|
|
|
**Returns:**
|
|
- True if installation was successful, False otherwise
|
|
|
|
|
|
### `claude_desktop_command` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/cli/install/claude_desktop.py#L139" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
claude_desktop_command(server_spec: str) -> None
|
|
```
|
|
|
|
|
|
Install an MCP server in Claude Desktop.
|
|
|
|
**Args:**
|
|
- `server_spec`: Python file to install, optionally with \:object suffix
|
|
|