Durable Model Context Protocol (MCP) helpers for building resumable MCP servers on top of Reboot durable workflows.
Project description
Reboot Durable MCP
A framework for building durable MCP servers.
-
Takes advantage of the protocols ability to resume after disconnection, e.g., due to the server getting rebooted.
-
Any existing requests will be retried safely using Reboot workflows.
-
Using Reboot you can run multiple replicas of your server, and session messages will always be routed to the same replica.
Requirements
- macOS or Linux
- Python >= 3.12.11
- Docker
Install
We recommend using uv, as it will manage the version of Python for
you. For example, to start a new project in the directory foo:
uv init --python 3.12.11 .
uv add durable-mcp
Activate the venv:
source .venv/bin/activate
Make sure you have Docker running:
docker ps
Building an MCP server
Instead of using FastMCP from the MCP SDK, you use
DurableMCP. Here is a simple server to get you started:
import asyncio
from reboot.aio.applications import Application
from reboot.mcp.server import DurableContext, DurableMCP
from reboot.std.collections.v1.sorted_map import SortedMap
# `DurableMCP` server which will handle HTTP requests at path "/mcp".
mcp = DurableMCP(path="/mcp")
@mcp.tool()
async def add(a: int, b: int, context: DurableContext) -> int:
"""Add two numbers and also store result in `SortedMap`."""
result = a + b
await SortedMap.ref("adds").insert(
context,
entries={f"{a} + {b}": f"{result}".encode()},
)
return result
async def main():
# Reboot application that runs everything necessary for `DurableMCP`.
await mcp.application().run()
if __name__ == '__main__':
asyncio.run(main())
You can run the server via:
rbt dev run --python --application=path/to/main.py --working-directory=. --no-generate-watch
While developing you can tell rbt to restart your server when you
modify files by adding one or more --watch=path/to/**/*.py to the
above command line.
We recommend you move all of your command line args to a .rbtrc:
# This file will aggregate all of the command line args
# into a single command line that will be run when you
# use `rbt`.
#
# For example, to add args for running `rbt dev run`
# you can add lines that start with `dev run`. You can add
# one or more args to each line.
dev run --no-generate-watch
dev run --python --application=path/to/your/main.py
dev run --watch=path/to/**/*.py --watch=different/path/to/**/*.py
Then you can just run:
rbt dev run
Testing your MCP server
You can use the MCP Inspector to test out the server, or create a simple client.
import asyncio
from reboot.mcp.client import connect, reconnect
URL = "http://localhost:9991"
async def main():
# `connect()` is a helper that creates a streamable HTTP client
# and session using the MCP SDK. You can also write a client that
# directly uses the MCP SDK, or use any other MCP client library!
async with connect(URL + "/mcp") as (
session, session_id, protocol_version
):
print(await session.list_tools())
print(await session.call_tool("add", arguments={"a": 5, "b": 3}))
if __name__ == '__main__':
asyncio.run(main())
Performing a side-effect "at least once"
Within your tools (and soon within your prompts and resources too),
you can perform a side-effect that is safe to try one or more times
until success using at_least_once. Usually what makes it safe to
perform one or more times is that you can somehow do it
idempotently, e.g., passing an idempotency key as part of an API
call. Use at_least_once for this, for example:
from reboot.aio.workflows import at_least_once
from reboot.mcp.server import DurableContext, DurableMCP
# `DurableMCP` server which will handle HTTP requests at path "/mcp".
mcp = DurableMCP(path="/mcp")
@mcp.tool()
async def add(a: int, b: int, context: DurableContext) -> int:
async def do_side_effect_idempotently() -> int:
"""
Pretend that we are doing a side-effect that we can try
more than once because we can do it idempotently, hence using
`at_least_once`.
"""
return a + b
result = await at_least_once(
"Do side-effect _idempotently_",
context,
do_side_effect_idempotently,
type=int,
)
# ...
Performing a side-effect "at most once"
Within your tools (and soon within your prompts and resources too),
you can perform a side-effect that can only be tried once using
at_most_once (if you can safely use at_least_once always prefer
it). Here's an example of at_most_once:
from reboot.aio.workflows import at_least_once
from reboot.mcp.server import DurableContext, DurableMCP
# `DurableMCP` server which will handle HTTP requests at path "/mcp".
mcp = DurableMCP(path="/mcp")
@mcp.tool()
async def add(a: int, b: int, context: DurableContext) -> int:
async def do_side_effect() -> int:
"""
Pretend that we are doing a side-effect that we can only
try to do once because it is not able to be performed
idempotently, hence using `at_most_once`.
"""
return a + b
# NOTE: if we reboot, e.g., due to a hardware failure, within
# `do_side_effect()` then `at_most_once` will forever raise with
# `AtMostOnceFailedBeforeCompleting` and you will need to handle
# appropriately.
result = await at_most_once(
"Do side-effect",
context,
do_side_effect,
type=int,
)
# ...
Debugging
Start by enabling debug logging:
mcp = DurableMCP(path="/mcp", log_level="DEBUG")
The MCP SDK is aggressive about "swallowing" errors on the server side
and just returning "request failed" so we do our best to log stack
traces on the server. If you find a place where you've needed to add
your own try/catch please let us know we'd love to log that for
you automatically.
Supported client --> server requests:
-
initialize -
tools/call -
tools/list -
prompts/get -
prompts/list -
resources/list -
resources/read -
resources/templates/list -
resources/subscribe -
resources/unsubscribe -
completion/complete -
logging/setLevel
Supported client --> server notifications:
-
notifications/initialized -
notifications/progress(for server initiated requests, e.g., elicitation) -
notifications/roots/list_changed
Supported client <-- server requests:
-
elicitation/create -
roots/list -
sampling/createMessage
Supported client <-- server notifications:
-
notifications/progress -
notifications/message -
notifications/prompts/list_changed -
notifications/resources/list_changed -
notifications/tools/list_changed -
notifications/resources/updated
Supported client <--> server notifications:
-
notifications/cancelled
TODO:
- Auth pass through to MCP SDK
- Adding tools, resources, and prompts dynamically
- Add examples of how to test via
Reboot().start/up/down/stop() - Add example of rebooting server using MCP Inspector version 0.16.7 which includes modelcontextprotocol/inspector#787
-
yapf - Pydantic
statefor each session
Contributing
First grab all dependencies:
uv sync
Activate the venv:
source .venv/bin/activate
Generate code:
rbt generate
Make sure you have Docker running:
docker ps
Make your changes and run the tests:
pytest tests
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file durable_mcp-0.5.0.tar.gz.
File metadata
- Download URL: durable_mcp-0.5.0.tar.gz
- Upload date:
- Size: 103.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e79ef362ec5a908cb075054e658c7d7c537e532ad4e68647e7e73d37ddef6b8e
|
|
| MD5 |
eb10b2e882924296abe491f1ebad3265
|
|
| BLAKE2b-256 |
81e2e5cf2dd1db60eb874b2ca71f4a40025347dd2ecdd8d1f67c16339ff31058
|
File details
Details for the file durable_mcp-0.5.0-py3-none-any.whl.
File metadata
- Download URL: durable_mcp-0.5.0-py3-none-any.whl
- Upload date:
- Size: 121.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
416962906f664891de45b2996114331a971961c41d225bcafbf0ab1c721f9708
|
|
| MD5 |
aee8d06518085eaffefeb139d64fb04f
|
|
| BLAKE2b-256 |
a6333943b003b8b28f392f79c932013542172e5ed249c2e4a8348f8601bda949
|