fix doc

Signed-off-by: Yuchen Zhang <[email protected]>

Author: yczhang-nv

src/nat/front_ends/mcp/load_test_utils/cli.py

@@ -16,10 +16,6 @@
 """MCP Load Test Entry Point Script.
 
 Run load tests against MCP servers using YAML configuration files.
-
-Usage:
-    python cli.py --config_file=./configs/config.yml
-    python cli.py -c configs/config.yml --verbose
 """
 
 import argparse
@@ -43,35 +39,14 @@ def parse_args():
     parser = argparse.ArgumentParser(
         description="Run MCP server load tests using YAML configuration",
         formatter_class=argparse.RawDescriptionHelpFormatter,
-        epilog="""
-Examples:
-  # Run with config file
-  python cli.py --config_file=configs/config.yml
-
-  # With verbose logging
-  python cli.py --config_file=configs/config.yml --verbose
-
-  # Short form
-  python cli.py -c configs/config.yml
-
-Configuration File Format:
-  The YAML config file should contain:
-    - config_file: Path to NAT workflow config
-    - server: Server configuration (host, port, transport)
-    - load_test: Test parameters (num_concurrent_users, duration_seconds, etc.)
-    - output: Output directory configuration
-    - tool_calls: List of tool calls to execute
-
-  See configs/config.yml for a complete example.
-        """,
     )
 
     parser.add_argument(
         "-c",
         "--config_file",
         type=str,
         required=True,
-        help="Path to YAML configuration file (e.g., configs/config.yml)",
+        help="Path to YAML configuration file",
     )
 
     parser.add_argument(
@@ -94,7 +69,6 @@ def print_summary(results: dict):
     logger.info("LOAD TEST RESULTS SUMMARY")
     logger.info("=" * 70)
 
-    # Summary metrics
     summary = results.get("summary", {})
     logger.info("\nSummary Metrics:")
     logger.info("  Total Requests:      %d", summary.get("total_requests", 0))
@@ -104,7 +78,6 @@ def print_summary(results: dict):
     logger.info("  Test Duration:       %.2f seconds", summary.get("test_duration_seconds", 0))
     logger.info("  Requests/Second:     %.2f", summary.get("requests_per_second", 0))
 
-    # Latency statistics
     latency = results.get("latency_statistics", {})
     logger.info("\nLatency Statistics:")
     logger.info("  Mean:                %.2f ms", latency.get("mean_ms", 0))
@@ -114,7 +87,6 @@ def print_summary(results: dict):
     logger.info("  Min:                 %.2f ms", latency.get("min_ms", 0))
     logger.info("  Max:                 %.2f ms", latency.get("max_ms", 0))
 
-    # Memory statistics
     memory = results.get("memory_statistics", {})
     if memory:
         logger.info("\nMemory Statistics:")
@@ -125,7 +97,6 @@ def print_summary(results: dict):
         logger.info("  Mean Memory Usage:   %.2f%%", memory.get("percent_mean", 0))
         logger.info("  Max Memory Usage:    %.2f%%", memory.get("percent_max", 0))
 
-    # Per-tool statistics
     tool_stats = results.get("per_tool_statistics", {})
     if tool_stats:
         logger.info("\nPer-Tool Statistics:")
@@ -135,14 +106,12 @@ def print_summary(results: dict):
             logger.info("    Success Rate:    %.2f%%", stats.get("success_rate", 0))
             logger.info("    Mean Latency:    %.2f ms", stats.get("mean_latency_ms", 0))
 
-    # Errors
     errors = results.get("errors", {})
     if errors:
         logger.info("\nErrors:")
         for error_msg, count in sorted(errors.items(), key=lambda x: x[1], reverse=True)[:5]:
             logger.info("  [%d] %s", count, error_msg[:80])
 
-    # Output location
     test_config = results.get("test_configuration", {})
     output_dir = test_config.get("output_dir", "load_test_results")
     logger.info("\n" + "=" * 70)
@@ -154,18 +123,14 @@ def main():
     """Main entry point."""
     args = parse_args()
 
-    # Set logging level
     if args.verbose:
         logging.getLogger().setLevel(logging.DEBUG)
         logger.debug("Verbose logging enabled")
 
-    # Validate config file path
     config_path = Path(args.config_file)
 
     if not config_path.exists():
         logger.error("Configuration file not found: %s", config_path)
-
-        # Try to find it relative to script directory
         script_dir = Path(__file__).parent
         alternative_path = script_dir / args.config_file
 
@@ -179,18 +144,15 @@ def main():
     logger.info("Configuration file: %s", config_path.absolute())
 
     try:
-        # Run the load test
         results = run_load_test_from_yaml(str(config_path))
 
-        # Print summary
         print_summary(results)
 
-        # Return success
         return 0
 
     except KeyboardInterrupt:
         logger.warning("\nLoad test interrupted by user")
-        return 130  # Standard exit code for SIGINT
+        return 130
 
     except Exception as e:
         logger.error("Load test failed: %s", e, exc_info=args.verbose)

src/nat/front_ends/mcp/load_test_utils/config_loader.py

@@ -51,31 +51,26 @@ def load_config_from_yaml(config_path: str | Path) -> LoadTestConfig:
     if not config_data:
         raise ValueError("Config file is empty")
 
-    # Extract required field
     config_file = config_data.get("config_file")
     if not config_file:
-        raise ValueError("'config_file' is required in the config")
+        raise ValueError("config_file is required in the config")
 
-    # Extract server configuration
     server_config = config_data.get("server", {})
     server_host = server_config.get("host", "localhost")
     server_port = server_config.get("port", 9901)
     transport = server_config.get("transport", "streamable-http")
 
-    # Extract load test parameters
     load_test_config = config_data.get("load_test", {})
     num_concurrent_users = load_test_config.get("num_concurrent_users", 10)
     duration_seconds = load_test_config.get("duration_seconds", 60)
     warmup_seconds = load_test_config.get("warmup_seconds", 5)
 
-    # Extract output configuration
     output_config = config_data.get("output", {})
     output_dir = output_config.get("directory", None)
 
-    # Extract tool calls
     tool_calls_data = config_data.get("tool_calls", [])
     if not tool_calls_data:
-        raise ValueError("At least one tool call must be specified in 'tool_calls'")
+        raise ValueError("At least one tool call must be specified in tool_calls")
 
     tool_calls = []
     for tc in tool_calls_data:
@@ -130,7 +125,7 @@ def validate_config(config: LoadTestConfig) -> None:
         raise ValueError("At least one tool call must be specified")
 
     if config.transport not in ["streamable-http", "sse"]:
-        raise ValueError("transport must be 'streamable-http' or 'sse'")
+        raise ValueError("transport must be streamable-http or sse")
 
     if config.server_port < 1 or config.server_port > 65535:
         raise ValueError("server_port must be between 1 and 65535")