-
Notifications
You must be signed in to change notification settings - Fork 5
Open
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Overview
Many error messages in the codebase are generic or lack context, making it difficult for users to understand what went wrong and how to fix it. We need more descriptive, actionable error messages.
Current State
Several places in the code use generic error messages like:
- "Error tracking tool"
- "Critical error"
- "Failed to initialize"
These don't provide enough information for users to diagnose and fix issues.
Requirements
Improve error messages to include:
- What went wrong - Clear description of the error
- Why it happened - Context about the cause
- How to fix it - Actionable steps or hints
- Where it occurred - Module/function context
Examples of Improvements Needed
Before: "Error tracking tool"
After: "Failed to track tool 'my_tool': Tool registration must occur before first use"
Before: "Failed to initialize exporter"
After: "Failed to initialize OTLP exporter: Invalid endpoint URL 'not-a-url'. Please provide a valid HTTP/HTTPS URL"
Why This Matters
- Reduces user frustration when things go wrong
- Decreases support burden
- Helps users self-diagnose issues
- Improves overall developer experience
- Makes debugging faster
Acceptance Criteria
- Identify at least 10 generic error messages
- Replace with descriptive, actionable messages
- Include relevant context (values, settings, etc.)
- Maintain consistent error message format
- Don't expose sensitive information
- Update any related tests
Getting Started
- Search for generic error strings in the codebase
- Look for Exception raises and error logs
- Understand the context of each error
- Write clear, helpful replacement messages
- Test that new messages appear correctly
Notes
- Keep messages concise but informative
- Use consistent formatting across all messages
- Consider adding error codes for common issues
- Think about the user's perspective
- Don't include internal implementation details users won't understand
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed