Spaces:
Running
Running
Merge pull request #23 from jlowin/readme
Browse files
README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
| 1 |
<!-- omit in toc -->
|
| 2 |
-
# FastMCP
|
| 3 |
|
| 4 |
<div align="center">
|
| 5 |
|
|
@@ -7,17 +7,34 @@
|
|
| 7 |
[](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml)
|
| 8 |
[](https://github.com/jlowin/fastmcp/blob/main/LICENSE)
|
| 9 |
|
|
|
|
|
|
|
| 10 |
</div>
|
| 11 |
|
| 12 |
-
FastMCP
|
|
|
|
|
|
|
|
|
|
| 13 |
|
| 14 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 15 |
|
| 16 |
Key features:
|
| 17 |
-
* **
|
| 18 |
-
* **Simple**: Build
|
| 19 |
-
* **
|
| 20 |
-
* **
|
|
|
|
|
|
|
| 21 |
|
| 22 |
<!-- omit in toc -->
|
| 23 |
## Table of Contents
|
|
|
|
| 1 |
<!-- omit in toc -->
|
| 2 |
+
# FastMCP 🚀
|
| 3 |
|
| 4 |
<div align="center">
|
| 5 |
|
|
|
|
| 7 |
[](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml)
|
| 8 |
[](https://github.com/jlowin/fastmcp/blob/main/LICENSE)
|
| 9 |
|
| 10 |
+
A fast, Pythonic way to build Model Context Protocol servers
|
| 11 |
+
|
| 12 |
</div>
|
| 13 |
|
| 14 |
+
FastMCP makes building [Model Context Protocol (MCP)](https://modelcontextprotocol.io) servers simple and intuitive. Create tools, expose resources, and define prompts with clean, Pythonic code:
|
| 15 |
+
|
| 16 |
+
```python
|
| 17 |
+
from fastmcp import FastMCP
|
| 18 |
|
| 19 |
+
mcp = FastMCP("Demo 🚀")
|
| 20 |
+
|
| 21 |
+
@mcp.tool()
|
| 22 |
+
def add(a: int, b: int) -> int:
|
| 23 |
+
"""Add two numbers"""
|
| 24 |
+
return a + b
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
That's it! FastMCP handles all the complex protocol details and server management, so you can focus on building great tools. It's designed to be high-level and Pythonic - in most cases, decorating a function is all you need.
|
| 28 |
+
|
| 29 |
+
🚨 🚧 🏗️ *FastMCP is under active development, as is the MCP specification itself. Core features are working but some advanced capabilities are still in progress.*
|
| 30 |
|
| 31 |
Key features:
|
| 32 |
+
* **Fast**: High-level interface means less code and faster development
|
| 33 |
+
* **Simple**: Build MCP servers with minimal boilerplate
|
| 34 |
+
* **Pythonic**: Feels natural to Python developers
|
| 35 |
+
* **Complete***: FastMCP aims to provide a full implementation of the core MCP specification
|
| 36 |
+
|
| 37 |
+
(\*emphasis on *aims* during construction)
|
| 38 |
|
| 39 |
<!-- omit in toc -->
|
| 40 |
## Table of Contents
|
uv.lock
CHANGED
|
@@ -228,7 +228,7 @@ wheels = [
|
|
| 228 |
|
| 229 |
[[package]]
|
| 230 |
name = "fastmcp"
|
| 231 |
-
version = "0.
|
| 232 |
source = { editable = "." }
|
| 233 |
dependencies = [
|
| 234 |
{ name = "httpx" },
|
|
|
|
| 228 |
|
| 229 |
[[package]]
|
| 230 |
name = "fastmcp"
|
| 231 |
+
version = "0.3.1.dev3+g35b0931.d20241201"
|
| 232 |
source = { editable = "." }
|
| 233 |
dependencies = [
|
| 234 |
{ name = "httpx" },
|