fastmcp 0.3.4__tar.gz → 0.4.0__tar.gz

fastmcp-0.4.0/.github/ai-labeler.yml

@@ -0,0 +1,87 @@
+instructions: |
+  Apply the minimal set of labels that accurately characterize the issue/PR:
+  - Use at most 1-2 labels unless there's a compelling reason for more. It's ok to use no labels.
+  - Prefer specific labels (bug, feature) over generic ones (question, help wanted)
+  - For PRs that fix bugs, use 'bug' not 'enhancement'
+  - Never combine: bug + enhancement, feature + enhancement. For these labels, only choose the most relevant one.
+  - Reserve 'question' and 'help wanted' for when they're the primary characteristic
+
+labels:
+  - bug:
+    description: "Something isn't working as expected"
+    instructions: |
+      Apply when describing or fixing unexpected behavior:
+      - Issues: Clear error messages or unexpected outcomes
+      - PRs: Standalone fixes for broken functionality or closing bug reports.
+      Don't apply bug unless the issue or PR is predominantly about a specific bug.
+
+  - documentation:
+    description: "Improvements or additions to documentation"
+    instructions: |
+      Apply only when documentation is the primary focus:
+      - README updates
+      - Code comments and docstrings
+      - API documentation
+      - Usage examples
+      Don't apply for minor doc updates alongside code changes
+
+  - enhancement:
+    description: "Improvements to existing features"
+    instructions: |
+      Apply only for improvements to existing functionality:
+      - Performance improvements
+      - UI/UX improvements
+      - Expanded capabilities of existing features
+      Don't apply to:
+      - Bug fixes
+      - New features
+      - Minor tweaks
+
+  - feature:
+    description: "New functionality"
+    instructions: |
+      Apply only for net-new functionality:
+      - New API endpoints
+      - New commands or tools
+      - New user-facing capabilities
+      Don't apply to:
+      - Improvements to existing features (use enhancement)
+      - Bug fixes
+
+  - good first issue:
+    description: "Good for newcomers"
+    instructions: |
+      Apply very selectively to issues that are:
+      - Small in scope
+      - Well-documented
+      - Require minimal context
+      - Have clear success criteria
+      Don't apply if the task requires significant background knowledge
+
+  - help wanted:
+    description: "Extra attention is needed"
+    instructions: |
+      Apply only when it's the primary characteristic:
+      - Issue needs external expertise
+      - Current maintainers can't address it
+      - Additional contributors would be valuable
+      Don't apply just because an issue is open or needs work
+
+  - question:
+    description: "Further information is requested"
+    instructions: |
+      Apply only when the primary purpose is seeking information:
+      - Clarification needed before work can begin
+      - Architectural discussions
+      - Implementation strategy questions
+      Don't apply to:
+      - Bug reports that need more details
+      - Feature requests that need refinement
+
+# These files will be included in the context if they exist
+context-files:
+  - README.md
+  - CONTRIBUTING.md
+  - CODE_OF_CONDUCT.md
+  - .github/ISSUE_TEMPLATE/bug_report.md
+  - .github/ISSUE_TEMPLATE/feature_request.md

{fastmcp-0.3.4 → fastmcp-0.4.0}/.github/workflows/ai-labeler.yml

@@ -19,5 +19,6 @@ jobs:
       - uses: actions/checkout@v4
       - uses: jlowin/ai-labeler@v0.5.0
         with:
+          include-repo-labels: false
           openai-api-key: ${{ secrets.OPENAI_API_KEY }}
           controlflow-llm-model: openai/gpt-4o-mini

fastmcp-0.3.4/.github/workflows/lint.yml → fastmcp-0.4.0/.github/workflows/run-static.yml

@@ -28,3 +28,9 @@ jobs:
           python-version: "3.12"
       - name: Run pre-commit
         uses: pre-commit/action@v3.0.1
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[tests]"
+      - name: Run pyright
+        run: pyright src tests

{fastmcp-0.3.4 → fastmcp-0.4.0}/.github/workflows/run-tests.yml

@@ -12,12 +12,14 @@ on:
       - "tests/**"
       - "uv.lock"
       - "pyproject.toml"
+      - ".github/workflows/**"
   pull_request:
     paths:
       - "src/**"
       - "tests/**"
       - "uv.lock"
       - "pyproject.toml"
+      - ".github/workflows/**"
 
   workflow_dispatch:
 
@@ -26,8 +28,13 @@ permissions:
 
 jobs:
   run_tests:
-    name: Run tests
-    runs-on: ubuntu-latest
+    name: "Run tests: Python ${{ matrix.python-version }} on ${{ matrix.os }}"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.10"]
+      fail-fast: false
 
     steps:
       - uses: actions/checkout@v4
