Spaces:
Running
Running
zzstoatzz commited on
Commit ·
944f3fc
1
Parent(s): 161e1b2
add contrib section to README
Browse files
README.md
CHANGED
|
@@ -69,6 +69,7 @@ FastMCP handles all the complex protocol details and server management, so you c
|
|
| 69 |
- [Examples](#examples)
|
| 70 |
- [Echo Server](#echo-server)
|
| 71 |
- [SQLite Explorer](#sqlite-explorer)
|
|
|
|
| 72 |
|
| 73 |
## Installation
|
| 74 |
|
|
@@ -83,6 +84,8 @@ Or with pip:
|
|
| 83 |
pip install fastmcp
|
| 84 |
```
|
| 85 |
|
|
|
|
|
|
|
| 86 |
## Quickstart
|
| 87 |
|
| 88 |
Let's create a simple MCP server that exposes a calculator tool and some data:
|
|
@@ -425,3 +428,73 @@ Schema:
|
|
| 425 |
|
| 426 |
What insights can you provide about the structure and relationships?"""
|
| 427 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 69 |
- [Examples](#examples)
|
| 70 |
- [Echo Server](#echo-server)
|
| 71 |
- [SQLite Explorer](#sqlite-explorer)
|
| 72 |
+
- [Contributing](#contributing)
|
| 73 |
|
| 74 |
## Installation
|
| 75 |
|
|
|
|
| 84 |
pip install fastmcp
|
| 85 |
```
|
| 86 |
|
| 87 |
+
See the [Contributing](#contributing) section for information on how to contribute to FastMCP.
|
| 88 |
+
|
| 89 |
## Quickstart
|
| 90 |
|
| 91 |
Let's create a simple MCP server that exposes a calculator tool and some data:
|
|
|
|
| 428 |
|
| 429 |
What insights can you provide about the structure and relationships?"""
|
| 430 |
```
|
| 431 |
+
|
| 432 |
+
## Contributing
|
| 433 |
+
|
| 434 |
+
<details>
|
| 435 |
+
|
| 436 |
+
<summary>Development Guide</summary>
|
| 437 |
+
|
| 438 |
+
### Development Guide
|
| 439 |
+
|
| 440 |
+
#### Prerequisites
|
| 441 |
+
|
| 442 |
+
FastMCP requires Python 3.10+.
|
| 443 |
+
|
| 444 |
+
#### Installation
|
| 445 |
+
|
| 446 |
+
Clone a fork of the repository and install the dependencies:
|
| 447 |
+
|
| 448 |
+
|
| 449 |
+
git clone https://github.com/youFancyUserYou/fastmcp.git
|
| 450 |
+
cd fastmcp
|
| 451 |
+
Activate a virtual environment:
|
| 452 |
+
|
| 453 |
+
|
| 454 |
+
```bash
|
| 455 |
+
uv venv
|
| 456 |
+
source .venv/bin/activate
|
| 457 |
+
uv sync --frozen --all-extras --dev
|
| 458 |
+
```
|
| 459 |
+
|
| 460 |
+
#### Install the pre-commit hooks:
|
| 461 |
+
|
| 462 |
+
```bash
|
| 463 |
+
pre-commit install
|
| 464 |
+
```
|
| 465 |
+
|
| 466 |
+
#### Testing
|
| 467 |
+
|
| 468 |
+
Run the tests:
|
| 469 |
+
|
| 470 |
+
|
| 471 |
+
```bash
|
| 472 |
+
pytest -vv
|
| 473 |
+
```
|
| 474 |
+
|
| 475 |
+
|
| 476 |
+
#### Opening a Pull Request
|
| 477 |
+
|
| 478 |
+
Fork the repository and create a new branch:
|
| 479 |
+
|
| 480 |
+
```bash
|
| 481 |
+
git checkout -b my-branch
|
| 482 |
+
```
|
| 483 |
+
|
| 484 |
+
Make your changes and commit them:
|
| 485 |
+
|
| 486 |
+
|
| 487 |
+
```bash
|
| 488 |
+
git add . && git commit -m "My changes"
|
| 489 |
+
```
|
| 490 |
+
|
| 491 |
+
Push your changes to your fork:
|
| 492 |
+
|
| 493 |
+
|
| 494 |
+
```bash
|
| 495 |
+
git push origin my-branch
|
| 496 |
+
```
|
| 497 |
+
|
| 498 |
+
Feel free to reach out in a GitHub Issue or Discussions if you have any questions!
|
| 499 |
+
|
| 500 |
+
</details>
|