Skip to content

protocol

protocol

MCP JSON-RPC 2.0 protocol message types.

Classes

MCPRequest dataclass 

MCPRequest(method: str, params: Dict[str, Any] = dict(), id: Optional[int | str] = 0, jsonrpc: str = '2.0')

JSON-RPC 2.0 request message.

Set id to None to create a JSON-RPC notification (no id field will appear in the serialized output, and no response is expected).

Functions
to_dict 
to_dict() -> Dict[str, Any]

Return a dict suitable for JSON serialization.

Omits the id key when it is None (notification).

Source code in src/openjarvis/mcp/protocol.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
def to_dict(self) -> Dict[str, Any]:
    """Return a dict suitable for JSON serialization.

    Omits the ``id`` key when it is ``None`` (notification).
    """
    obj: Dict[str, Any] = {
        "jsonrpc": self.jsonrpc,
        "method": self.method,
        "params": self.params,
    }
    if self.id is not None:
        obj["id"] = self.id
    return obj
to_json 
to_json() -> str

Serialize to JSON string.

Source code in src/openjarvis/mcp/protocol.py 
44
45
46
def to_json(self) -> str:
    """Serialize to JSON string."""
    return json.dumps(self.to_dict())
from_json classmethod 
from_json(data: str) -> MCPRequest

Deserialize from JSON string.

Source code in src/openjarvis/mcp/protocol.py 
48
49
50
51
52
53
54
55
56
57
@classmethod
def from_json(cls, data: str) -> MCPRequest:
    """Deserialize from JSON string."""
    parsed = json.loads(data)
    return cls(
        method=parsed["method"],
        params=parsed.get("params", {}),
        id=parsed.get("id", 0),
        jsonrpc=parsed.get("jsonrpc", "2.0"),
    )

MCPResponse dataclass 

MCPResponse(result: Any = None, error: Optional[Dict[str, Any]] = None, id: int | str = 0, jsonrpc: str = '2.0')

JSON-RPC 2.0 response message.

Functions
to_json 
to_json() -> str

Serialize to JSON string.

Source code in src/openjarvis/mcp/protocol.py 
69
70
71
72
73
74
75
76
def to_json(self) -> str:
    """Serialize to JSON string."""
    obj: Dict[str, Any] = {"jsonrpc": self.jsonrpc, "id": self.id}
    if self.error is not None:
        obj["error"] = self.error
    else:
        obj["result"] = self.result
    return json.dumps(obj)
from_json classmethod 
from_json(data: str) -> MCPResponse

Deserialize from JSON string.

Source code in src/openjarvis/mcp/protocol.py 
78
79
80
81
82
83
84
85
86
87
@classmethod
def from_json(cls, data: str) -> MCPResponse:
    """Deserialize from JSON string."""
    parsed = json.loads(data)
    return cls(
        result=parsed.get("result"),
        error=parsed.get("error"),
        id=parsed.get("id", 0),
        jsonrpc=parsed.get("jsonrpc", "2.0"),
    )
error_response classmethod 
error_response(id: int | str, code: int, message: str, data: Any = None) -> MCPResponse

Create an error response.

Source code in src/openjarvis/mcp/protocol.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
@classmethod
def error_response(
    cls,
    id: int | str,
    code: int,
    message: str,
    data: Any = None,
) -> MCPResponse:
    """Create an error response."""
    error: Dict[str, Any] = {"code": code, "message": message}
    if data is not None:
        error["data"] = data
    return cls(error=error, id=id)

MCPNotification dataclass 

MCPNotification(method: str, params: Dict[str, Any] = dict(), jsonrpc: str = '2.0')

JSON-RPC 2.0 notification (no id, no response expected).

Functions
to_json 
to_json() -> str

Serialize to JSON string.

Source code in src/openjarvis/mcp/protocol.py 
112
113
114
115
116
117
118
119
120
def to_json(self) -> str:
    """Serialize to JSON string."""
    return json.dumps(
        {
            "jsonrpc": self.jsonrpc,
            "method": self.method,
            "params": self.params,
        }
    )

MCPError dataclass 

MCPError(code: int, message: str, data: Any = None)

Bases: Exception

MCP protocol error with JSON-RPC error code.