Googolplexic commited on
Commit
e6a445e
·
1 Parent(s): 4c3e379

Enhance validation workflow documentation to emphasize manual inspection of 'sample_response' for error messages

Browse files
Files changed (1) hide show
  1. api_validator.py +7 -1
api_validator.py CHANGED
@@ -34,10 +34,16 @@ def validate_api_call(
34
  of the monitoring setup process. If validation fails, retry with corrected parameters.
35
  If successful, use the returned config_id in setup_scheduler() function.
36
 
 
 
 
 
37
  WORKFLOW:
38
  1. Call this function to validate API configuration
39
  2. If success=False: Fix parameters and retry this function
40
- 3. If success=True: Use config_id in setup_scheduler() to activate monitoring
 
 
41
 
42
  Parameters:
43
  - mcp_api_key: MCP API key serves as user identifier
 
34
  of the monitoring setup process. If validation fails, retry with corrected parameters.
35
  If successful, use the returned config_id in setup_scheduler() function.
36
 
37
+ ⚠️ CRITICAL: Even if success=True, you MUST manually check the 'sample_response' field
38
+ before proceeding to setup_scheduler(). The API call may return success=True but contain
39
+ error messages (like "401 Unauthorized", "Invalid API key", etc.) in the sample_response.
40
+
41
  WORKFLOW:
42
  1. Call this function to validate API configuration
43
  2. If success=False: Fix parameters and retry this function
44
+ 3. If success=True: MANUALLY INSPECT the 'sample_response' field for errors
45
+ 4. If sample_response contains error messages: Fix API parameters and retry validation
46
+ 5. If sample_response looks valid: Use config_id in setup_scheduler() to activate monitoring
47
 
48
  Parameters:
49
  - mcp_api_key: MCP API key serves as user identifier