add FAQ

Author: shiraayal-tadata

FAQ.md

@@ -0,0 +1,52 @@
+# Frequently Asked Questions (FAQ)
+
+## Usage
+### How do I configure HTTP request timeouts?
+By default, HTTP requests timeout after 5 seconds. If you have API endpoints that take longer to respond, you can configure a custom timeout by injecting your own httpx client. 
+
+For a working example, see [07_configure_http_timeout_example.py](examples/07_configure_http_timeout_example.py).
+
+### Why are my tools not showing up in the MCP inspector?
+If you add endpoints after creating and mounting the MCP server, they won't be automatically registered as tools. You need to either:
+1. Move the MCP creation after all your endpoint definitions
+2. Call `mcp.setup_server()` after adding new endpoints to re-register all tools
+
+For a working example, see [05_reregister_tools_example.py](examples/05_reregister_tools_example.py).
+
+### Can I add custom tools other than FastAPI endpoints?
+Currently, FastApiMCP only supports tools that are derived from FastAPI endpoints. If you need to add custom tools that don't correspond to API endpoints, you can:
+1. Create a FastAPI endpoint that wraps your custom functionality
+2. Contribute to the project by implementing custom tool support
+
+Follow the discussion in [issue #75](https://github.com/tadata-org/fastapi_mcp/issues/75) for updates on this feature request.
+If you have specific use cases for custom tools, please share them in the issue to help guide the implementation.
+
+### How do I test my FastApiMCP server is working?
+To verify your FastApiMCP server is working properly, you can use the MCP Inspector tool. Here's how:
+
+1. Start your FastAPI application
+2. Open a new terminal and run the MCP Inspector:
+   ```bash
+   npx @modelcontextprotocol/inspector node build/index.js
+   ```
+3. Connect to your MCP server by entering the mount path URL (default: `http://127.0.0.1:8000/mcp`)
+4. Navigate to the `Tools` section and click `List Tools` to see all available endpoints
+5. Test an endpoint by:
+   - Selecting a tool from the list
+   - Filling in any required parameters
+   - Clicking `Run Tool` to execute
+6. Check your server logs for additional debugging information if needed
+
+This will help confirm that your MCP server is properly configured and your endpoints are accessible.
+
+## Development
+
+### Can I contribute to the project?
+Yes! Please read our [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed guidelines on how to contribute to the project and where to start.
+
+## Support
+
+### Where can I get help?
+- Check the documentation
+- Open an issue on GitHub
+- Join our community chat [MCParty Slack community](https://join.slack.com/t/themcparty/shared_invite/zt-30yxr1zdi-2FG~XjBA0xIgYSYuKe7~Xg)

examples/03_custom_exposed_endpoints_example.py

@@ -1,5 +1,10 @@
 """
 This example shows how to customize exposing endpoints by filtering operation IDs and tags.
+Notes on filtering:
+- You cannot use both `include_operations` and `exclude_operations` at the same time
+- You cannot use both `include_tags` and `exclude_tags` at the same time
+- 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.apps.items import app
 from examples.shared.setup import setup_logging

examples/04_separate_server_example.py

@@ -1,5 +1,6 @@
 """
 This example shows how to run the MCP server and the FastAPI app separately.
+You can create an MCP server from one FastAPI app, and mount it to a different app.
 """
 from fastapi import FastAPI
 import asyncio