Documentation Validation Report 🔗

This file tracks discrepancies found between documentation and the actual Python codebase after backwards compatibility cleanup.

README.md Validation 🔗

CRITICAL DISCREPANCIES 🔗

1. Missing Convenience Methods (Lines 504-507) 🔗

• Section: Quick Start example
• Issue: README shows convenience methods that don't exist in the codebase
• README says:

self.setPersonality("You are a helpful assistant.")
self.setGoal("Help users with basic questions.")
self.setInstructions(["Be concise and clear."])

• Reality: These methods are NOT defined in AgentBase class
• Actual methods: prompt_add_section() with explicit title/body parameters
• Severity: CRITICAL - Code examples will fail to run

MAJOR DISCREPANCIES 🔗

2. DataMap Method Names (Lines 126-160) 🔗

• Section: DataMap Tools examples
• Issue: Method name inconsistency
• README shows: DataMap('get_weather').description('Get current weather information')
• Actual method: Should be .purpose() instead of .description()
• Severity: MAJOR - Examples would fail

3. Search Installation Options Size Claims (Lines 441-449) 🔗

• Section: Search Installation Options table
• Issue: Size estimates appear to be speculative/outdated
• README claims: Specific MB sizes (400MB, 500MB, 600MB, 700MB)
• Reality: These are estimates and dependency sizes change frequently
• Severity: MAJOR - Misleading size information

MINOR DISCREPANCIES 🔗

4. Missing Skills Documentation (Lines 92-98) 🔗

• Section: Available Built-in Skills
• Issue: Skills listed that don't exist or missing skills not documented
• README claims: "web_search", "datetime", "math", "datasphere", "native_vector_search"
• Additional skills not mentioned: api_ninjas_trivia, joke, play_background_file, weather_api, wikipedia_search, datasphere_serverless
• Missing: native_vector_search (directory exists but incomplete)
• Severity: MINOR - Incomplete skills documentation

5. Context Method Inconsistency (Lines 62-76) 🔗

• Section: Contexts and Steps example
• Issue: Method calling pattern inconsistency in add_bullets() usage
• Severity: MINOR - One example is incorrect but method exists

Documentation Files Validation 🔗

docs/agent_guide.md 🔗

VERIFIED CORRECT: serve() Method Usage Still Valid 🔗

• Lines: 2081, 2099, 2125, 2159, 2181, 2298, 2434
• Documentation shows: agent.serve(host="0.0.0.0", port=8000)
• Core SDK confirms: def serve(self, host: Optional[str] = None, port: Optional[int] = None) still exists in agent_base.py
• Status: ✅ CORRECT - serve() method still works
• Note: Both serve() and run() methods accept host/port parameters

• All instances:

• Line 2081: agent.serve(host="0.0.0.0", port=8000)

• Line 2099: agent.serve(host="0.0.0.0", port=8000)
• Line 2125: agent.serve(host="0.0.0.0", port=8000)
• Line 2159: agent.serve(host="0.0.0.0", port=8000)
• Line 2181: agent.serve(host="0.0.0.0", port=8000)
• Line 2298: support_agent.serve(host="0.0.0.0", port=8000)
• Line 2434: API reference listing serve(host=None, port=None) method

docs/datamap_guide.md 🔗

VERIFIED CORRECT: DataMap method usage is accurate 🔗

• Lines: 50, 67, 273, 337, 423, 436, 460, 475, 490
• Documentation shows: DataMap('tool').description('Tool description')
• Core SDK confirms: def description(self, description: str) -> 'DataMap': exists in signalwire_agents/core/data_map.py
• Status: ✅ CORRECT - Documentation matches core SDK

ISSUE FOUND: Examples use wrong method name 🔗

• Issue: examples/data_map_demo.py uses .purpose() method
• Reality: Core SDK only has .description() method, not .purpose()
• Severity: MAJOR - Examples would fail with AttributeError
• Examples need fixing: data_map_demo.py lines 70, 85, 102, 112, 203

docs/swml_service_guide.md 🔗

CRITICAL DISCREPANCY: References to removed backwards compatibility methods 🔗

• Lines: 60, 68, 168, 498
• Issue: Documentation still references removed backwards compatibility methods

• Docs show:

• Line 60: self.add_answer_verb()

• Line 68: self.add_hangup_verb()
• Line 168: API reference for add_ai_verb()
• Line 498: API reference for add_ai_verb()
• Reality: These methods were removed during backwards compatibility cleanup
• Current method: Should use self.add_verb("answer", {}), self.add_verb("hangup", {}), etc.
• Severity: CRITICAL - Code examples will fail with AttributeError