feat(mcp): cap MCP batch tool at MAX_BATCH_OPERATIONS (PRJ-22)
- enforce the same 100-operation cap the HTTP /batch endpoint enforces; over-cap \x60calls\x60 reject with a structured INVALID_INPUT (retryable: false, matching CallError::invalid_input) before any dispatch - hoist MAX_BATCH_OPERATIONS to gateway/mod.rs and reuse it in routes, to_openapi (removing a pre-existing duplicate literal), and to_mcp - state the limit in the batch tool description and add maxItems to the input schema (doc previously advertised no limit) - GatewayDispatch gains a per-instance invoke_count spy accessor so the over-cap test proves zero dispatches (process-global counters raced under the parallel test runner) - tests: over-cap -> INVALID_INPUT + invoke_count()==0; at-cap -> 100 results + invoke_count()==100 verification: scripts/verify.sh (352 passed) and scripts/verify.sh --all-features (468 passed); cargo clippy --all-targets -D warnings and cargo fmt --check clean
This commit is contained in:
+80
-3
@@ -46,7 +46,7 @@ use rmcp::transport::{
|
||||
};
|
||||
use serde_json::{Map, Value};
|
||||
|
||||
use crate::gateway::GatewayDispatch;
|
||||
use crate::gateway::{GatewayDispatch, MAX_BATCH_OPERATIONS};
|
||||
|
||||
const TOOL_SEARCH: &str = "search";
|
||||
const TOOL_SCHEMA: &str = "schema";
|
||||
@@ -112,7 +112,8 @@ fn batch_input_schema() -> Value {
|
||||
},
|
||||
"required": ["operation"]
|
||||
},
|
||||
"description": "The operations to invoke in this batch."
|
||||
"maxItems": MAX_BATCH_OPERATIONS,
|
||||
"description": "The operations to invoke in this batch. At most 100 operations per batch.",
|
||||
}
|
||||
},
|
||||
"required": ["calls"]
|
||||
@@ -223,6 +224,11 @@ impl ToMcpGateway {
|
||||
));
|
||||
}
|
||||
};
|
||||
if calls.len() > MAX_BATCH_OPERATIONS {
|
||||
return call_error_to_structured_error(CallError::invalid_input(format!(
|
||||
"batch exceeds the maximum of {MAX_BATCH_OPERATIONS} operations"
|
||||
)));
|
||||
}
|
||||
|
||||
let mut results: Vec<Value> = Vec::with_capacity(calls.len());
|
||||
for call in calls {
|
||||
@@ -412,7 +418,7 @@ pub(crate) fn gateway_tools() -> Vec<Tool> {
|
||||
Tool::new(
|
||||
Cow::Borrowed(TOOL_BATCH),
|
||||
Cow::Borrowed(
|
||||
"Invoke multiple operations in one tool call. Returns {\"results\": [...]} where each entry is {\"isError\": false, \"output\": ...} on success or {\"isError\": true, \"error\": {code, message, retryable}} on failure.",
|
||||
"Invoke multiple operations in one tool call, executed serially in order (each bounded by the 30 s deadline). Returns {\"results\": [...]} where each entry is {\"isError\": false, \"output\": ...} on success or {\"isError\": true, \"error\": {code, message, retryable}} on failure. At most 100 operations per batch; larger batches are rejected with INVALID_INPUT without dispatching.",
|
||||
),
|
||||
value_to_object(batch_input_schema()),
|
||||
),
|
||||
@@ -1171,6 +1177,77 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn batch_over_cap_returns_invalid_input_without_dispatching() {
|
||||
let registry = full_registry_with_ops(vec![(
|
||||
"echo/run".to_string(),
|
||||
OperationType::Query,
|
||||
AccessControl::default(),
|
||||
)]);
|
||||
let calls: Vec<Value> = (0..MAX_BATCH_OPERATIONS + 1)
|
||||
.map(|i| serde_json::json!({ "operation": "echo/run", "input": { "n": i } }))
|
||||
.collect();
|
||||
let mut args = Map::new();
|
||||
args.insert("calls".to_string(), Value::Array(calls));
|
||||
let dispatch_spine = dispatch(registry, provider());
|
||||
let gateway = ToMcpGateway::new(Arc::clone(&dispatch_spine));
|
||||
|
||||
let result = invoke_tool(&gateway, "batch", Some(args), None).await;
|
||||
assert_eq!(result.is_error, Some(true));
|
||||
let structured = result.structured_content.expect("structured error present");
|
||||
assert_eq!(
|
||||
structured.get("code"),
|
||||
Some(&Value::String("INVALID_INPUT".to_string()))
|
||||
);
|
||||
assert_eq!(structured.get("retryable"), Some(&Value::Bool(false)));
|
||||
let message = structured
|
||||
.get("message")
|
||||
.and_then(Value::as_str)
|
||||
.expect("message");
|
||||
assert!(
|
||||
message.contains("maximum of 100"),
|
||||
"the cap message must state the limit: {message}"
|
||||
);
|
||||
assert_eq!(
|
||||
dispatch_spine.invoke_count(),
|
||||
0,
|
||||
"no operation may be dispatched when the batch is over cap"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn batch_at_cap_is_accepted() {
|
||||
let registry = full_registry_with_ops(vec![(
|
||||
"echo/run".to_string(),
|
||||
OperationType::Query,
|
||||
AccessControl::default(),
|
||||
)]);
|
||||
let calls: Vec<Value> = (0..MAX_BATCH_OPERATIONS)
|
||||
.map(|i| serde_json::json!({ "operation": "echo/run", "input": { "n": i } }))
|
||||
.collect();
|
||||
let mut args = Map::new();
|
||||
args.insert("calls".to_string(), Value::Array(calls));
|
||||
let dispatch_spine = dispatch(registry, provider());
|
||||
let gateway = ToMcpGateway::new(Arc::clone(&dispatch_spine));
|
||||
|
||||
let result = invoke_tool(&gateway, "batch", Some(args), None).await;
|
||||
assert_eq!(result.is_error, Some(false));
|
||||
let structured = result.structured_content.expect("structured present");
|
||||
let results = structured
|
||||
.get("results")
|
||||
.and_then(Value::as_array)
|
||||
.expect("results array");
|
||||
assert_eq!(results.len(), MAX_BATCH_OPERATIONS);
|
||||
for entry in results {
|
||||
assert_eq!(entry.get("isError"), Some(&Value::Bool(false)));
|
||||
}
|
||||
assert_eq!(
|
||||
dispatch_spine.invoke_count(),
|
||||
MAX_BATCH_OPERATIONS,
|
||||
"every entry in an at-cap batch is dispatched"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn batch_returns_object_with_result_entries() {
|
||||
let registry = full_registry_with_ops(vec![(
|
||||
|
||||
Reference in New Issue
Block a user