> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Excel Agent

> Excel file processing tools for AI agents.

<Note>
  **Prerequisites**

  * Python 3.10 or higher
  * PraisonAI Agents package installed
  * PraisonAI Tools package installed
  * `openpyxl` package installed
</Note>

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonaiagents import Agent
from praisonai_tools import read_excel, write_excel

agent = Agent(name="Analyst", tools=[read_excel, write_excel])
agent.start("Total revenue in Q1 from reports/sales.xlsx")
```

The user references a spreadsheet; the agent reads and updates Excel workbooks via tools.

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
graph LR
    U[Input] --> A[Agent]
    A --> T[Tool]
    T --> O[Output]

    classDef agent fill:#8B0000,color:#fff
    classDef tool fill:#189AB4,color:#fff

    class A agent
    class U,O tool
    class T tool
```

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
sequenceDiagram
    participant User
    participant Agent
    participant Feature as Excel Agent

    User->>Agent: Request
    Agent->>Feature: Process request
    Feature-->>Agent: Result
    Agent-->>User: Response
```

## Excel Tools

Use Excel Tools to read, write, and manipulate Excel files with AI agents.

<Steps>
  <Step title="Install Dependencies">
    First, install the required packages:

    ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    pip install praisonaiagents praisonai-tools openpyxl
    ```
  </Step>

  <Step title="Import Components">
    Import the necessary components:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    from praisonaiagents import Agent, Task, AgentTeam
    from praisonai_tools import read_excel, write_excel, merge_excel
    ```
  </Step>

  <Step title="Create Agent">
    Create an Excel processing agent:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    excel_agent = Agent(
        name="ExcelProcessor",
        role="Excel Processing Specialist",
        goal="Process Excel files efficiently and accurately.",
        backstory="Expert in Excel file manipulation and analysis.",
        tools=[read_excel, write_excel, merge_excel],
        reflection=False
    )
    ```
  </Step>

  <Step title="Define Task">
    Define the Excel processing task:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    excel_task = Task(
        description="Process and analyze Excel spreadsheet data.",
        expected_output="Processed Excel data with analysis.",
        agent=excel_agent,
        name="excel_processing"
    )
    ```
  </Step>

  <Step title="Run Agent">
    Initialize and run the agent:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    agents = AgentTeam(
        agents=[excel_agent],
        tasks=[excel_task],
        process="sequential"
    )
    agents.start()
    ```
  </Step>
</Steps>

## Understanding Excel Tools

<Card title="What are Excel Tools?" icon="question">
  Excel Tools provide Excel processing capabilities for AI agents:

  * File reading with sheet selection
  * Data writing with formatting
  * Multi-file merging
  * Cell-level operations
  * Format preservation
</Card>

## Key Components

<CardGroup cols={2}>
  <Card title="Excel Agent" icon="user-robot">
    Create specialized Excel agents:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    Agent(tools=[read_excel, write_excel, merge_excel])
    ```
  </Card>

  <Card title="Excel Task" icon="list-check">
    Define Excel tasks:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    Task(description="excel_operation")
    ```
  </Card>

  <Card title="Process Types" icon="arrows-split-up-and-left">
    Sequential or parallel processing:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    process="sequential"
    ```
  </Card>

  <Card title="Excel Options" icon="sliders">
    Customize Excel parameters:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    sheet_name="Sheet1", header=0
    ```
  </Card>
</CardGroup>

## Available Functions

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonai_tools import read_excel
from praisonai_tools import write_excel
from praisonai_tools import merge_excel
```

## Examples

### Basic Excel Processing Agent

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonaiagents import Agent, Task, AgentTeam
from praisonai_tools import read_excel, write_excel, merge_excel

# Create Excel agent
excel_agent = Agent(
    name="ExcelExpert",
    role="Excel Processing Specialist",
    goal="Process Excel files efficiently and accurately.",
    backstory="Expert in spreadsheet analysis and manipulation.",
    tools=[read_excel, write_excel, merge_excel],
    reflection=False
)

# Define Excel task
excel_task = Task(
    description="Process and analyze sales spreadsheets.",
    expected_output="Consolidated sales report.",
    agent=excel_agent,
    name="sales_processing"
)

# Run agent
agents = AgentTeam(
    agents=[excel_agent],
    tasks=[excel_task],
    process="sequential"
)
agents.start()
```

### Advanced Excel Processing with Multiple Agents

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonaiagents import Agent, Task, AgentTeam
from praisonai_tools import read_excel, write_excel, merge_excel

# Create Excel processing agent
processor_agent = Agent(
    name="Processor",
    role="Excel Processor",
    goal="Process Excel files systematically.",
    tools=[read_excel, write_excel, merge_excel],
    reflection=False
)

# Create analysis agent
analysis_agent = Agent(
    name="Analyzer",
    role="Data Analyst",
    goal="Analyze processed Excel data.",
    backstory="Expert in data analysis and reporting.",
    reflection=False
)

# Define tasks
processing_task = Task(
    description="Process and merge Excel files.",
    agent=processor_agent,
    name="excel_processing"
)

analysis_task = Task(
    description="Analyze processed data and create reports.",
    agent=analysis_agent,
    name="excel_analysis"
)

# Run agents
agents = AgentTeam(
    agents=[processor_agent, analysis_agent],
    tasks=[processing_task, analysis_task],
    process="sequential"
)
agents.start()
```

## Best Practices

<AccordionGroup>
  <Accordion title="Agent Configuration">
    Configure agents with clear Excel focus:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    from praisonai_tools import read_excel, write_excel, merge_excel

    Agent(
        name="ExcelProcessor",
        role="Excel Processing Specialist",
        goal="Process Excel files accurately and efficiently",
        tools=[read_excel, write_excel, merge_excel]
    )
    ```
  </Accordion>

  <Accordion title="Task Definition">
    Define specific Excel operations:

    ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    Task(
        description="Process sales reports and generate summaries",
        expected_output="Consolidated sales report"
    )
    ```
  </Accordion>
</AccordionGroup>

## Common Patterns

### Excel Processing Pipeline

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonaiagents import Agent, Task, AgentTeam
from praisonai_tools import read_excel, write_excel, merge_excel

# Processing agent
processor = Agent(
    name="Processor",
    role="Excel Processor",
    tools=[read_excel, write_excel, merge_excel]
)

# Analysis agent
analyzer = Agent(
    name="Analyzer",
    role="Data Analyst"
)

# Define tasks
process_task = Task(
    description="Process Excel files",
    agent=processor
)

analyze_task = Task(
    description="Analyze processed data",
    agent=analyzer
)

# Run workflow
agents = AgentTeam(
    agents=[processor, analyzer],
    tasks=[process_task, analyze_task]
)
```

## Related

<CardGroup cols={2}>
  <Card title="Custom Tools" icon="wrench" href="/docs/tools/custom">
    Build your own agent tools
  </Card>

  <Card title="Tools Overview" icon="toolbox" href="/docs/tools/tools">
    Browse PraisonAI tool documentation
  </Card>
</CardGroup>