fix examples

Author: shiraayal-tadata

examples/01_basic_usage_example.py

@@ -1,20 +1,18 @@
+from examples.shared.apps.items import app # The FastAPI app
+from examples.shared.setup import setup_logging
 
-"""
-This example shows a simple MCP server created from a FastAPI app.
-"""
-from examples.shared.items_app import app # The FastAPI app
 from fastapi_mcp import FastApiMCP
 
+setup_logging()
+
 # Add MCP server to the FastAPI app
-mcp = FastApiMCP(
-    app,
-    name="Item API MCP",
-    description="MCP server for the Item API",
-)
+mcp = FastApiMCP(app)
 
 # Mount the MCP server to the FastAPI app
 mcp.mount()
 
+
 if __name__ == "__main__":
     import uvicorn
-    uvicorn.run(app, host="0.0.0.0", port=8000)
+
+    uvicorn.run(app, host="0.0.0.0", port=8000)

examples/02_full_schema_description_example.py

@@ -2,16 +2,25 @@
 """
 This example shows how to describe the full response schema instead of just a response example.
 """
-from examples.shared.items_app import app # The FastAPI app
+from examples.shared.apps.items import app # The FastAPI app
+from examples.shared.setup import setup_logging
+
 from fastapi_mcp import FastApiMCP
 
+setup_logging()
+
+# Add MCP server to the FastAPI app
 mcp = FastApiMCP(
     app,
-    describe_full_response_schema=True,  # Include all possible response schemas in tool descriptions
-    describe_all_responses=True,  # Include full JSON schema in tool descriptions
+    name="Item API MCP",
+    description="MCP server for the Item API",
+    describe_full_response_schema=True,  # Describe the full response JSON-schema instead of just a response example
+    describe_all_responses=True,  # Describe all the possible responses instead of just the success (2XX) response
 )
+
 mcp.mount()
 
 if __name__ == "__main__":
     import uvicorn
+    
     uvicorn.run(app, host="0.0.0.0", port=8000)

examples/03_custom_exposed_endpoints_example.py

@@ -6,9 +6,14 @@
 - You can combine operation filtering with tag filtering (e.g., use `include_operations` with `include_tags`)
 - When combining filters, a greedy approach will be taken. Endpoints matching either criteria will be included
 """
-from examples.shared.items_app import app # The FastAPI app
+from examples.shared.apps.items import app # The FastAPI app
+from examples.shared.setup import setup_logging
+
 from fastapi_mcp import FastApiMCP
 
+setup_logging()
+
+# Examples demonstrating how to filter MCP tools by operation IDs and tags
 
 # Filter by including specific operation IDs
 include_operations_mcp = FastApiMCP(

examples/04_separate_server_example.py

@@ -4,10 +4,13 @@
 """
 from fastapi import FastAPI
 
-from examples.shared.items_app import app
+from examples.shared.apps.items import app
+from examples.shared.setup import setup_logging
 
 from fastapi_mcp import FastApiMCP
 
+setup_logging()
+
 MCP_SERVER_HOST = "localhost"
 MCP_SERVER_PORT = 8000
 ITEMS_API_HOST = "localhost"

examples/05_reregister_tools_example.py

@@ -1,9 +1,12 @@
 """
 This example shows how to re-register tools if you add endpoints after the MCP server was created.
 """
-from examples.shared.items_app import app # The FastAPI app
+from examples.shared.apps.items import app # The FastAPI app
+from examples.shared.setup import setup_logging
+
 from fastapi_mcp import FastApiMCP
 
+setup_logging()
 
 mcp = FastApiMCP(app) # Add MCP server to the FastAPI app
 mcp.mount() # MCP server
@@ -21,4 +24,5 @@ async def new_endpoint():
 
 if __name__ == "__main__":
     import uvicorn
+    
     uvicorn.run(app, host="0.0.0.0", port=8000)

examples/06_custom_mcp_router_example.py

@@ -1,10 +1,13 @@
 """
 This example shows how to mount the MCP server to a specific APIRouter, giving a custom mount path.
 """
-from examples.shared.items_app import app # The FastAPI app
+from examples.shared.apps.items import app # The FastAPI app
+from examples.shared.setup import setup_logging
+
 from fastapi import APIRouter
 from fastapi_mcp import FastApiMCP
 
+setup_logging()
 
 other_router = APIRouter(prefix="/other/route")    
 app.include_router(other_router)
@@ -18,4 +21,5 @@
 
 if __name__ == "__main__":
     import uvicorn
+    
     uvicorn.run(app, host="0.0.0.0", port=8000)

examples/07_configure_http_timeout_example.py

