Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mcp-use.com/llms.txt

Use this file to discover all available pages before exploring further.

View the source code for this module on GitHub: https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/server/middleware/middleware.py

​
CallNext

from mcp_use.server.middleware.middleware import CallNext

​
method init

Parameters
​
args
required
Parameter value
​
kwargs
required
Parameter value
Signature
def __init__(args, kwargs):

​
method call

Parameters
​
context
ServerMiddlewareContext[T]
required
Parameter value
Returns
​
returns
Awaitable[R]
Signature
def __call__(context: ServerMiddlewareContext[T]):

​
Middleware

from mcp_use.server.middleware.middleware import Middleware

​
method call

Parameters
​
context
ServerMiddlewareContext[T]
required
Parameter value
​
call_next
CallNext[T, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def __call__(context: ServerMiddlewareContext[T], call_next: CallNext[T, Any]):

​
method on_call_tool

Parameters
​
context
ServerMiddlewareContext[CallToolRequestParams]
required
Parameter value
​
call_next
CallNext[CallToolRequestParams, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_call_tool(
context: ServerMiddlewareContext[CallToolRequestParams],
    call_next: CallNext[CallToolRequestParams,
    Any]
):

​
method on_complete

Parameters
​
context
ServerMiddlewareContext[CompleteRequestParams]
required
Parameter value
​
call_next
CallNext[CompleteRequestParams, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_complete(
context: ServerMiddlewareContext[CompleteRequestParams],
    call_next: CallNext[CompleteRequestParams,
    Any]
):

​
method on_get_prompt

Parameters
​
context
ServerMiddlewareContext[GetPromptRequestParams]
required
Parameter value
​
call_next
CallNext[GetPromptRequestParams, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_get_prompt(
context: ServerMiddlewareContext[GetPromptRequestParams],
    call_next: CallNext[GetPromptRequestParams,
    Any]
):

​
method on_initialize

Parameters
​
context
ServerMiddlewareContext[InitializeRequestParams]
required
Parameter value
​
call_next
CallNext[InitializeRequestParams, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_initialize(
context: ServerMiddlewareContext[InitializeRequestParams],
    call_next: CallNext[InitializeRequestParams,
    Any]
):

​
method on_list_prompts

Parameters
​
context
ServerMiddlewareContext[PaginatedRequestParams | None]
required
Parameter value
​
call_next
CallNext[PaginatedRequestParams | None, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_list_prompts(
context: ServerMiddlewareContext[PaginatedRequestParams | None],
    call_next: CallNext[PaginatedRequestParams | None,
    Any]
):

​
method on_list_resources

Parameters
​
context
ServerMiddlewareContext[PaginatedRequestParams | None]
required
Parameter value
​
call_next
CallNext[PaginatedRequestParams | None, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_list_resources(
context: ServerMiddlewareContext[PaginatedRequestParams | None],
    call_next: CallNext[PaginatedRequestParams | None,
    Any]
):

​
method on_list_tools

Parameters
​
context
ServerMiddlewareContext[PaginatedRequestParams | None]
required
Parameter value
​
call_next
CallNext[PaginatedRequestParams | None, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_list_tools(
context: ServerMiddlewareContext[PaginatedRequestParams | None],
    call_next: CallNext[PaginatedRequestParams | None,
    Any]
):

​
method on_read_resource

Parameters
​
context
ServerMiddlewareContext[ReadResourceRequestParams]
required
Parameter value
​
call_next
CallNext[ReadResourceRequestParams, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_read_resource(
context: ServerMiddlewareContext[ReadResourceRequestParams],
    call_next: CallNext[ReadResourceRequestParams,
    Any]
):

​
method on_request

Parameters
​
context
ServerMiddlewareContext[Any]
required
Parameter value
​
call_next
CallNext[Any, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_request(context: ServerMiddlewareContext[Any], call_next: CallNext[Any, Any]):

​
method on_set_logging_level

Parameters
​
context
ServerMiddlewareContext[SetLevelRequestParams]
required
Parameter value
​
call_next
CallNext[SetLevelRequestParams, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_set_logging_level(
context: ServerMiddlewareContext[SetLevelRequestParams],
    call_next: CallNext[SetLevelRequestParams,
    Any]
):

​
method on_subscribe_resource

Parameters
​
context
ServerMiddlewareContext[SubscribeRequestParams]
required
Parameter value
​
call_next
CallNext[SubscribeRequestParams, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_subscribe_resource(
context: ServerMiddlewareContext[SubscribeRequestParams],
    call_next: CallNext[SubscribeRequestParams,
    Any]
):

​
method on_unsubscribe_resource

Parameters
​
context
ServerMiddlewareContext[UnsubscribeRequestParams]
required
Parameter value
​
call_next
CallNext[UnsubscribeRequestParams, Any]
required
Parameter value
Returns
​
returns
Any
Signature
def on_unsubscribe_resource(
context: ServerMiddlewareContext[UnsubscribeRequestParams],
    call_next: CallNext[UnsubscribeRequestParams,
    Any]
):

​
MiddlewareManager

from mcp_use.server.middleware.middleware import MiddlewareManager

​
method init

Signature
def __init__():

​
method add_middleware

Parameters
​
middleware
Middleware
required
Middleware instance
Signature
def add_middleware(middleware: Middleware):

​
method process_request

Parameters
​
context
ServerMiddlewareContext[Any]
required
Parameter value
​
handler
Callable[[ServerMiddlewareContext[Any]], Awaitable[Any]]
required
Parameter value
Returns
​
returns
Any
Signature
def process_request(
context: ServerMiddlewareContext[Any],
    handler: Callable[[ServerMiddlewareContext[Any]],
    Awaitable[Any]]
):

​
ServerMiddlewareContext

from mcp_use.server.middleware.middleware import ServerMiddlewareContext

Attributes
​
message
T
required
Parameter value
​
method
str
required
String value
​
timestamp
datetime
required
Parameter value
​
transport
str
required
String value
​
session_id
str | None
required
MCP session instance
​
headers
dict[str, str] | None
required
Dictionary of key-value pairs
​
client_ip
str | None
required
MCP client instance
​
metadata
dict[str, Any]
required
Dictionary of key-value pairs

​
method init

Parameters
​
message
T
required
Parameter value
​
method
str
required
String value
​
timestamp
datetime
required
Parameter value
​
transport
str
required
String value
​
session_id
str | None
default:"None"
MCP session instance
​
headers
dict[str, str] | None
default:"None"
Dictionary of key-value pairs
​
client_ip
str | None
default:"None"
MCP client instance
​
metadata
dict[str, Any]
default:"<factory>"
Dictionary of key-value pairs
Signature
def __init__(message: T, method: str, timestamp: datetime, transport: str, session_id: str | None = None, headers: dict[str, str] | None = None, client_ip: str | None = None, metadata: dict[str, Any] = <factory>):

​
method copy

Parameters
​
kwargs
Any
required
Parameter value
Returns
​
returns
ServerMiddlewareContext[T]
Signature
def copy(kwargs: Any):

​
ServerResponseContext

from mcp_use.server.middleware.middleware import ServerResponseContext

Attributes
​
result
R | None
required
Parameter value
​
error
Exception | None
required
Parameter value
​
metadata
dict[str, Any]
required
Dictionary of key-value pairs

​
method init

Parameters
​
result
R | None
default:"None"
Parameter value
​
error
Exception | None
default:"None"
Parameter value
​
metadata
dict[str, Any]
default:"<factory>"
Dictionary of key-value pairs
Signature
def __init__(result: R | None = None, error: Exception | None = None, metadata: dict[str, Any] = <factory>):