fastmcp 0.1.0__tar.gz

fastmcp-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish FastMCP to PyPI
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  publish-pypi-release:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+          cache-dependency-path: "**/pyproject.toml"
+      - name: Install dependencies
+        run: |
+          pip install setuptools wheel build
+      - name: Build
+        run: |
+          python -m build
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true

fastmcp-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.DS_Store
+
+
+src/fastmcp/_version.py

fastmcp-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

fastmcp-0.1.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.1
+Name: fastmcp
+Version: 0.1.0
+Summary: A more ergonomic interface for MCP servers
+Author: Jeremiah Lowin
+License: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.26.0
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: pydantic-settings>=2.6.1
+Requires-Dist: pydantic>=2.5.3
+Requires-Dist: typer>=0.9.0
+
+# FastMCP
+
+> **Note**: This is experimental software. The Model Context Protocol itself is only a few days old and the specification is still evolving.
+
+A fast, pythonic way to build Model Context Protocol (MCP) servers.
+
+The Model Context Protocol is an extremely powerful way to give LLMs access to tools and resources. However, building MCP servers can be difficult and cumbersome. FastMCP provides a simple, intuitive interface for creating MCP servers in Python.
+
+## Installation
+
+MCP servers require you to use [uv](https://github.com/astral-sh/uv) as your dependency manager.
+
+
+Install uv with brew:
+```bash
+brew install uv
+```
+*(Editor's note: I was unable to get MCP servers working unless uv was installed with brew.)*
+
+Install FastMCP:
+```bash
+uv pip install fastmcp
+```
+
+
+
+## Quick Start
+
+Here's a simple example that exposes your desktop directory as a resource and provides a basic addition tool:
+
+```python
+from pathlib import Path
+from fastmcp import FastMCP
+
+# Create server
+mcp = FastMCP("Demo")
+
+@mcp.resource("dir://desktop")
+def desktop() -> list[str]:
+    """List the files in the user's desktop"""
+    desktop = Path.home() / "Desktop"
+    return [str(f) for f in desktop.iterdir()]
+
+@mcp.tool()
+def add(a: int, b: int) -> int:
+    """Add two numbers"""
+    return a + b
+
+if __name__ == "__main__":
+    mcp.run()
+```
+
+## Features
+
+### Resources
+
+Resources are data sources that can be accessed by the LLM. They can be files, directories, or any other data source. Resources are defined using the `@resource` decorator:
+
+```python
+@mcp.resource("file://config.json")
+def get_config() -> str:
+    """Read the config file"""
+    return Path("config.json").read_text()
+```
+
+### Tools
+
+Tools are functions that can be called by the LLM. They are defined using the `@tool` decorator:
+
+```python
+@mcp.tool()
+def calculate(x: int, y: int) -> int:
+    """Perform a calculation"""
+    return x + y
+```
+
+## Development
+
+### Running the Dev Inspector
+
+FastMCP includes a development server with the MCP Inspector for testing your server:
+
+```bash
+fastmcp dev your_server.py
+```
+
+### Installing in Claude
+
+To use your server with Claude Desktop:
+
+```bash
+fastmcp install your_server.py --name "My Server"
+```
+
+
+## Configuration
+
+FastMCP can be configured via environment variables with the prefix `FASTMCP_`:
+
+- `FASTMCP_DEBUG`: Enable debug mode
+- `FASTMCP_LOG_LEVEL`: Set logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
+- `FASTMCP_HOST`: HTTP server host (default: 0.0.0.0)
+- `FASTMCP_PORT`: HTTP server port (default: 8000)
+
+## License
+
+Apache 2.0

fastmcp-0.1.0/README.md

@@ -0,0 +1,107 @@
+# FastMCP
+
+> **Note**: This is experimental software. The Model Context Protocol itself is only a few days old and the specification is still evolving.
+
+A fast, pythonic way to build Model Context Protocol (MCP) servers.
+
+The Model Context Protocol is an extremely powerful way to give LLMs access to tools and resources. However, building MCP servers can be difficult and cumbersome. FastMCP provides a simple, intuitive interface for creating MCP servers in Python.
+
+## Installation
+
+MCP servers require you to use [uv](https://github.com/astral-sh/uv) as your dependency manager.
+
+
+Install uv with brew:
+```bash
+brew install uv
+```
+*(Editor's note: I was unable to get MCP servers working unless uv was installed with brew.)*
+
+Install FastMCP:
+```bash
+uv pip install fastmcp
+```
+
+
+
+## Quick Start
+
+Here's a simple example that exposes your desktop directory as a resource and provides a basic addition tool:
+
+```python
+from pathlib import Path
+from fastmcp import FastMCP
+
+# Create server
+mcp = FastMCP("Demo")
+
+@mcp.resource("dir://desktop")
+def desktop() -> list[str]:
+    """List the files in the user's desktop"""
+    desktop = Path.home() / "Desktop"
+    return [str(f) for f in desktop.iterdir()]
+
+@mcp.tool()
+def add(a: int, b: int) -> int:
+    """Add two numbers"""
+    return a + b
+
+if __name__ == "__main__":
+    mcp.run()
+```
+
+## Features
+
+### Resources
+
+Resources are data sources that can be accessed by the LLM. They can be files, directories, or any other data source. Resources are defined using the `@resource` decorator:
+
+```python
+@mcp.resource("file://config.json")
+def get_config() -> str:
+    """Read the config file"""
+    return Path("config.json").read_text()
+```
+
+### Tools
+
+Tools are functions that can be called by the LLM. They are defined using the `@tool` decorator:
+
+```python
+@mcp.tool()
+def calculate(x: int, y: int) -> int:
+    """Perform a calculation"""
+    return x + y
+```
+
+## Development
+
+### Running the Dev Inspector
+
+FastMCP includes a development server with the MCP Inspector for testing your server:
+
+```bash
+fastmcp dev your_server.py
+```
+
+### Installing in Claude
+
+To use your server with Claude Desktop:
+
+```bash
+fastmcp install your_server.py --name "My Server"
+```
+
+
+## Configuration
+
+FastMCP can be configured via environment variables with the prefix `FASTMCP_`:
+
+- `FASTMCP_DEBUG`: Enable debug mode
+- `FASTMCP_LOG_LEVEL`: Set logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
+- `FASTMCP_HOST`: HTTP server host (default: 0.0.0.0)
+- `FASTMCP_PORT`: HTTP server port (default: 8000)
+
+## License
+
+Apache 2.0

fastmcp-0.1.0/examples/desktop.py

@@ -0,0 +1,29 @@
+"""
+FastMCP Desktop Example
+
+A simple example that exposes the desktop directory as a resource.
+"""
+
+from pathlib import Path
+
+from fastmcp.server import FastMCP
+
+# Create server
+mcp = FastMCP("Demo")
+
+
+@mcp.resource("dir://desktop")
+def desktop() -> list[str]:
+    """List the files in the user's desktop"""
+    desktop = Path.home() / "Desktop"
+    return [str(f) for f in desktop.iterdir()]
+
+
+@mcp.tool()
+def add(a: int, b: int) -> int:
+    """Add two numbers"""
+    return a + b
+
+
+if __name__ == "__main__":
+    mcp.run()

fastmcp-0.1.0/examples/screenshot.py

@@ -0,0 +1,34 @@
+# /// script
+# dependencies = ["pyautogui"]
+# ///
+
+"""
+FastMCP Screenshot Example
+
+A simple example that provides a tool to capture screenshots.
+"""
+
+import base64
+import io
+import pyautogui
+
+from fastmcp.server import FastMCP
+
+# Create server
+mcp = FastMCP("Screenshot Demo")
+
+
+@mcp.tool()
+def take_screenshot() -> str:
+    """Take a screenshot and return it as a base64 encoded string"""
+    # Capture the screen
+    screenshot = pyautogui.screenshot()
+
+    # Convert to base64
+    buffer = io.BytesIO()
+    screenshot.save(buffer, format="PNG")
+    return base64.b64encode(buffer.getvalue()).decode()
+
+
+if __name__ == "__main__":
+    mcp.run()

fastmcp-0.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[project]
+name = "fastmcp"
+dynamic = ["version"]
+description = "A more ergonomic interface for MCP servers"
+authors = [{ name = "Jeremiah Lowin" }]
+dependencies = [
+    "httpx>=0.26.0",
+    "mcp>=1.0.0",
+    "pydantic-settings>=2.6.1",
+    "pydantic>=2.5.3",
+    "typer>=0.9.0",
+]
+requires-python = ">=3.10"
+readme = "README.md"
+license = { text = "Apache-2.0" }
+
+[project.scripts]
+fastmcp = "fastmcp.cli:app"
+
+[build-system]
+requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "src/fastmcp/_version.py"
+
+[dependency-groups]
+dev = [
+    "copychat>=0.5.2",
+    "ipython>=8.12.3",
+    "pdbpp>=0.10.3",
+    "pytest>=8.3.3",
+    "pytest-asyncio>=0.23.5",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

fastmcp-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fastmcp-0.1.0/src/fastmcp/__init__.py

@@ -0,0 +1 @@
+from .server import FastMCP

fastmcp-0.1.0/src/fastmcp/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)

fastmcp-0.1.0/src/fastmcp/cli/__init__.py

@@ -0,0 +1,5 @@
+"""FastMCP CLI package."""
+
+from .cli import app
+
+__all__ = ["app"]

fastmcp-0.1.0/src/fastmcp/cli/claude.py

@@ -0,0 +1,88 @@
+"""Claude app integration utilities."""
+
+import json
+import sys
+from pathlib import Path
+from typing import Optional
+
+from ..utilities.logging import get_logger
+
+logger = get_logger(__name__)
+
+
+def get_claude_config_path() -> Path | None:
+    """Get the Claude config directory based on platform."""
+    if sys.platform == "win32":
+        path = Path(Path.home(), "AppData", "Roaming", "Claude")
+    elif sys.platform == "darwin":
+        path = Path(Path.home(), "Library", "Application Support", "Claude")
+    else:
+        return None
+
+    if path.exists():
+        return path
+    return None
+
+
+def update_claude_config(
+    file: Path,
+    server_name: Optional[str] = None,
+    *,
+    uv_directory: Optional[Path] = None,
+) -> bool:
+    """Add the MCP server to Claude's configuration.
+
+    Args:
+        file: Path to the server file
+        server_name: Optional custom name for the server. If not provided,
+                    defaults to the file stem
+        uv_directory: Optional directory containing pyproject.toml
+    """
+    config_dir = get_claude_config_path()
+    if not config_dir:
+        return False
+
+    config_file = config_dir / "claude_desktop_config.json"
+    if not config_file.exists():
+        return False
+
+    try:
+        config = json.loads(config_file.read_text())
+        if "mcpServers" not in config:
+            config["mcpServers"] = {}
+
+        # Use provided server_name or fall back to file stem
+        name = server_name or file.stem
+        if name in config["mcpServers"]:
+            logger.warning(
+                f"Server '{name}' already exists in Claude config",
+                extra={"config_file": str(config_file)},
+            )
+            return False
+
+        # Build uv run command
+        args = []
+        if uv_directory:
+            args.extend(["--directory", str(uv_directory)])
+        args.extend(["run", str(file)])
+
+        config["mcpServers"][name] = {
+            "command": "uv",
+            "args": args,
+        }
+
+        config_file.write_text(json.dumps(config, indent=2))
+        logger.info(
+            f"Added server '{name}' to Claude config",
+            extra={"config_file": str(config_file)},
+        )
+        return True
+    except Exception as e:
+        logger.error(
+            "Failed to update Claude config",
+            extra={
+                "error": str(e),
+                "config_file": str(config_file),
+            },
+        )
+        return False