Skip to content

Commit bda9dc6

Browse files
author
shiraayal-tadata
committed
readme modification
1 parent 2ff9309 commit bda9dc6

File tree

1 file changed

+11
-19
lines changed

1 file changed

+11
-19
lines changed

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1-
# FastAPI-MCP
2-
3-
A zero-configuration tool for automatically exposing FastAPI endpoints as Model Context Protocol (MCP) tools.
1+
<p align="center"><a href="https://github.com/tadata-org/fastapi_mcp"><img src="https://github.com/user-attachments/assets/609d5b8b-37a1-42c4-87e2-f045b60026b1" alt="fastapi-to-mcp" height="100"/></a></p>
2+
<h1 align="center">FastAPI-MCP</h1>
3+
<p align="center">A zero-configuration tool for automatically exposing FastAPI endpoints as Model Context Protocol (MCP) tools.</p>
4+
<div align="center">
45

56
[![PyPI version](https://badge.fury.io/py/fastapi-mcp.svg)](https://pypi.org/project/fastapi-mcp/)
67
[![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-mcp.svg)](https://pypi.org/project/fastapi-mcp/)
78

9+
</div>
10+
11+
<p align="center"><a href="https://github.com/tadata-org/fastapi_mcp"><img src="https://github.com/user-attachments/assets/1cba1bf2-2fa4-46c7-93ac-1e9bb1a95257" alt="fastapi-mcp-usage" height="400"/></a></p>
12+
13+
814
## Features
915

1016
- **Direct integration** - Mount an MCP server directly to your FastAPI app
@@ -127,23 +133,9 @@ Find the path to mcp-proxy by running in Terminal: `which mcp-proxy`.
127133

128134
## Development and Contributing
129135

130-
If you're interested in contributing to FastAPI-MCP:
131-
132-
```bash
133-
# Clone the repository
134-
git clone https://github.com/tadata-org/fastapi_mcp.git
135-
cd fastapi_mcp
136-
137-
# Create a virtual environment and install dependencies with uv
138-
uv venv
139-
source .venv/bin/activate # On Windows: .venv\Scripts\activate
140-
uv sync --extra dev
141-
142-
# Run tests
143-
uv run pytest
144-
```
136+
Thank you for considering contributing to FastAPI-MCP open source projects! It’s people like you that make it a reality for users in our community.
145137

146-
For more details about contributing, see [CONTRIBUTING.md](CONTRIBUTING.md).
138+
Before you get started, please see [CONTRIBUTING.md](CONTRIBUTING.md).
147139

148140
## Community
149141

0 commit comments

Comments
 (0)