Skip to content

Commit d506cc5

Browse files
authored
Update README.md (fixes #89)
1 parent 06c2af7 commit d506cc5

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,31 @@ A TypeScript framework for building [MCP](https://glama.ai/mcp) servers capable
2828
- [Roots](#roots-management)
2929
- CLI for [testing](#test-with-mcp-cli) and [debugging](#inspect-with-mcp-inspector)
3030

31+
## When to use FastMCP over the official SDK?
32+
33+
FastMCP is built on top of the official SDK.
34+
35+
The official SDK provides foundational blocks for building MCPs, but leaves many implementation details to you:
36+
37+
- [Initiating and configuring](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L664-L744) all the server components
38+
- [Handling of connections](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L760-L850)
39+
- [Handling of tools](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L1303-L1498)
40+
- [Handling of responses](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L989-L1060)
41+
- [Handling of resources](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L1151-L1242)
42+
- Adding [prompts](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L760-L850), [resources](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L960-L962), [resource templates](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L964-L987)
43+
- Embedding [resources](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L1569-L1643), [image](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L51-L111) and [audio](https://github.com/punkpeye/fastmcp/blob/06c2af7a3d7e3d8c638deac1964ce269ce8e518b/src/FastMCP.ts#L113-L173) content blocks
44+
45+
FastMCP eliminates this complexity by providing an opinionated framework that:
46+
47+
- Handles all the boilerplate automatically
48+
- Provides simple, intuitive APIs for common tasks
49+
- Includes built-in best practices and error handling
50+
- Lets you focus on your MCP's core functionality
51+
52+
**When to choose FastMCP:** You want to build MCP servers quickly without dealing with low-level implementation details.
53+
54+
**When to use the official SDK:** You need maximum control or have specific architectural requirements. In this case, we encourage referencing FastMCP's implementation to avoid common pitfalls.
55+
3156
## Installation
3257

3358
```bash

0 commit comments

Comments
 (0)