mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-09 15:19:10 +02:00
71 lines
2.2 KiB
Text
71 lines
2.2 KiB
Text
---
|
|
title: claude_code
|
|
sidebarTitle: claude_code
|
|
---
|
|
|
|
# `fastmcp.cli.install.claude_code`
|
|
|
|
|
|
Claude Code integration for FastMCP install using Cyclopts.
|
|
|
|
## Functions
|
|
|
|
### `find_claude_command` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/install/claude_code.py#L20" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
find_claude_command() -> str | None
|
|
```
|
|
|
|
|
|
Find the Claude Code CLI command.
|
|
|
|
Checks common installation locations since 'claude' is often a shell alias
|
|
that doesn't work with subprocess calls.
|
|
|
|
|
|
### `check_claude_code_available` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/install/claude_code.py#L68" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
check_claude_code_available() -> bool
|
|
```
|
|
|
|
|
|
Check if Claude Code CLI is available.
|
|
|
|
|
|
### `install_claude_code` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/install/claude_code.py#L73" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
install_claude_code(file: Path, server_object: str | None, name: str) -> bool
|
|
```
|
|
|
|
|
|
Install FastMCP server in Claude Code.
|
|
|
|
**Args:**
|
|
- `file`: Path to the server file
|
|
- `server_object`: Optional server object name (for \:object suffix)
|
|
- `name`: Name for the server in Claude Code
|
|
- `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
|
|
|
|
**Returns:**
|
|
- True if installation was successful, False otherwise
|
|
|
|
|
|
### `claude_code_command` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/install/claude_code.py#L162" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
claude_code_command(server_spec: str) -> None
|
|
```
|
|
|
|
|
|
Install an MCP server in Claude Code.
|
|
|
|
**Args:**
|
|
- `server_spec`: Python file to install, optionally with \:object suffix
|
|
|