metadata: author: DataAgent Team version: "1.7.2"

Changelog

• v1.7.2: Use Alibaba Cloud default credential chain instead of explicit AK/SK, add User-Agent header, fix RAM policy wildcard issues
• v1.7.1: Fix CLI

  ls

  command API response parsing (support case-insensitive field names), optimize SKILL documentation structure, separate ANALYSIS mode specification document
• v1.7.0: API_KEY authentication support, native async execution mode, session isolation, enhanced attach mode, optimized log output

Installation

Configure Credentials

Option 1: Default Credential Chain (Recommended)

Option 2: API_KEY Authentication (File Analysis Only)

export DATA_AGENT_API_KEY=your-api-key
export DATA_AGENT_REGION=cn-hangzhou

Permission Requirements

AliyunDMSFullAccess

AliyunDMSDataAgentFullAccess

Debug Mode

DATA_AGENT_DEBUG_API=1 python3 scripts/data_agent_cli.py file example.csv -q "analyze"

💡 Getting Started Tips

• Use the built-in demo database

  internal_data_employees

  (DataAgent's built-in test database containing employee, department, and salary data) for first-time experience
• Or use local file

  assets/example_game_data.csv

  for file analysis experience

Data Agent CLI — Unified Command-Line Data Analysis Tool

Overview

scripts/data_agent_cli.py

Core Concepts

⚠️ Key Prerequisite: Data Agent can only analyze databases that have been imported into Data Agent Data Center.

• Data Center: Data Agent's data center, only databases here can be analyzed
• DMS: Alibaba Cloud Data Management Service, stores metadata of all databases
• Relationship: Databases registered in DMS ≠ Databases in Data Center

Usage Flow:

1. First use

   ls

   to check if the target database exists in Data Center
2. If not found, use

   dms

   subcommand to search for database info, then use

   import

   subcommand to import it
3. After successful import, you can use

   db

   subcommand for analysis

Analysis Modes

• ASK_DATA (default): Synchronous execution, sub-second response, suitable for quick Q&A
• ANALYSIS: Deep analysis, takes 5-40 minutes, requires spawning a sub-agent for async execution or using --async-run parameter

See ANALYSIS_MODE.md for details

Session Reuse

db

file

attach --session-id <ID>

See COMMANDS.md and WORKFLOWS.md for details

Quick Start

# 1. List available databases
python3 scripts/data_agent_cli.py ls

# 2. Query analysis (synchronous response)
python3 scripts/data_agent_cli.py db \
    --dms-instance-id <ID> --dms-db-id <ID> \
    --instance-name <NAME> --db-name <DB> \
    --tables "employees,departments" -q "Which department has the highest average salary"

# 3. Follow-up question (reuse session)
python3 scripts/data_agent_cli.py attach --session-id <ID> -q "Break down by month"

📖 See WORKFLOWS.md and COMMANDS.md for complete workflows, command reference, and best practices

Project Structure

                          # Skill root directory
├── SKILL.md              # This document
├── scripts/              # Source code
│   ├── data_agent/       # SDK module
│   ├── cli/              # CLI module
│   ├── data_agent_cli.py # CLI entry point
│   └── requirements.txt  # Dependencies
├── sessions/             # Session data
└── references/           # Reference documents