@@ -2,11 +2,15 @@
 This example shows how to configure the HTTP client timeout for the MCP server.
 In case you have API endpoints that take longer than 5 seconds to respond, you can increase the timeout.
 """
+from examples.shared.apps.items import app # The FastAPI app
+from examples.shared.setup import setup_logging
+
 import httpx
 
-from examples.shared.items_app import app # The FastAPI app
 from fastapi_mcp import FastApiMCP
 
+setup_logging()
+
 
 mcp = FastApiMCP(
     app,
@@ -17,4 +21,5 @@
 
 if __name__ == "__main__":
     import uvicorn
+    
     uvicorn.run(app, host="0.0.0.0", port=8000)

examples/shared/apps/__init__.py

@@ -0,0 +1,125 @@
+"""
+Simple example of using FastAPI-MCP to add an MCP server to a FastAPI app.
+"""
+
+from fastapi import FastAPI, HTTPException, Query
+from pydantic import BaseModel
+from typing import List, Optional
+
+
+router = FastAPI()
+
+
+class Item(BaseModel):
+    id: int
+    name: str
+    description: Optional[str] = None
+    price: float
+    tags: List[str] = []
+
+
+items_db: dict[int, Item] = {}
+
+
+@router.get("/items/", response_model=List[Item], tags=["items"], operation_id="list_items")
+async def list_items(skip: int = 0, limit: int = 10):
+    """
+    List all items in the database.
+
+    Returns a list of items, with pagination support.
+    """
+    return list(items_db.values())[skip : skip + limit]
+
+
+@router.get("/items/{item_id}", response_model=Item, tags=["items"], operation_id="get_item")
+async def read_item(item_id: int):
+    """
+    Get a specific item by its ID.
+
+    Raises a 404 error if the item does not exist.
+    """
+    if item_id not in items_db:
+        raise HTTPException(status_code=404, detail="Item not found")
+    return items_db[item_id]
+
+
+@router.post("/items/", response_model=Item, tags=["items"], operation_id="create_item")
+async def create_item(item: Item):
+    """
+    Create a new item in the database.
+
+    Returns the created item with its assigned ID.
+    """
+    items_db[item.id] = item
+    return item
+
+
+@router.put("/items/{item_id}", response_model=Item, tags=["items"], operation_id="update_item")
+async def update_item(item_id: int, item: Item):
+    """
+    Update an existing item.
+
+    Raises a 404 error if the item does not exist.
+    """
+    if item_id not in items_db:
+        raise HTTPException(status_code=404, detail="Item not found")
+
+    item.id = item_id
+    items_db[item_id] = item
+    return item
+
+
+@router.delete("/items/{item_id}", tags=["items"], operation_id="delete_item")
+async def delete_item(item_id: int):
+    """
+    Delete an item from the database.
+
+    Raises a 404 error if the item does not exist.
+    """
+    if item_id not in items_db:
+        raise HTTPException(status_code=404, detail="Item not found")
+
+    del items_db[item_id]
+    return {"message": "Item deleted successfully"}
+
+
+@router.get("/items/search/", response_model=List[Item], tags=["search"], operation_id="search_items")
+async def search_items(
+    q: Optional[str] = Query(None, description="Search query string"),
+    min_price: Optional[float] = Query(None, description="Minimum price"),
+    max_price: Optional[float] = Query(None, description="Maximum price"),
+    tags: List[str] = Query([], description="Filter by tags"),
+):
+    """
+    Search for items with various filters.
+
+    Returns a list of items that match the search criteria.
+    """
+    results = list(items_db.values())
+
+    if q:
+        q = q.lower()
+        results = [
+            item for item in results if q in item.name.lower() or (item.description and q in item.description.lower())
+        ]
+
+    if min_price is not None:
+        results = [item for item in results if item.price >= min_price]
+    if max_price is not None:
+        results = [item for item in results if item.price <= max_price]
+
+    if tags:
+        results = [item for item in results if all(tag in item.tags for tag in tags)]
+
+    return results
+
+
+sample_items = [
+    Item(id=1, name="Hammer", description="A tool for hammering nails", price=9.99, tags=["tool", "hardware"]),
+    Item(id=2, name="Screwdriver", description="A tool for driving screws", price=7.99, tags=["tool", "hardware"]),
+    Item(id=3, name="Wrench", description="A tool for tightening bolts", price=12.99, tags=["tool", "hardware"]),
+    Item(id=4, name="Saw", description="A tool for cutting wood", price=19.99, tags=["tool", "hardware", "cutting"]),
+    Item(id=5, name="Drill", description="A tool for drilling holes", price=49.99, tags=["tool", "hardware", "power"]),
+]
+for item in sample_items:
+    items_db[item.id] = item

examples/shared/items_app.py renamed to examples/shared/apps/items.py

@@ -0,0 +1,38 @@
+import logging
+
+from pydantic import BaseModel
+
+
+class LoggingConfig(BaseModel):
+    LOGGER_NAME: str = "fastapi_mcp"
+    LOG_FORMAT: str = "%(levelprefix)s %(asctime)s\t[%(name)s] %(message)s"
+    LOG_LEVEL: str = logging.getLevelName(logging.DEBUG)
+
+    version: int = 1
+    disable_existing_loggers: bool = False
+    formatters: dict = {
+        "default": {
+            "()": "uvicorn.logging.DefaultFormatter",
+            "fmt": LOG_FORMAT,
+            "datefmt": "%Y-%m-%d %H:%M:%S",
+        },
+    }
+    handlers: dict = {
+        "default": {
+            "formatter": "default",
+            "class": "logging.StreamHandler",
+            "stream": "ext://sys.stdout",
+        },
+    }
+    loggers: dict = {
+        "": {"handlers": ["default"], "level": LOG_LEVEL},  # Root logger
+        "uvicorn": {"handlers": ["default"], "level": LOG_LEVEL},
+        LOGGER_NAME: {"handlers": ["default"], "level": LOG_LEVEL},
+    }
+
+
+def setup_logging():
+    from logging.config import dictConfig
+
+    logging_config = LoggingConfig()
+    dictConfig(logging_config.model_dump())