docs(plugin-dummy-services): add comprehensive README #6290
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added comprehensive README.md documentation for the
@elizaos/plugin-dummy-servicespackage.Documentation Includes
Test plan
🤖 Generated with Claude Code
Note
Provides full documentation for
@elizaos/plugin-dummy-servicesto enable testing agents without external dependencies.token_data,lp,wallet,pdf,video,browser,transcription,web_search,email) with code snippetsWritten 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-servicespackage. 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:
Key additions:
Confidence Score: 4/5
Important Files Changed
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