Skip to content

fix: Validate JSONRPCResponse in constructor (fixes #605) #658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −4
Open

fix: Validate JSONRPCResponse in constructor (fixes #605) #658

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions mcp-core/src/main/java/io/modelcontextprotocol/spec/McpSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,15 +250,19 @@ public record JSONRPCRequest( // @formatter:off
/**
* Constructor that validates MCP-specific ID requirements. Unlike base JSON-RPC,
* MCP requires that: (1) Requests MUST include a string or integer ID; (2) The ID
* MUST NOT be null
* MUST NOT be null.
*/
public JSONRPCRequest {
Assert.notNull(id, "MCP requests MUST include an ID - null IDs are not allowed");
Assert.isTrue(id instanceof String || id instanceof Integer || id instanceof Long,
"MCP requests MUST have an ID that is either a string or integer");
validateID(id);
}
}

private static void validateID(Object id) {
Assert.notNull(id, "MCP requests/responses MUST include an ID - null IDs are not allowed");
Assert.isTrue(id instanceof String || id instanceof Integer || id instanceof Long,
"MCP requests/responses MUST have an ID that is either a string or integer");
}

/**
* A notification which does not expect a response.
*
Expand Down Expand Up @@ -294,6 +298,16 @@ public record JSONRPCResponse( // @formatter:off
@JsonProperty("result") Object result,
@JsonProperty("error") JSONRPCError error) implements JSONRPCMessage { // @formatter:on

/**
* Constructor that validates (a) MCP-specific ID requirements (unlike base
* JSON-RPC, MCP requires that: (1) Requests MUST include a string or integer ID;
* (2) The ID MUST NOT be null.) and (b) that EITHER result OR error are non-null.
*/
public JSONRPCResponse {
validateID(id);
Assert.isTrue(result != null || error != null, "MCP responses MUST have EITHER a result OR an error");
}

/**
* A response to a request that indicates an error occurred.
*
Expand Down