User Guide - mayukhg/AIAgentTravelPlanner GitHub Wiki

User Guide

Learn how to effectively use the Multi-Agent Assistant System to maximize productivity and get the best results from your AI-powered assistant.

Getting Started

Accessing the Assistant

  1. Open your web browser and navigate to http://localhost:5000
  2. Click "Start Chatting" to access the chat interface
  3. Begin typing your requests in the message input field

First Interaction

Start with a simple greeting to test the system:

Hello! Can you help me get started?

The Personal Assistant Agent will respond and explain its capabilities.

Understanding the Agent System

Agent Types

The system automatically routes your requests to the most appropriate specialized agent:

Personal Assistant Agent

  • Purpose: Main coordinator and general assistance
  • Use for: General questions, task coordination, conversation management
  • Example: "What can you help me with today?"

Calendar Agent

  • Purpose: Schedule and event management
  • Use for: Creating events, checking availability, managing appointments
  • Examples:
    • "Schedule a meeting with John tomorrow at 2 PM"
    • "What do I have scheduled for next week?"
    • "Cancel my 3 PM appointment"

Search Agent

  • Purpose: Real-time web search and information retrieval
  • Use for: Current information, research, fact-checking
  • Examples:
    • "What's the latest news about AI developments?"
    • "Find information about renewable energy trends"
    • "Search for the best restaurants in downtown"

Code Assistant Agent

  • Purpose: Programming help and code generation
  • Use for: Writing code, debugging, explanations, technical guidance
  • Examples:
    • "Write a Python function to calculate fibonacci numbers"
    • "Help me debug this JavaScript error"
    • "Explain how machine learning works"

How Agent Selection Works

The system automatically analyzes your request and routes it to the appropriate agent based on:

  • Keywords and context
  • Request intent
  • Required capabilities
  • Conversation history

You don't need to specify which agent to use - the system handles this intelligently.

Effective Communication Tips

Be Specific and Clear

Good: "Schedule a team meeting for next Tuesday at 10 AM in Conference Room A to discuss the Q4 budget"

Avoid: "Set up a meeting"

Provide Context

Good: "I'm working on a Python web scraping project and getting a 403 error when trying to access https://example.com"

Avoid: "My code doesn't work"

Ask Follow-up Questions

The assistant maintains conversation context, so you can build on previous exchanges:

You: "What's the weather like in New York?"
Assistant: [Provides weather information]
You: "What about tomorrow?"
Assistant: [Provides tomorrow's forecast for New York]

Use Natural Language

Write as you would speak to a colleague:

  • "Can you help me find..."
  • "I need to schedule..."
  • "What's the best way to..."

Common Use Cases

Calendar Management

Creating Events:

"Schedule a doctor's appointment for Friday at 3 PM"
"Block out 2 hours tomorrow morning for project work"
"Set up a recurring team standup every Monday at 9 AM"

Checking Schedule:

"What's on my calendar today?"
"Am I free Thursday afternoon?"
"Show me next week's appointments"

Managing Conflicts:

"I need to reschedule my 2 PM meeting to 4 PM"
"Cancel all meetings on Friday"
"Find a time when both John and Sarah are available"

Information Research

Current Events:

"What's happening in the stock market today?"
"Latest developments in climate change policy"
"Recent cybersecurity threats to be aware of"

Research Tasks:

"Compare different project management methodologies"
"Find statistics on remote work productivity"
"Research best practices for data backup"

Quick Facts:

"Who won the Nobel Prize in Physics this year?"
"What's the population of Tokyo?"
"When was the first iPhone released?"

Programming Assistance

Code Generation:

"Write a REST API endpoint in Flask for user authentication"
"Create a React component for a todo list"
"Generate SQL to find top customers by revenue"

Debugging Help:

"This Python script is throwing a KeyError - can you help?"
"My CSS flexbox layout isn't working as expected"
"Getting a CORS error in my JavaScript fetch request"

Learning and Explanations:

"Explain the difference between REST and GraphQL"
"How does database indexing improve performance?"
"What are the benefits of using Docker containers?"

General Assistance

Planning and Organization:

"Help me plan a presentation on data visualization"
"Create a checklist for launching a new website"
"Suggest a timeline for learning Python programming"

Decision Making:

"Compare the pros and cons of different hosting providers"
"What factors should I consider when choosing a database?"
"Help me evaluate these three job offers"

Advanced Features

Session Continuity

The assistant remembers your conversation within a session:

  • Previous questions and answers
  • Context from earlier exchanges
  • Ongoing tasks and projects

Multi-step Tasks

You can break complex tasks into steps:

You: "I want to organize a team workshop"
Assistant: "I'd be happy to help! Let me gather some details..."

You: "Schedule it for next Friday, 2-4 PM"
Assistant: "I've scheduled the workshop. What topic would you like to cover?"

You: "Agile methodology training"
Assistant: "Great! I can help you create an agenda and find relevant materials."

Error Recovery

If something goes wrong, the assistant will:

  • Explain what happened
  • Suggest alternative approaches
  • Ask for clarification if needed

Best Practices

Do's

  • Be specific about dates, times, and requirements
  • Provide context for technical questions
  • Ask follow-up questions to refine results
  • Use the assistant for both simple and complex tasks

Don'ts

  • Don't share sensitive personal information
  • Don't expect the assistant to access external accounts without proper setup
  • Don't assume the assistant knows unstated preferences
  • Don't hesitate to ask for clarification

Troubleshooting

Common Issues

No Response from Assistant:

  • Check your internet connection
  • Refresh the page and try again
  • Verify the service is running

Incorrect Agent Selection:

  • Be more specific about your request type
  • Use keywords that clearly indicate your intent
  • Provide additional context

Incomplete or Unclear Responses:

  • Ask for more detail or clarification
  • Rephrase your question
  • Break complex requests into smaller parts

Getting Help

If you encounter persistent issues:

  • Check the system health at /api/health
  • Review the troubleshooting guide
  • Report bugs through the appropriate channels

Privacy and Security

Data Handling

  • Conversations are stored temporarily for session continuity
  • No personal data is shared with external services without consent
  • Session data is cleared when you close the browser

Security Features

  • Input validation prevents malicious requests
  • Command execution is filtered and sandboxed
  • Rate limiting prevents abuse

Best Practices

  • Don't share passwords or sensitive credentials
  • Be mindful of confidential information in requests
  • Use the clear session feature when working on sensitive projects

Tips for Maximum Effectiveness

  1. Start Broad, Then Narrow: Begin with general requests and refine based on responses
  2. Use Examples: When explaining requirements, provide concrete examples
  3. Leverage Expertise: Each agent specializes in different domains - let them guide you
  4. Build Incrementally: Use conversation history to build complex solutions step by step
  5. Experiment: Try different phrasings to see how the system responds

Next Steps