@@ -35,11 +42,11 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v4
 
-      - name: Set up Python
-        run: uv python install 3.11
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
 
       - name: Install FastMCP
-        run: uv sync --extra dev
+        run: uv sync --extra tests
 
       - name: Run tests
         run: uv run pytest -vv

{fastmcp-0.3.4 → fastmcp-0.4.0}/.gitignore

@@ -16,4 +16,4 @@ src/fastmcp/_version.py
 
 # editors
 .cursorrules
-.vscode/
+.vscode/

fastmcp-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jeremiah Lowin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{fastmcp-0.3.4 → fastmcp-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastmcp
-Version: 0.3.4
+Version: 0.4.0
 Summary: A more ergonomic interface for MCP servers
 Author: Jeremiah Lowin
 License: Apache-2.0
@@ -16,10 +16,20 @@ Requires-Dist: copychat>=0.5.2; extra == 'dev'
 Requires-Dist: ipython>=8.12.3; extra == 'dev'
 Requires-Dist: pdbpp>=0.10.3; extra == 'dev'
 Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pyright>=1.1.389; extra == 'dev'
 Requires-Dist: pytest-asyncio>=0.23.5; extra == 'dev'
+Requires-Dist: pytest-flakefinder; extra == 'dev'
 Requires-Dist: pytest-xdist>=3.6.1; extra == 'dev'
 Requires-Dist: pytest>=8.3.3; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: tests
+Requires-Dist: pre-commit; extra == 'tests'
+Requires-Dist: pyright>=1.1.389; extra == 'tests'
+Requires-Dist: pytest-asyncio>=0.23.5; extra == 'tests'
+Requires-Dist: pytest-flakefinder; extra == 'tests'
+Requires-Dist: pytest-xdist>=3.6.1; extra == 'tests'
+Requires-Dist: pytest>=8.3.3; extra == 'tests'
+Requires-Dist: ruff; extra == 'tests'
 Description-Content-Type: text/markdown
 
 <!-- omit in toc -->
@@ -236,6 +246,27 @@ async def fetch_weather(city: str) -> str:
         return response.text
 ```
 
+Complex input handling example:
+```python
+from pydantic import BaseModel, Field
+from typing import Annotated
+
+class ShrimpTank(BaseModel):
+    class Shrimp(BaseModel):
+        name: Annotated[str, Field(max_length=10)]
+
+    shrimp: list[Shrimp]
+
+@mcp.tool()
+def name_shrimp(
+    tank: ShrimpTank,
+    # You can use pydantic Field in function signatures for validation.
+    extra_names: Annotated[list[str], Field(max_length=10)],
+) -> list[str]:
+    """List all shrimp names in the tank"""
+    return [shrimp.name for shrimp in tank.shrimp] + extra_names
+```
+
 ### Prompts
 
 Prompts are reusable templates that help LLMs interact with your server effectively. They're like "best practices" encoded into your server. A prompt can be as simple as a string:
@@ -488,23 +519,20 @@ FastMCP requires Python 3.10+ and [uv](https://docs.astral.sh/uv/).
 
 ### Installation
 
-Create a fork of this repository, then clone it:
+For development, we recommend installing FastMCP with development dependencies, which includes various utilities the maintainers find useful.
 
 ```bash
-git clone https://github.com/YouFancyUserYou/fastmcp.git
+git clone https://github.com/jlowin/fastmcp.git
 cd fastmcp
+uv sync --frozen --extra dev
 ```
 
-Next, create a virtual environment and install FastMCP:
+For running tests only (e.g., in CI), you only need the testing dependencies:
 
 ```bash
-uv venv
-source .venv/bin/activate
-uv sync --frozen --all-extras --dev
+uv sync --frozen --extra tests
 ```
 
-
-
 ### Testing
 
 Please make sure to test any new functionality. Your tests should be simple and atomic and anticipate change rather than cement complex patterns.

{fastmcp-0.3.4 → fastmcp-0.4.0}/README.md

@@ -212,6 +212,27 @@ async def fetch_weather(city: str) -> str:
         return response.text
 ```
 
+Complex input handling example:
+```python
+from pydantic import BaseModel, Field
+from typing import Annotated
+
+class ShrimpTank(BaseModel):
+    class Shrimp(BaseModel):
+        name: Annotated[str, Field(max_length=10)]
+
+    shrimp: list[Shrimp]
+
+@mcp.tool()
+def name_shrimp(
+    tank: ShrimpTank,
+    # You can use pydantic Field in function signatures for validation.
+    extra_names: Annotated[list[str], Field(max_length=10)],
+) -> list[str]:
+    """List all shrimp names in the tank"""
+    return [shrimp.name for shrimp in tank.shrimp] + extra_names
+```
+
 ### Prompts
 
 Prompts are reusable templates that help LLMs interact with your server effectively. They're like "best practices" encoded into your server. A prompt can be as simple as a string:
@@ -464,23 +485,20 @@ FastMCP requires Python 3.10+ and [uv](https://docs.astral.sh/uv/).
 
 ### Installation
 
-Create a fork of this repository, then clone it:
+For development, we recommend installing FastMCP with development dependencies, which includes various utilities the maintainers find useful.
 
 ```bash
-git clone https://github.com/YouFancyUserYou/fastmcp.git
+git clone https://github.com/jlowin/fastmcp.git
 cd fastmcp
+uv sync --frozen --extra dev
 ```
 
-Next, create a virtual environment and install FastMCP:
+For running tests only (e.g., in CI), you only need the testing dependencies:
 
 ```bash
-uv venv
-source .venv/bin/activate
-uv sync --frozen --all-extras --dev
+uv sync --frozen --extra tests
 ```
 
-
-
 ### Testing
 
 Please make sure to test any new functionality. Your tests should be simple and atomic and anticipate change rather than cement complex patterns.

fastmcp-0.4.0/Windows_Notes.md

@@ -0,0 +1,58 @@
+# Getting your development environment set up properly
+To get your environment up and running properly, you'll need a slightly different set of commands that are windows specific:
+```bash
+uv venv
+.venv\Scripts\activate
+uv pip install -e ".[dev]"
+```
+
+This will install the package in editable mode, and install the development dependencies.
+
+
+# Fixing `AttributeError: module 'collections' has no attribute 'Callable'`
+- open `.venv\Lib\site-packages\pyreadline\py3k_compat.py`
+- change `return isinstance(x, collections.Callable)` to 
+``` 
+from collections.abc import Callable
+return isinstance(x, Callable)
+```
+
+# Helpful notes
+For developing FastMCP
+## Install local development version of FastMCP into a local FastMCP project server
+- ensure
+- change directories to your FastMCP Server location so you can install it in your .venv
+- run `.venv\Scripts\activate` to activate your virtual environment
+- Then run a series of commands to uninstall the old version and install the new
+```bash
+# First uninstall
+uv pip uninstall fastmcp
+
+# Clean any build artifacts in your fastmcp directory
+cd C:\path\to\fastmcp
+del /s /q *.egg-info
+
+# Then reinstall in your weather project
+cd C:\path\to\new\fastmcp_server
+uv pip install --no-cache-dir -e C:\Users\justj\PycharmProjects\fastmcp
+
+# Check that it installed properly and has the correct git hash
+pip show fastmcp
+```
+
+## Running the FastMCP server with Inspector
+MCP comes with a node.js application called Inspector that can be used to inspect the FastMCP server. To run the inspector, you'll need to install node.js and npm. Then you can run the following commands:
+```bash
+fastmcp dev server.py
+```
+This will launch a web app on http://localhost:5173/ that you can use to inspect the FastMCP server.
+
+## If you start development before creating a fork - your get out of jail free card
+- Add your fork as a new remote to your local repository `git remote add fork git@github.com:YOUR-USERNAME/REPOSITORY-NAME.git`
+  - This will add your repo, short named 'fork', as a remote to your local repository
+- Verify that it was added correctly by running `git remote -v`
+- Commit your changes
+- Push your changes to your fork `git push fork <branch>`
+- Create your pull request on GitHub 
+
+

fastmcp-0.4.0/examples/complex_inputs.py

@@ -0,0 +1,28 @@
+"""
+FastMCP Complex inputs Example
+
+Demonstrates validation via pydantic with complex models.
+"""
+
+from pydantic import BaseModel, Field
+from typing import Annotated
+from fastmcp.server import FastMCP
+
+mcp = FastMCP("Shrimp Tank")
+
+
+class ShrimpTank(BaseModel):
+    class Shrimp(BaseModel):
+        name: Annotated[str, Field(max_length=10)]
+
+    shrimp: list[Shrimp]
+
+
+@mcp.tool()
+def name_shrimp(
+    tank: ShrimpTank,
+    # You can use pydantic Field in function signatures for validation.
+    extra_names: Annotated[list[str], Field(max_length=10)],
+) -> list[str]:
+    """List all shrimp names in the tank"""
+    return [shrimp.name for shrimp in tank.shrimp] + extra_names