alihan/fastapi_mcp
1
0
Fork 0
mirror of https://github.com/tadata-org/fastapi_mcp.git synced 2025-04-13 23:32:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #22 from shiraayal-tadata/readme-modification

Browse Source 
Readme modification
This commit is contained in:
shiraayal-tadata
2025-03-25 16:44:47 +02:00
committed by GitHub
parent 2ff9309c20 0330e7f4b7
commit 8753db3bba
2 changed files with 23 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@@ -7,13 +7,20 @@ First off, thank you for considering contributing to FastAPI-MCP!
1. Make sure you have Python 3.10+ installed
2. Install [uv](https://docs.astral.sh/uv/getting-started/installation/) (recommended) or pip
3. Fork the repository
4. Clone your fork and set up the development environment:
4. Clone your fork
```bash
# Clone your fork
git clone https://github.com/YOUR-USERNAME/fastapi_mcp.git
cd fastapi-mcp
# Add the upstream remote
git remote add upstream https://github.com/tadata-org/fastapi_mcp.git
```
5. Set up the development environment:
```bash
# Create a virtual environment with uv (recommended)
uv venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
@@ -29,7 +36,7 @@ uv sync --extra dev
## Development Process
1. Fork the repository
1. Fork the repository and set the upstream remote
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Make your changes
4. Run type checking (`uv run mypy .`)
@@ -37,7 +44,7 @@ uv sync --extra dev
6. Format your code (`uv run ruff check .` and `uv run ruff format .`)
7. Commit your changes (`git commit -m 'Add some amazing feature'`)
8. Push to the branch (`git push origin feature/amazing-feature`)
9. Open a Pull Request
9. Open a Pull Request on [the project repository](https://github.com/tadata-org/fastapi_mcp/)
## Code Style

32
README.md
View File

@@ -1,9 +1,17 @@
# FastAPI-MCP
A zero-configuration tool for automatically exposing FastAPI endpoints as Model Context Protocol (MCP) tools.
<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>
<h1 align="center">FastAPI-MCP</h1>
<p align="center">A zero-configuration tool for automatically exposing FastAPI endpoints as Model Context Protocol (MCP) tools.</p>
<div align="center">
[![PyPI version](https://badge.fury.io/py/fastapi-mcp.svg)](https://pypi.org/project/fastapi-mcp/)
[![Python Versions](https://img.shields.io/pypi/pyversions/fastapi-mcp.svg)](https://pypi.org/project/fastapi-mcp/)
[![FastAPI](https://img.shields.io/badge/FastAPI-009485.svg?logo=fastapi&logoColor=white)](#)
![](https://badge.mcpx.dev?type=dev 'MCP Dev')
</div>
<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>
## Features
@@ -127,23 +135,9 @@ Find the path to mcp-proxy by running in Terminal: `which mcp-proxy`.
## Development and Contributing
If you're interested in contributing to FastAPI-MCP:
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.
```bash
# Clone the repository
git clone https://github.com/tadata-org/fastapi_mcp.git
cd fastapi_mcp
# Create a virtual environment and install dependencies with uv
uv venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
uv sync --extra dev
# Run tests
uv run pytest
```
For more details about contributing, see [CONTRIBUTING.md](CONTRIBUTING.md).
Before you get started, please see [CONTRIBUTING.md](CONTRIBUTING.md).
## Community