Merge pull request #207 from keisku/add-Accept-header-validation
Add Accept header validation
This commit is contained in:
commit
b92dbe4c28
5 changed files with 313 additions and 2 deletions
|
|
@ -3,6 +3,8 @@
|
||||||
module MCP
|
module MCP
|
||||||
class Client
|
class Client
|
||||||
class HTTP
|
class HTTP
|
||||||
|
ACCEPT_HEADER = "application/json, text/event-stream"
|
||||||
|
|
||||||
attr_reader :url
|
attr_reader :url
|
||||||
|
|
||||||
def initialize(url:, headers: {})
|
def initialize(url:, headers: {})
|
||||||
|
|
@ -14,7 +16,9 @@ module MCP
|
||||||
method = request[:method] || request["method"]
|
method = request[:method] || request["method"]
|
||||||
params = request[:params] || request["params"]
|
params = request[:params] || request["params"]
|
||||||
|
|
||||||
client.post("", request).body
|
response = client.post("", request)
|
||||||
|
validate_response_content_type!(response, method, params)
|
||||||
|
response.body
|
||||||
rescue Faraday::BadRequestError => e
|
rescue Faraday::BadRequestError => e
|
||||||
raise RequestHandlerError.new(
|
raise RequestHandlerError.new(
|
||||||
"The #{method} request is invalid",
|
"The #{method} request is invalid",
|
||||||
|
|
@ -70,6 +74,7 @@ module MCP
|
||||||
faraday.response(:json)
|
faraday.response(:json)
|
||||||
faraday.response(:raise_error)
|
faraday.response(:raise_error)
|
||||||
|
|
||||||
|
faraday.headers["Accept"] = ACCEPT_HEADER
|
||||||
headers.each do |key, value|
|
headers.each do |key, value|
|
||||||
faraday.headers[key] = value
|
faraday.headers[key] = value
|
||||||
end
|
end
|
||||||
|
|
@ -83,6 +88,17 @@ module MCP
|
||||||
"Add it to your Gemfile: gem 'faraday', '>= 2.0'" \
|
"Add it to your Gemfile: gem 'faraday', '>= 2.0'" \
|
||||||
"See https://rubygems.org/gems/faraday for more details."
|
"See https://rubygems.org/gems/faraday for more details."
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def validate_response_content_type!(response, method, params)
|
||||||
|
content_type = response.headers["Content-Type"]
|
||||||
|
return if content_type&.include?("application/json")
|
||||||
|
|
||||||
|
raise RequestHandlerError.new(
|
||||||
|
"Unsupported Content-Type: #{content_type.inspect}. This client only supports JSON responses.",
|
||||||
|
{ method: method, params: params },
|
||||||
|
error_type: :unsupported_media_type,
|
||||||
|
)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
||||||
|
|
@ -17,6 +17,9 @@ module MCP
|
||||||
@stateless = stateless
|
@stateless = stateless
|
||||||
end
|
end
|
||||||
|
|
||||||
|
REQUIRED_POST_ACCEPT_TYPES = ["application/json", "text/event-stream"].freeze
|
||||||
|
REQUIRED_GET_ACCEPT_TYPES = ["text/event-stream"].freeze
|
||||||
|
|
||||||
def handle_request(request)
|
def handle_request(request)
|
||||||
case request.env["REQUEST_METHOD"]
|
case request.env["REQUEST_METHOD"]
|
||||||
when "POST"
|
when "POST"
|
||||||
|
|
@ -105,6 +108,9 @@ module MCP
|
||||||
end
|
end
|
||||||
|
|
||||||
def handle_post(request)
|
def handle_post(request)
|
||||||
|
accept_error = validate_accept_header(request, REQUIRED_POST_ACCEPT_TYPES)
|
||||||
|
return accept_error if accept_error
|
||||||
|
|
||||||
body_string = request.body.read
|
body_string = request.body.read
|
||||||
session_id = extract_session_id(request)
|
session_id = extract_session_id(request)
|
||||||
|
|
||||||
|
|
@ -128,6 +134,9 @@ module MCP
|
||||||
return method_not_allowed_response
|
return method_not_allowed_response
|
||||||
end
|
end
|
||||||
|
|
||||||
|
accept_error = validate_accept_header(request, REQUIRED_GET_ACCEPT_TYPES)
|
||||||
|
return accept_error if accept_error
|
||||||
|
|
||||||
session_id = extract_session_id(request)
|
session_id = extract_session_id(request)
|
||||||
|
|
||||||
return missing_session_id_response unless session_id
|
return missing_session_id_response unless session_id
|
||||||
|
|
@ -178,6 +187,31 @@ module MCP
|
||||||
request.env["HTTP_MCP_SESSION_ID"]
|
request.env["HTTP_MCP_SESSION_ID"]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def validate_accept_header(request, required_types)
|
||||||
|
accept_header = request.env["HTTP_ACCEPT"]
|
||||||
|
return not_acceptable_response(required_types) unless accept_header
|
||||||
|
|
||||||
|
accepted_types = parse_accept_header(accept_header)
|
||||||
|
missing_types = required_types - accepted_types
|
||||||
|
return not_acceptable_response(required_types) unless missing_types.empty?
|
||||||
|
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
def parse_accept_header(header)
|
||||||
|
header.split(",").map do |part|
|
||||||
|
part.split(";").first.strip
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def not_acceptable_response(required_types)
|
||||||
|
[
|
||||||
|
406,
|
||||||
|
{ "Content-Type" => "application/json" },
|
||||||
|
[{ error: "Not Acceptable: Accept header must include #{required_types.join(" and ")}" }.to_json],
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
def parse_request_body(body_string)
|
def parse_request_body(body_string)
|
||||||
JSON.parse(body_string)
|
JSON.parse(body_string)
|
||||||
rescue JSON::ParserError, TypeError
|
rescue JSON::ParserError, TypeError
|
||||||
|
|
|
||||||
|
|
@ -40,6 +40,7 @@ module MCP
|
||||||
headers: {
|
headers: {
|
||||||
"Authorization" => "Bearer token",
|
"Authorization" => "Bearer token",
|
||||||
"Content-Type" => "application/json",
|
"Content-Type" => "application/json",
|
||||||
|
"Accept" => "application/json, text/event-stream",
|
||||||
},
|
},
|
||||||
body: request.to_json,
|
body: request.to_json,
|
||||||
)
|
)
|
||||||
|
|
@ -54,6 +55,53 @@ module MCP
|
||||||
client.send_request(request: request)
|
client.send_request(request: request)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def test_accept_header_is_included_in_requests
|
||||||
|
request = {
|
||||||
|
jsonrpc: "2.0",
|
||||||
|
id: "test_id",
|
||||||
|
method: "tools/list",
|
||||||
|
}
|
||||||
|
|
||||||
|
stub_request(:post, url)
|
||||||
|
.with(
|
||||||
|
headers: {
|
||||||
|
"Accept" => "application/json, text/event-stream",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
.to_return(
|
||||||
|
status: 200,
|
||||||
|
headers: { "Content-Type" => "application/json" },
|
||||||
|
body: { result: { tools: [] } }.to_json,
|
||||||
|
)
|
||||||
|
|
||||||
|
client.send_request(request: request)
|
||||||
|
end
|
||||||
|
|
||||||
|
def test_custom_accept_header_overrides_default
|
||||||
|
custom_accept = "application/json"
|
||||||
|
custom_client = HTTP.new(url: url, headers: { "Accept" => custom_accept })
|
||||||
|
|
||||||
|
request = {
|
||||||
|
jsonrpc: "2.0",
|
||||||
|
id: "test_id",
|
||||||
|
method: "tools/list",
|
||||||
|
}
|
||||||
|
|
||||||
|
stub_request(:post, url)
|
||||||
|
.with(
|
||||||
|
headers: {
|
||||||
|
"Accept" => custom_accept,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
.to_return(
|
||||||
|
status: 200,
|
||||||
|
headers: { "Content-Type" => "application/json" },
|
||||||
|
body: { result: { tools: [] } }.to_json,
|
||||||
|
)
|
||||||
|
|
||||||
|
custom_client.send_request(request: request)
|
||||||
|
end
|
||||||
|
|
||||||
def test_send_request_returns_faraday_response
|
def test_send_request_returns_faraday_response
|
||||||
request = {
|
request = {
|
||||||
jsonrpc: "2.0",
|
jsonrpc: "2.0",
|
||||||
|
|
@ -194,6 +242,33 @@ module MCP
|
||||||
assert_equal({ method: "tools/list", params: nil }, error.request)
|
assert_equal({ method: "tools/list", params: nil }, error.request)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def test_send_request_raises_error_for_non_json_response
|
||||||
|
request = {
|
||||||
|
jsonrpc: "2.0",
|
||||||
|
id: "test_id",
|
||||||
|
method: "tools/list",
|
||||||
|
}
|
||||||
|
|
||||||
|
stub_request(:post, url)
|
||||||
|
.with(body: request.to_json)
|
||||||
|
.to_return(
|
||||||
|
status: 200,
|
||||||
|
headers: { "Content-Type" => "text/event-stream" },
|
||||||
|
body: "data: {}\n\n",
|
||||||
|
)
|
||||||
|
|
||||||
|
error = assert_raises(RequestHandlerError) do
|
||||||
|
client.send_request(request: request)
|
||||||
|
end
|
||||||
|
|
||||||
|
assert_equal(
|
||||||
|
'Unsupported Content-Type: "text/event-stream". This client only supports JSON responses.',
|
||||||
|
error.message,
|
||||||
|
)
|
||||||
|
assert_equal(:unsupported_media_type, error.error_type)
|
||||||
|
assert_equal({ method: "tools/list", params: nil }, error.request)
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
def stub_request(method, url)
|
def stub_request(method, url)
|
||||||
|
|
|
||||||
|
|
@ -232,11 +232,20 @@ module MCP
|
||||||
private
|
private
|
||||||
|
|
||||||
def create_rack_request(method, path, headers, body = nil)
|
def create_rack_request(method, path, headers, body = nil)
|
||||||
|
default_accept = case method
|
||||||
|
when "POST"
|
||||||
|
{ "HTTP_ACCEPT" => "application/json, text/event-stream" }
|
||||||
|
when "GET"
|
||||||
|
{ "HTTP_ACCEPT" => "text/event-stream" }
|
||||||
|
else
|
||||||
|
{}
|
||||||
|
end
|
||||||
|
|
||||||
env = {
|
env = {
|
||||||
"REQUEST_METHOD" => method,
|
"REQUEST_METHOD" => method,
|
||||||
"PATH_INFO" => path,
|
"PATH_INFO" => path,
|
||||||
"rack.input" => StringIO.new(body.to_s),
|
"rack.input" => StringIO.new(body.to_s),
|
||||||
}.merge(headers)
|
}.merge(default_accept, headers)
|
||||||
|
|
||||||
Rack::Request.new(env)
|
Rack::Request.new(env)
|
||||||
end
|
end
|
||||||
|
|
|
||||||
|
|
@ -573,6 +573,164 @@ module MCP
|
||||||
assert_equal "Method not allowed", body["error"]
|
assert_equal "Method not allowed", body["error"]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
test "POST request without Accept header returns 406" do
|
||||||
|
request = create_rack_request_without_accept(
|
||||||
|
"POST",
|
||||||
|
"/",
|
||||||
|
{ "CONTENT_TYPE" => "application/json" },
|
||||||
|
{ jsonrpc: "2.0", method: "initialize", id: "123" }.to_json,
|
||||||
|
)
|
||||||
|
|
||||||
|
response = @transport.handle_request(request)
|
||||||
|
assert_equal 406, response[0]
|
||||||
|
assert_equal({ "Content-Type" => "application/json" }, response[1])
|
||||||
|
|
||||||
|
body = JSON.parse(response[2][0])
|
||||||
|
assert_equal "Not Acceptable: Accept header must include application/json and text/event-stream",
|
||||||
|
body["error"]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "POST request with Accept header missing text/event-stream returns 406" do
|
||||||
|
request = create_rack_request_without_accept(
|
||||||
|
"POST",
|
||||||
|
"/",
|
||||||
|
{
|
||||||
|
"CONTENT_TYPE" => "application/json",
|
||||||
|
"HTTP_ACCEPT" => "application/json",
|
||||||
|
},
|
||||||
|
{ jsonrpc: "2.0", method: "initialize", id: "123" }.to_json,
|
||||||
|
)
|
||||||
|
|
||||||
|
response = @transport.handle_request(request)
|
||||||
|
assert_equal 406, response[0]
|
||||||
|
|
||||||
|
body = JSON.parse(response[2][0])
|
||||||
|
assert_equal "Not Acceptable: Accept header must include application/json and text/event-stream",
|
||||||
|
body["error"]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "POST request with Accept header missing application/json returns 406" do
|
||||||
|
request = create_rack_request_without_accept(
|
||||||
|
"POST",
|
||||||
|
"/",
|
||||||
|
{
|
||||||
|
"CONTENT_TYPE" => "application/json",
|
||||||
|
"HTTP_ACCEPT" => "text/event-stream",
|
||||||
|
},
|
||||||
|
{ jsonrpc: "2.0", method: "initialize", id: "123" }.to_json,
|
||||||
|
)
|
||||||
|
|
||||||
|
response = @transport.handle_request(request)
|
||||||
|
assert_equal 406, response[0]
|
||||||
|
|
||||||
|
body = JSON.parse(response[2][0])
|
||||||
|
assert_equal "Not Acceptable: Accept header must include application/json and text/event-stream",
|
||||||
|
body["error"]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "POST request with valid Accept header succeeds" do
|
||||||
|
request = create_rack_request(
|
||||||
|
"POST",
|
||||||
|
"/",
|
||||||
|
{
|
||||||
|
"CONTENT_TYPE" => "application/json",
|
||||||
|
"HTTP_ACCEPT" => "application/json, text/event-stream",
|
||||||
|
},
|
||||||
|
{ jsonrpc: "2.0", method: "initialize", id: "123" }.to_json,
|
||||||
|
)
|
||||||
|
|
||||||
|
response = @transport.handle_request(request)
|
||||||
|
assert_equal 200, response[0]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "POST request with Accept header containing quality values succeeds" do
|
||||||
|
request = create_rack_request(
|
||||||
|
"POST",
|
||||||
|
"/",
|
||||||
|
{
|
||||||
|
"CONTENT_TYPE" => "application/json",
|
||||||
|
"HTTP_ACCEPT" => "application/json;q=0.9, text/event-stream;q=0.8",
|
||||||
|
},
|
||||||
|
{ jsonrpc: "2.0", method: "initialize", id: "123" }.to_json,
|
||||||
|
)
|
||||||
|
|
||||||
|
response = @transport.handle_request(request)
|
||||||
|
assert_equal 200, response[0]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "GET request without Accept header returns 406" do
|
||||||
|
init_request = create_rack_request(
|
||||||
|
"POST",
|
||||||
|
"/",
|
||||||
|
{ "CONTENT_TYPE" => "application/json" },
|
||||||
|
{ jsonrpc: "2.0", method: "initialize", id: "123" }.to_json,
|
||||||
|
)
|
||||||
|
init_response = @transport.handle_request(init_request)
|
||||||
|
session_id = init_response[1]["Mcp-Session-Id"]
|
||||||
|
|
||||||
|
request = create_rack_request_without_accept(
|
||||||
|
"GET",
|
||||||
|
"/",
|
||||||
|
{ "HTTP_MCP_SESSION_ID" => session_id },
|
||||||
|
)
|
||||||
|
|
||||||
|
response = @transport.handle_request(request)
|
||||||
|
assert_equal 406, response[0]
|
||||||
|
|
||||||
|
body = JSON.parse(response[2][0])
|
||||||
|
assert_equal "Not Acceptable: Accept header must include text/event-stream", body["error"]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "GET request with Accept header missing text/event-stream returns 406" do
|
||||||
|
init_request = create_rack_request(
|
||||||
|
"POST",
|
||||||
|
"/",
|
||||||
|
{ "CONTENT_TYPE" => "application/json" },
|
||||||
|
{ jsonrpc: "2.0", method: "initialize", id: "123" }.to_json,
|
||||||
|
)
|
||||||
|
init_response = @transport.handle_request(init_request)
|
||||||
|
session_id = init_response[1]["Mcp-Session-Id"]
|
||||||
|
|
||||||
|
request = create_rack_request_without_accept(
|
||||||
|
"GET",
|
||||||
|
"/",
|
||||||
|
{
|
||||||
|
"HTTP_MCP_SESSION_ID" => session_id,
|
||||||
|
"HTTP_ACCEPT" => "application/json",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
response = @transport.handle_request(request)
|
||||||
|
assert_equal 406, response[0]
|
||||||
|
|
||||||
|
body = JSON.parse(response[2][0])
|
||||||
|
assert_equal "Not Acceptable: Accept header must include text/event-stream", body["error"]
|
||||||
|
end
|
||||||
|
|
||||||
|
test "GET request with valid Accept header succeeds" do
|
||||||
|
init_request = create_rack_request(
|
||||||
|
"POST",
|
||||||
|
"/",
|
||||||
|
{ "CONTENT_TYPE" => "application/json" },
|
||||||
|
{ jsonrpc: "2.0", method: "initialize", id: "123" }.to_json,
|
||||||
|
)
|
||||||
|
init_response = @transport.handle_request(init_request)
|
||||||
|
session_id = init_response[1]["Mcp-Session-Id"]
|
||||||
|
|
||||||
|
request = create_rack_request(
|
||||||
|
"GET",
|
||||||
|
"/",
|
||||||
|
{
|
||||||
|
"HTTP_MCP_SESSION_ID" => session_id,
|
||||||
|
"HTTP_ACCEPT" => "text/event-stream",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
response = @transport.handle_request(request)
|
||||||
|
assert_equal 200, response[0]
|
||||||
|
assert_equal "text/event-stream", response[1]["Content-Type"]
|
||||||
|
end
|
||||||
|
|
||||||
test "stateless mode allows requests without session IDs, responding with no session ID" do
|
test "stateless mode allows requests without session IDs, responding with no session ID" do
|
||||||
stateless_transport = StreamableHTTPTransport.new(@server, stateless: true)
|
stateless_transport = StreamableHTTPTransport.new(@server, stateless: true)
|
||||||
|
|
||||||
|
|
@ -771,6 +929,25 @@ module MCP
|
||||||
private
|
private
|
||||||
|
|
||||||
def create_rack_request(method, path, headers, body = nil)
|
def create_rack_request(method, path, headers, body = nil)
|
||||||
|
default_accept = case method
|
||||||
|
when "POST"
|
||||||
|
{ "HTTP_ACCEPT" => "application/json, text/event-stream" }
|
||||||
|
when "GET"
|
||||||
|
{ "HTTP_ACCEPT" => "text/event-stream" }
|
||||||
|
else
|
||||||
|
{}
|
||||||
|
end
|
||||||
|
|
||||||
|
env = {
|
||||||
|
"REQUEST_METHOD" => method,
|
||||||
|
"PATH_INFO" => path,
|
||||||
|
"rack.input" => StringIO.new(body.to_s),
|
||||||
|
}.merge(default_accept).merge(headers)
|
||||||
|
|
||||||
|
Rack::Request.new(env)
|
||||||
|
end
|
||||||
|
|
||||||
|
def create_rack_request_without_accept(method, path, headers, body = nil)
|
||||||
env = {
|
env = {
|
||||||
"REQUEST_METHOD" => method,
|
"REQUEST_METHOD" => method,
|
||||||
"PATH_INFO" => path,
|
"PATH_INFO" => path,
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue