Merge pull request #79 from tadata-org/fix/http-client

HTTP Client Fixes and Improvements

Author: shahar4499

.coveragerc

@@ -1,4 +1,16 @@
 [run]
 omit =
     examples/*
-    tests/*
+    tests/*
+concurrency = multiprocessing
+parallel = true
+sigterm = true
+data_file = .coverage
+source = fastapi_mcp
+
+[report]
+show_missing = true
+
+[paths]
+source =
+    fastapi_mcp/

CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+🚀 FastApiMCP now works with ASGI-transport by default.
+
+This means the `base_url` argument is redundant, and thus has been removed.
+
+You can still set up an explicit base URL using the `http_client` argument, and injecting your own `httpx.AsyncClient` if necessary.
+
+### Removed
+- ⚠️ Breaking Change: Removed `base_url` argument since it's not used anymore by the MCP transport.
+
+### Fixed
+- 🐛 Fix short timeout issue (#71), increasing the default timeout to 10
+
+
 ## [0.2.0]
 
 ### Changed

README.md

@@ -23,6 +23,7 @@
 - **Preserving schemas** of your request models and response models
 - **Preserve documentation** of all your endpoints, just as it is in Swagger
 - **Flexible deployment** - Mount your MCP server to the same app, or deploy separately
+- **ASGI transport** - Uses FastAPI's ASGI interface directly by default for efficient communication
 
 ## Installation
 
@@ -48,23 +49,14 @@ from fastapi_mcp import FastApiMCP
 
 app = FastAPI()
 
-mcp = FastApiMCP(
-    app,
-
-    # Optional parameters
-    name="My API MCP",
-    description="My API description",
-    base_url="http://localhost:8000",
-)
+mcp = FastApiMCP(app)
 
 # Mount the MCP server directly to your FastAPI app
 mcp.mount()
 ```
 
 That's it! Your auto-generated MCP server is now available at `https://app.base.url/mcp`.
 
-> **Note on `base_url`**: While `base_url` is optional, it is highly recommended to provide it explicitly. The `base_url` tells the MCP server where to send API requests when tools are called. Without it, the library will attempt to determine the URL automatically, which may not work correctly in deployed environments where the internal and external URLs differ.
-
 ## Tool Naming
 
 FastAPI-MCP uses the `operation_id` from your FastAPI routes as the MCP tool names. When you don't specify an `operation_id`, FastAPI auto-generates one, but these can be cryptic.
@@ -102,7 +94,6 @@ app = FastAPI()
 mcp = FastApiMCP(
     app,
     name="My API MCP",
-    base_url="http://localhost:8000",
     describe_all_responses=True,     # Include all possible response schemas in tool descriptions
     describe_full_response_schema=True  # Include full JSON schema in tool descriptions
 )
@@ -178,10 +169,7 @@ api_app = FastAPI()
 mcp_app = FastAPI()
 
 # Create MCP server from the API app
-mcp = FastApiMCP(
-    api_app,
-    base_url="http://api-host:8001",  # The URL where the API app will be running
-)
+mcp = FastApiMCP(api_app)
 
 # Mount the MCP server to the separate app
 mcp.mount(mcp_app)
@@ -215,6 +203,35 @@ async def new_endpoint():
 mcp.setup_server()
 ```
 
+### Communication with the FastAPI App
+
+FastAPI-MCP uses ASGI transport by default, which means it communicates directly with your FastAPI app without making HTTP requests. This is more efficient and doesn't require a base URL.
+
+It's not even necessary that the FastAPI server will run. See the examples folder for more.
+
+If you need to specify a custom base URL or use a different transport method, you can provide your own `httpx.AsyncClient`:
+
+```python
+import httpx
+from fastapi import FastAPI
+from fastapi_mcp import FastApiMCP
+
+app = FastAPI()
+
+# Use a custom HTTP client with a specific base URL
+custom_client = httpx.AsyncClient(
+    base_url="https://api.example.com",
+    timeout=30.0
+)
+
+mcp = FastApiMCP(
+    app,
+    http_client=custom_client
+)
+
+mcp.mount()
+```
+
 ## Examples
 
 See the [examples](examples) directory for complete examples.

README_zh-CN.md

@@ -22,6 +22,7 @@
 - **保留模式** - 保留您的请求模型和响应模型的模式
 - **保留文档** - 保留所有端点的文档，就像在 Swagger 中一样
 - **灵活部署** - 将 MCP 服务器挂载到同一应用，或单独部署
+- **ASGI 传输** - 默认使用 FastAPI 的 ASGI 接口直接通信，提高效率
 
 ## 安装
 
@@ -47,23 +48,14 @@ from fastapi_mcp import FastApiMCP
 
 app = FastAPI()
 
-mcp = FastApiMCP(
-    app,
-
-    # 可选参数
-    name="我的 API MCP",
-    description="我的 API 描述",
-    base_url="http://localhost:8000",
-)
+mcp = FastApiMCP(app)
 
 # 直接将 MCP 服务器挂载到您的 FastAPI 应用
 mcp.mount()
 ```
 
 就是这样！您的自动生成的 MCP 服务器现在可以在 `https://app.base.url/mcp` 访问。
 
-> **关于`base_url`的注意事项**：虽然`base_url`是可选的，但强烈建议您明确提供它。`base_url` 告诉 MCP 服务器在调用工具时向何处发送 API 请求。如果不提供，库将尝试自动确定 URL，这在部署环境中内部和外部 URL 不同时可能无法正确工作。
-
 ## 工具命名
 
 FastAPI-MCP 使用 FastAPI 路由中的`operation_id`作为 MCP 工具的名称。如果您不指定`operation_id`，FastAPI 会自动生成一个，但这些名称可能比较晦涩。
@@ -101,7 +93,6 @@ app = FastAPI()
 mcp = FastApiMCP(
     app,
     name="我的 API MCP",
-    base_url="http://localhost:8000",
     describe_all_responses=True,     # 在工具描述中包含所有可能的响应模式
     describe_full_response_schema=True  # 在工具描述中包含完整的 JSON 模式
 )
@@ -177,10 +168,7 @@ api_app = FastAPI()
 mcp_app = FastAPI()
 
 # 从 API 应用创建 MCP 服务器
-mcp = FastApiMCP(
-    api_app,
-    base_url="http://api-host:8001",  # API 应用将运行的 URL
-)
+mcp = FastApiMCP(api_app)
 
 # 将 MCP 服务器挂载到单独的应用
 mcp.mount(mcp_app)
@@ -214,6 +202,33 @@ async def new_endpoint():
 mcp.setup_server()
 ```
 
+### 与 FastAPI 应用的通信
+
+FastAPI-MCP 默认使用 ASGI 传输，这意味着它直接与您的 FastAPI 应用通信，而不需要发送 HTTP 请求。这样更高效，也不需要基础 URL。
+
+如果您需要指定自定义基础 URL 或使用不同的传输方法，您可以提供自己的 `httpx.AsyncClient`：
+
+```python
+import httpx
+from fastapi import FastAPI
+from fastapi_mcp import FastApiMCP
+
+app = FastAPI()
+
+# 使用带有特定基础 URL 的自定义 HTTP 客户端
+custom_client = httpx.AsyncClient(
+    base_url="https://api.example.com",
+    timeout=30.0
+)
+
+mcp = FastApiMCP(
+    app,
+    http_client=custom_client
+)
+
+mcp.mount()
+```
+
 ## 示例
 
 请参阅 [examples](examples) 目录以获取完整示例。

examples/filtered_tools_example.py

@@ -1,54 +1,53 @@
 from examples.shared.apps import items
 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(
-    items.app,
+    app,
     name="Item API MCP - Included Operations",
     description="MCP server showing only specific operations",
-    base_url="http://localhost:8000",
     include_operations=["get_item", "list_items"],
 )
 
 # Filter by excluding specific operation IDs
 exclude_operations_mcp = FastApiMCP(
-    items.app,
+    app,
     name="Item API MCP - Excluded Operations",
     description="MCP server showing all operations except the excluded ones",
-    base_url="http://localhost:8000",
     exclude_operations=["create_item", "update_item", "delete_item"],
 )
 
 # Filter by including specific tags
 include_tags_mcp = FastApiMCP(
-    items.app,
+    app,
     name="Item API MCP - Included Tags",
     description="MCP server showing operations with specific tags",
-    base_url="http://localhost:8000",
     include_tags=["items"],
 )
 
 # Filter by excluding specific tags
 exclude_tags_mcp = FastApiMCP(
-    items.app,
+    app,
     name="Item API MCP - Excluded Tags",
     description="MCP server showing operations except those with specific tags",
-    base_url="http://localhost:8000",
     exclude_tags=["search"],
 )
 
 # Combine operation IDs and tags (include mode)
 combined_include_mcp = FastApiMCP(
-    items.app,
+    app,
     name="Item API MCP - Combined Include",
     description="MCP server showing operations by combining include filters",
-    base_url="http://localhost:8000",
     include_operations=["delete_item"],
     include_tags=["search"],
 )
@@ -69,4 +68,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.app, host="0.0.0.0", port=8000)
+    uvicorn.run(items.router, host="0.0.0.0", port=8000)

examples/full_schema_description_example.py

@@ -1,17 +1,21 @@
 from examples.shared.apps import items
 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(
-    items.app,
+    app,
     name="Item API MCP",
     description="MCP server for the Item API",
-    base_url="http://localhost:8000",
     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
 )
@@ -22,4 +26,4 @@
 if __name__ == "__main__":
     import uvicorn
 
-    uvicorn.run(items.app, host="0.0.0.0", port=8000)
+    uvicorn.run(items.router, host="0.0.0.0", port=8000)

examples/mount_specific_router_example.py

@@ -1,28 +1,30 @@
 from examples.shared.apps import items
 from examples.shared.setup import setup_logging
 
-from fastapi import APIRouter
+from fastapi import FastAPI, APIRouter
 from fastapi_mcp import FastApiMCP
 
 setup_logging()
 
 
-router = APIRouter(prefix="/other/route")
-items.app.include_router(router)
+other_router = APIRouter(prefix="/other/route")
+
+app = FastAPI()
+app.include_router(items.router)
+app.include_router(other_router)
 
 mcp = FastApiMCP(
-    items.app,
+    app,
     name="Item API MCP",
     description="MCP server for the Item API",
-    base_url="http://localhost:8000",
 )
 
 # Mount the MCP server to a specific router.
 # It will now only be available at `/other/route/mcp`
-mcp.mount(router)
+mcp.mount(other_router)
 
 
 if __name__ == "__main__":
     import uvicorn
 
-    uvicorn.run(items.app, host="0.0.0.0", port=8000)
+    uvicorn.run(items.router, host="0.0.0.0", port=8000)

examples/reregister_tools_example.py

@@ -1,26 +1,26 @@
 from examples.shared.apps import items
 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(
-    items.app,
-    name="Item API MCP",
-    description="MCP server for the Item API",
-    base_url="http://localhost:8000",
-)
+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.app.get("/new/endpoint/", operation_id="new_endpoint", response_model=dict[str, str])
+@items.router.get("/new/endpoint/", operation_id="new_endpoint", response_model=dict[str, str])
 async def new_endpoint():
     return {"message": "Hello, world!"}
 
@@ -32,4 +32,4 @@ async def new_endpoint():
 if __name__ == "__main__":
     import uvicorn
 
-    uvicorn.run(items.app, host="0.0.0.0", port=8000)
+    uvicorn.run(items.router, host="0.0.0.0", port=8000)