Skip to content

Conversation

@wtfsayo
Copy link
Member

@wtfsayo wtfsayo commented Dec 29, 2025

Summary

Added comprehensive README.md documentation for the @elizaos/plugin-dummy-services package.

Documentation Includes

  • Package overview and purpose
  • Installation instructions (using bun)
  • Table of all 9 available dummy services with service types
  • Full plugin usage example
  • Individual service import examples
  • Detailed API documentation for each service:
    • DummyTokenDataService
    • DummyLpService
    • DummyWalletService
    • DummyPdfService
    • DummyVideoService
    • DummyBrowserService
    • DummyTranscriptionService
    • DummyWebSearchService
    • DummyEmailService
  • Guide on when to use dummy vs real services
  • Testing information

Test plan

  • README follows project documentation style
  • Code examples are accurate based on source files

🤖 Generated with Claude Code


Note

Provides full documentation for @elizaos/plugin-dummy-services to enable testing agents without external dependencies.

  • Adds detailed README with installation, full-plugin and per-service usage examples
  • Documents APIs for 9 dummy services (token_data, lp, wallet, pdf, video, browser, transcription, web_search, email) with code snippets
  • Includes guidance on when to use dummy vs real services and basic testing instructions

Written by Cursor Bugbot for commit a62e249. This will update automatically on new commits. Configure here.

Greptile Summary

Added comprehensive README documentation for the @elizaos/plugin-dummy-services package. The README provides detailed API documentation for all 9 dummy services with usage examples, installation instructions, and guidance on when to use dummy vs real services.

The PR also includes unrelated improvements to multi-step workflow functionality:

  • Enhanced parameter extraction and formatting in multi-step actions
  • Added retry logic for XML parsing failures with exponential backoff
  • Improved streaming support for multi-step workflows
  • Added comprehensive test coverage for retry logic and parameter handling

Key additions:

  • Complete service API documentation with code examples for each service
  • Usage patterns for both plugin-wide and individual service imports
  • Decision matrix for when to use dummy services vs real services
  • Testing information and examples

Confidence Score: 4/5

  • This PR is safe to merge with minor considerations
  • The README documentation is comprehensive, accurate, and well-structured. The multi-step workflow improvements include proper error handling, retry logic, and test coverage. Score is 4/5 due to the PR containing multiple unrelated commits beyond just the documentation (title claims only docs, but includes 6 other commits with core functionality changes)
  • No files require special attention. All changes are well-implemented with proper error handling and test coverage

Important Files Changed

Filename Overview
packages/plugin-dummy-services/README.md Added comprehensive documentation for the dummy services plugin with API examples and usage guidance
packages/core/src/prompts.ts Updated prompts for multi-step workflows with parameter handling instructions
packages/core/src/runtime.ts Enhanced runtime with retry logic and improved error handling for multi-step actions
packages/core/src/services/default-message-service.ts Significantly enhanced message service with streaming support, action chaining, and improved logging
packages/plugin-bootstrap/src/tests/multi-step.test.ts Added comprehensive test suite for multi-step action workflows with various scenarios
packages/plugin-bootstrap/src/providers/actions.ts Enhanced actions provider with improved parameter formatting and action result tracking

Sequence Diagram

sequenceDiagram
    participant User
    participant MessageService
    participant Runtime
    participant LLM
    participant Action
    participant Provider
    
    User->>MessageService: Send message
    MessageService->>MessageService: Check USE_MULTI_STEP setting
    
    alt Multi-Step Mode
        loop For each step (max iterations)
            MessageService->>Runtime: composeState()
            Runtime-->>MessageService: State with context
            
            MessageService->>Runtime: Generate decision prompt
            Runtime->>LLM: Decision request with actionsWithParams
            
            loop Retry with exponential backoff
                LLM-->>Runtime: XML response
                Runtime->>Runtime: parseKeyValueXml()
                alt Parse Success
                    Runtime-->>MessageService: Parsed step (thought, action, parameters, providers, isFinish)
                    Note over Runtime,MessageService: Break retry loop
                else Parse Failure
                    Runtime->>Runtime: Wait with exponential backoff
                end
            end
            
            alt Has Parameters
                MessageService->>MessageService: Extract parameters (JSON or object)
                MessageService->>MessageService: Store in state.data.actionParams
            end
            
            alt Has Providers
                MessageService->>Provider: Call provider.get()
                Provider-->>MessageService: Context data
                MessageService->>MessageService: Update state
            end
            
            alt Has Action
                MessageService->>Action: Execute with parameters from state
                Action-->>MessageService: ActionResult
                MessageService->>MessageService: Store result in traceActionResult
            end
            
            alt isFinish == true
                Note over MessageService: Exit loop
            end
        end
        
        MessageService->>Runtime: Generate summary prompt
        Runtime->>LLM: Summary request with action history
        
        loop Retry summary parsing
            LLM-->>Runtime: XML summary response
            Runtime->>Runtime: parseKeyValueXml()
            alt Parse Success
                Runtime-->>MessageService: Summary with thought and text
            else Parse Failure
                Runtime-->>MessageService: Fallback summary
            end
        end
        
        MessageService->>User: Final response with summary
    else Single-Shot Mode
        MessageService->>Runtime: processActions()
        Runtime->>Action: Execute action
        Action-->>Runtime: Result
        Runtime-->>MessageService: Response
        MessageService->>User: Direct response
    end
Loading

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@wtfsayo wtfsayo force-pushed the fix/plugin-dummy-services-readme branch from 54dcd6c to a62e249 Compare December 29, 2025 00:37
@elizaOS elizaOS deleted a comment from cursor bot Dec 29, 2025
@elizaOS elizaOS deleted a comment from coderabbitai bot Dec 29, 2025
@elizaOS elizaOS deleted a comment from claude bot Dec 29, 2025
@elizaOS elizaOS deleted a comment from claude bot Dec 29, 2025
@standujar standujar merged commit 5f3dbab into develop Dec 29, 2025
16 checks passed
@standujar standujar deleted the fix/plugin-dummy-services-readme branch December 29, 2025 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants