Jeremiah Lowin commited on
Commit
7c4c1b7
ยท
1 Parent(s): 05c049d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -7
README.md CHANGED
@@ -1,5 +1,5 @@
1
  <!-- omit in toc -->
2
- # FastMCP
3
 
4
  <div align="center">
5
 
@@ -7,17 +7,36 @@
7
  [![Tests](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml/badge.svg)](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml)
8
  [![License](https://img.shields.io/github/license/jlowin/fastmcp.svg)](https://github.com/jlowin/fastmcp/blob/main/LICENSE)
9
 
 
 
10
  </div>
11
 
12
- FastMCP is a high-level, intuitive framework for building [Model Context Protocol (MCP)](https://modelcontextprotocol.io) servers with Python. While MCP is a powerful protocol that enables LLMs to interact with local data and tools in a secure, standardized way, the specification can be cumbersome to implement directly. FastMCP lets you build fully compliant MCP servers in the most Pythonic way possible - in many cases, simply decorating a function is all that's required.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
 
14
- ๐Ÿšง *Note: FastMCP is under active development, as is the low-level MCP Python SDK* ๐Ÿ—๏ธ
15
 
16
  Key features:
17
- * **Intuitive**: Designed to feel familiar to Python developers, with powerful type hints and editor support
18
- * **Simple**: Build compliant MCP servers with minimal boilerplate
19
- * **Fast**: High-performance async implementation
20
- * **Full-featured**: Complete implementation of the MCP specification
 
 
21
 
22
  <!-- omit in toc -->
23
  ## Table of Contents
 
1
  <!-- omit in toc -->
2
+ # FastMCP ๐Ÿš€
3
 
4
  <div align="center">
5
 
 
7
  [![Tests](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml/badge.svg)](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml)
8
  [![License](https://img.shields.io/github/license/jlowin/fastmcp.svg)](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
+ Want to connect your LLMs to data and tools? FastMCP makes it simple!
15
+
16
+ In just a few lines of code, you can expose your functionality through a [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server:
17
+
18
+ ```python
19
+ from fastmcp import FastMCP
20
+
21
+ mcp = FastMCP("Demo ๐Ÿš€")
22
+
23
+ @mcp.tool()
24
+ def add(a: int, b: int) -> int:
25
+ """Add two numbers"""
26
+ return a + b
27
+ ```
28
+
29
+ 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.
30
 
31
+ ๐Ÿšจ ๐Ÿšง ๐Ÿ—๏ธ *FastMCP is under active development, as is the MCP specification itself. Core features are working but some advanced capabilities are still in progress.*
32
 
33
  Key features:
34
+ * **Fast**: High-level interface means less code and faster development
35
+ * **Simple**: Build MCP servers with minimal boilerplate
36
+ * **Pythonic**: Feels natural to Python developers
37
+ * **Complete***: FastMCP aims to provide a full implementation of the core MCP specification
38
+
39
+ (\*emphasis on *aims* during construction)
40
 
41
  <!-- omit in toc -->
42
  ## Table of Contents