Skip to content

Commit 8be91bf

Browse files
author
shiraayal-tadata
committed
add docs to readme
1 parent 5010cca commit 8be91bf

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
</div>
1313

14+
1415
<p align="center"><a href="https://github.com/tadata-org/fastapi_mcp"><img src="https://github.com/user-attachments/assets/b205adc6-28c0-4e3c-a68b-9c1a80eb7d0c" alt="fastapi-mcp-usage" height="400"/></a></p>
1516

1617

@@ -65,15 +66,7 @@ That's it! Your auto-generated MCP server is now available at `https://app.base.
6566

6667
## Documentation, Examples and Advanced Usage
6768

68-
FastAPI-MCP provides comprehensive documentation in the `docs` folder:
69-
- [Best Practices](docs/00_BEST_PRACTICES.md) - Essential guidelines for converting APIs to MCP tools safely and effectively
70-
- [FAQ](docs/00_FAQ.md) - Frequently asked questions about usage, development and support
71-
- [Tool Naming](docs/01_tool_naming.md) - Best practices for naming your MCP tools using operation IDs
72-
- [Connecting to MCP Server](docs/02_connecting_to_the_mcp_server.md) - How to connect various MCP clients like Cursor and Claude Desktop
73-
- [Authentication and Authorization](docs/03_authentication_and_authorization.md) - How to authenticate and authorize your MCP tools
74-
- [Advanced Usage](docs/04_advanced_usage.md) - Advanced features like custom schemas, endpoint filtering, and separate deployment
75-
76-
Check out the [examples directory](examples) for code samples demonstrating these features in action.
69+
FastAPI-MCP provides [comprehensive documentation](https://fastapi-mcp.tadata.com/). Additionaly, check out the [examples directory](examples) for code samples demonstrating these features in action.
7770

7871
## FastAPI-first Approach
7972

@@ -83,7 +76,7 @@ FastAPI-MCP is designed as a native extension of FastAPI, not just a converter t
8376

8477
- **ASGI transport**: Communicates directly with your FastAPI app using its ASGI interface, eliminating the need for HTTP calls from the MCP to your API
8578

86-
- **Unified infrastructure**: Your FastAPI app doesn't need to run separately from the MCP server (though [separate deployment](docs/04_advanced_usage.md#deploying-separately-from-original-fastapi-app) is also supported)
79+
- **Unified infrastructure**: Your FastAPI app doesn't need to run separately from the MCP server (though [separate deployment](https://fastapi-mcp.tadata.com/advanced/deploy#deploying-separately-from-original-fastapi-app) is also supported)
8780

8881
This design philosophy ensures minimum friction when adding MCP capabilities to your existing FastAPI services.
8982

0 commit comments

Comments
 (0)