changed examples

Author: shiraayal-tadata

examples/01_simple_example.py

@@ -0,0 +1,25 @@
+
+"""
+This example shows a simple MCP server created from a 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,
+    name="Item API MCP",
+    description="MCP server for the Item API",
+    base_url="http://localhost:8000",
+)
+
+mcp.mount()
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="0.0.0.0", port=8000)

examples/02_full_schema_description_example.py

@@ -0,0 +1,22 @@
+
+"""
+This example shows how to describe the full response schema instead of just a response example.
+"""
+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
+)
+mcp.mount()
+
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run(app, host="0.0.0.0", port=8000)

examples/filtered_tools_example.py renamed to examples/03_custom_exposed_endpoints_example.py

@@ -1,53 +1,40 @@
-from examples.shared.apps import items
+"""
+This example shows how to customize exposing endpoints by filtering operation IDs and tags.
+"""
+from examples.shared.apps.items import app
 from examples.shared.setup import setup_logging
 
-from fastapi import FastAPI
 from fastapi_mcp import FastApiMCP
 
 setup_logging()
 
-app = FastAPI()
-app.include_router(items.router)
-
-# Example demonstrating how to filter MCP tools by operation IDs and tags
-
 # Filter by including specific operation IDs
 include_operations_mcp = FastApiMCP(
     app,
-    name="Item API MCP - Included Operations",
-    description="MCP server showing only specific operations",
     include_operations=["get_item", "list_items"],
 )
 
 # Filter by excluding specific operation IDs
 exclude_operations_mcp = FastApiMCP(
-    app,
-    name="Item API MCP - Excluded Operations",
-    description="MCP server showing all operations except the excluded ones",
+    app,    
     exclude_operations=["create_item", "update_item", "delete_item"],
 )
 
 # Filter by including specific tags
 include_tags_mcp = FastApiMCP(
     app,
-    name="Item API MCP - Included Tags",
-    description="MCP server showing operations with specific tags",
     include_tags=["items"],
 )
 
 # Filter by excluding specific tags
 exclude_tags_mcp = FastApiMCP(
     app,
-    name="Item API MCP - Excluded Tags",
-    description="MCP server showing operations except those with specific tags",
     exclude_tags=["search"],
 )
 
 # Combine operation IDs and tags (include mode)
 combined_include_mcp = FastApiMCP(
     app,
-    name="Item API MCP - Combined Include",
-    description="MCP server showing operations by combining include filters",
     include_operations=["delete_item"],
     include_tags=["search"],
 )
@@ -68,4 +55,4 @@
     print(" - /include-tags-mcp: Only operations with the 'items' tag")
     print(" - /exclude-tags-mcp: All operations except those with the 'search' tag")
     print(" - /combined-include-mcp: Operations with 'search' tag or delete_item operation")
-    uvicorn.run(items.router, host="0.0.0.0", port=8000)
+    uvicorn.run(app, host="0.0.0.0", port=8000)

examples/04_separate_server_example.py

@@ -0,0 +1,47 @@
+"""
+This example shows how to run the MCP server and the FastAPI app separately.
+"""
+from fastapi import FastAPI
+import asyncio
+import uvicorn
+
+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"
+ITEMS_API_PORT = 8001
+
+
+# Take the FastAPI app only as a source for MCP server generation
+mcp = FastApiMCP(
+    app,
+    base_url=f"http://{ITEMS_API_HOST}:{ITEMS_API_PORT}",  # Note how the base URL is the **Items API** URL, not the MCP server URL
+)
+
+# And then mount the MCP server to a separate FastAPI app
+mcp_app = FastAPI()
+mcp.mount(mcp_app)
+
+
+def run_items_app():
+    uvicorn.run(app, port=ITEMS_API_PORT)
+
+
+def run_mcp_app():
+    uvicorn.run(mcp_app, port=MCP_SERVER_PORT)
+
+
+# The MCP server depends on the Items API to be available, so we need to run both.
+async def main():
+    await asyncio.gather(asyncio.to_thread(run_items_app), asyncio.to_thread(run_mcp_app))
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/reregister_tools_example.py renamed to examples/05_reregister_tools_example.py

@@ -1,26 +1,21 @@
-from examples.shared.apps import items
+"""
+This example shows how to re-register tools if you add endpoints after the MCP server was created.
+"""
+from examples.shared.apps.items import app
 from examples.shared.setup import setup_logging
 
-from fastapi import FastAPI
 from fastapi_mcp import FastApiMCP
 
 setup_logging()
 
 
-app = FastAPI()
-app.include_router(items.router)
-
-
 # Add MCP server to the FastAPI app
 mcp = FastApiMCP(app)
-
-
-# MCP server
 mcp.mount()
 
 
 # This endpoint will not be registered as a tool, since it was added after the MCP instance was created
-@items.router.get("/new/endpoint/", operation_id="new_endpoint", response_model=dict[str, str])
+@app.get("/new/endpoint/", operation_id="new_endpoint", response_model=dict[str, str])
 async def new_endpoint():
     return {"message": "Hello, world!"}
 
@@ -32,4 +27,4 @@ async def new_endpoint():
 if __name__ == "__main__":
     import uvicorn
 
-    uvicorn.run(items.router, host="0.0.0.0", port=8000)
+    uvicorn.run(app, host="0.0.0.0", port=8000)

examples/06_custom_mcp_router_example.py

@@ -0,0 +1,26 @@
+"""
+This example shows how to mount the MCP server to a specific APIRouter, giving a custom mount path.
+"""
+from examples.shared.apps.items import app
+from examples.shared.setup import setup_logging
+
+from fastapi import APIRouter
+from fastapi_mcp import FastApiMCP
+
+setup_logging()
+
+
+router = APIRouter(prefix="/other/route")
+app.include_router(router)
+
+mcp = FastApiMCP(app)
+
+# Mount the MCP server to a specific router.
+# It will now only be available at `/other/route/mcp`
+mcp.mount(router)
+
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="0.0.0.0", port=8000)