spring-ai-alibaba · supper-ming · Jan 13, 2026 · Jan 13, 2026 · Jan 14, 2026 · Jan 14, 2026
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -51,6 +51,8 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0
       - uses: ./CI/github-actions/setup-deps
       - run: make tools
       - run: make test

diff --git a/.gitignore b/.gitignore
@@ -57,3 +57,5 @@ modified_mcp_config.json
 .idea/LocalCodeIndex/
 
 uploads/*
+vectorstore/*
+.java-version
diff --git a/.mvn/wrapper/maven-wrapper.properties b/.mvn/wrapper/maven-wrapper.properties
@@ -0,0 +1,3 @@
+wrapperVersion=3.3.4
+distributionType=only-script
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.12/apache-maven-3.9.12-bin.zip
diff --git a/CI/linter/license/.licenserc.yaml b/CI/linter/license/.licenserc.yaml
@@ -82,4 +82,6 @@ header:
     - '**/*.properties'
     - 'CI/linter/codespell/.codespell.ignorewords'
     - 'CI/linter/codespell/.codespell.skip'
+    - 'mvnw'
+    - 'mvnw.cmd'
   comment: never
diff --git a/CONTRIBUTING-en.md b/CONTRIBUTING-en.md
@@ -0,0 +1,78 @@
+[中文](./CONTRIBUTING-zh.md) | English
+
+## How to Contribute
+
+## Thank you for contributing to Spring AI Alibaba-DataAgent!
+
+Since the beginning of open-source development, DataAgent has received a lot of attention from the community. Every issue and PR from the community helps the project and contributes to building a better Spring AI.
+
+We sincerely thank all developers who have submitted issues and PRs to this project. We hope more developers from the community will join us in making this project better.
+
+## How to Contribute
+
+Before contributing code, please take a moment to understand the process for contributing to Spring AI Alibaba.
+
+### What to Contribute?
+
+We welcome any contributions at any time, whether it's a simple typo fix, bug fix, or new feature. Please feel free to raise issues or submit PRs. We also value documentation and integration with other open-source projects, and welcome contributions in these areas.
+
+For complex modifications, we recommend adding a Feature label in an Issue first, with a brief description of the design and changes.
+
+### Where to Start?
+
+If you're a first-time contributor, you can start with tasks from [good first issue](https://github.com/spring-ai-alibaba/DataAgent/labels/good%20first%20issue) and [help wanted](https://github.com/spring-ai-alibaba/DataAgent/labels/help%20wanted).
+
+### Fork the Repository and Clone It Locally
+
+- Click the `Fork` icon in the upper right corner of [this project](https://github.com/spring-ai-alibaba/DataAgent) to fork alibaba/spring-ai-alibaba to your own space.
+- Clone the spring-ai-alibaba repository from your account locally. For example, if your account is `chickenlj`, run `git clone https://github.com/chickenlj/DataAgent.git` to perform the clone operation.
+
+### Configure Github Information
+
+- Run `git config --list` on your machine to view your global git username and email.
+- Check if the displayed user.name and user.email match your github username and email.
+- If your company has its own gitlab or uses other commercial gitlab, there may be a mismatch. In this case, you need to set a separate username and email for the spring-ai-alibaba project.
+- For instructions on setting username and email, please refer to the official github documentation: [Setting your username](https://help.github.com/articles/setting-your-username-in-git/#setting-your-git-username-for-a-single-repository), [Setting your email](https://help.github.com/articles/setting-your-commit-email-address-in-git/).
+
+### Merge Latest Code
+
+After forking, the original repository's main branch may have new commits. To avoid conflicts between your PR and the main branch, you need to merge the main branch in a timely manner.
+
+- In your local spring-ai-alibaba directory, run `git remote add upstream https://github.com/spring-ai-alibaba/DataAgent` to add the original repository address to the remote stream.
+- In your local spring-ai-alibaba directory, run `git fetch upstream` to fetch the remote stream locally.
+- In your local spring-ai-alibaba directory, run `git checkout main` to switch to the main branch.
+- In your local spring-ai-alibaba directory, run `git rebase upstream/main` to rebase the latest code.
+
+### Configure Spring AI Standard Code Format
+
+As an implementation of Spring AI, Spring AI Alibaba directly follows the Spring AI project code standards. Please refer to the relevant code format specifications before starting. You need to configure the code format before submitting code.
+
+### Development
+
+Develop your feature. **After development, we recommend using `mvn clean package` to ensure the modified code compiles locally. This command also automatically formats the code in Spring style**. Then submit the code. Before submitting, create a new branch for this feature and use that branch for code submission.
+
+### Local CI
+
+After completing local development, we strongly recommend running the `make` command provided in the project's `CI\make` directory for local continuous integration (CI) checks before submitting a PR, to ensure the code meets project standards and specifications. If you have any questions about local CI, you can enter `make help` in the console to learn more.
+
+### Local Checkstyle
+
+To reduce unnecessary code style issues, Spring AI Alibaba provides local Checkstyle checking. You can run `mvn checkstyle:check` in the project root directory to check if the code style meets the specifications.
+
+### Remove Unused Imports
+
+To ensure code cleanliness, please remove unused imports from Java files. You can run `mvn spotless:apply` to automatically remove unused imports.
+
+### Submit Latest Code
+
+After coding is complete, you need to format and check the commit message based on the PR specification `[lint-pr-title.yml](.github/workflows/lint-pr-title.yml)` to ensure the commit message meets the specifications.
+Commit format: git commit -m "type(module): space followed by compliant commit message", for example `feat(docs): update contribute-zh`
+
+### Merge Latest Code
+
+- Similarly, before submitting a PR, you need to rebase the main branch code (or the corresponding target branch if your target branch is not main). Please refer to the previous section for specific steps.
+- If there are conflicts, resolve them first.
+
+### Submit PR
+
+Submit a PR, describe the changes and implemented features according to the `Pull request template`, and wait for code review and merge to become a Spring AI Alibaba Contributor and contribute to a better Spring AI Alibaba.
diff --git a/CONTRIBUTING-zh.md b/CONTRIBUTING-zh.md
@@ -1,3 +1,5 @@
+中文 | [English](./CONTRIBUTING-en.md)
+
 ## 如何贡献
 
 ## 感谢你为 Spring AI Alibaba-DateAgent 贡献！

diff --git a/README-en.md b/README-en.md
@@ -0,0 +1,122 @@
+<div align="center">
+  <p><a href="./README.md">中文</a> | English</p>
+  <h1>Spring AI Alibaba DataAgent</h1>
+  <p>
+    <strong>Enterprise-grade Intelligent Data Analyst powered by <a href="https://github.com/alibaba/spring-ai-alibaba" target="_blank">Spring AI Alibaba</a></strong>
+  </p>
+  <p>
+     Text-to-SQL | Python Deep Analysis | Intelligent Reports | MCP Server | RAG Enhancement
+  </p>
+
+  <p>
+    <a href="https://github.com/alibaba/spring-ai-alibaba"><img src="https://img.shields.io/badge/Spring%20AI%20Alibaba-1.1.0.0-blue" alt="Spring AI Alibaba"></a>
+    <img src="https://img.shields.io/badge/Spring%20Boot-3.4.8+-green" alt="Spring Boot">
+    <img src="https://img.shields.io/badge/Java-17+-orange" alt="Java">
+    <img src="https://img.shields.io/badge/License-Apache%202.0-red" alt="License">
+    <a href="https://deepwiki.com/spring-ai-alibaba/DataAgent"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki"></a>
+  </p>
+
+   <p>
+    <a href="#-introduction">Introduction</a> •
+    <a href="#-core-features">Core Features</a> •
+    <a href="#-quick-start">Quick Start</a> •
+    <a href="#-documentation">Documentation</a> •
+    <a href="#-community--contribution">Community</a>
+  </p>
+</div>
+
+<br/>
+
+<div align="center">
+    <img src="img/LOGO.png" alt="DataAgent" width="1807" style="border-radius: 10px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);">
+</div>
+
+<br/>
+
+## Introduction
+
+**DataAgent** is an enterprise-grade intelligent data analysis Agent built on **Spring AI Alibaba Graph**. It goes beyond traditional Text-to-SQL tools, evolving into an AI-powered data analyst capable of executing **Python deep analysis** and generating **multi-dimensional chart reports**.
+
+The system adopts a highly extensible architecture design, **fully compatible with OpenAI API specifications** for chat models and embedding models, and supports **flexible integration with any vector database**. Whether for private deployment or integration with mainstream LLM services (such as Qwen, Deepseek), it can be easily adapted to provide flexible and controllable data insight services for enterprises.
+
+Additionally, this project natively supports **MCP (Model Context Protocol)**, enabling seamless integration as an MCP server into MCP-compatible ecosystem tools such as Claude Desktop.
+
+## Core Features
+
+| Feature | Description |
+| :--- | :--- |
+| **Intelligent Data Analysis** | StateGraph-based Text-to-SQL conversion, supporting complex multi-table queries and multi-turn conversation intent understanding. |
+| **Python Deep Analysis** | Built-in Docker/Local Python executor, automatically generating and executing Python code for statistical analysis and machine learning predictions. |
+| **Intelligent Report Generation** | Analysis results are automatically summarized into HTML/Markdown reports with ECharts visualizations, WYSIWYG. |
+| **Human Feedback Mechanism** | Innovative Human-in-the-loop mechanism, supporting user intervention and adjustments during the plan generation phase. |
+| **RAG Retrieval Enhancement** | Integrated vector database, supporting semantic retrieval of business metadata and terminology libraries to improve SQL generation accuracy. |
+| **Multi-Model Orchestration** | Built-in model registry, supporting runtime dynamic switching between different LLM and Embedding models. |
+| **MCP Server** | Compliant with MCP protocol, supporting external provision of NL2SQL and agent management capabilities as a Tool Server. |
+| **API Key Management** | Comprehensive API Key lifecycle management with fine-grained permission control. |
+
+## Project Structure
+
+![dataagent-structure](img/dataagent-structure.png)
+
+
+## Quick Start
+
+> For detailed installation and configuration guide, please refer to [Quick Start Guide](docs/QUICK_START.md).
+
+### 1. Prerequisites
+- JDK 17+
+- MySQL 5.7+
+- Node.js 16+
+
+### 2. Start Services
+
+```bash
+# 1. Import database
+mysql -u root -p < data-agent-management/src/main/resources/sql/schema.sql
+
+# 2. Start backend
+cd data-agent-management
+./mvnw spring-boot:run
+
+# 3. Start frontend
+cd data-agent-frontend
+npm install && npm run dev
+```
+
+### 3. Access the System
+Open your browser and visit `http://localhost:3000` to start creating your first data agent!
+
+## Documentation
+
+| Document | Contents |
+| :--- | :--- |
+| [Quick Start](docs/QUICK_START.md) | Environment requirements, database import, basic configuration, getting started |
+| [Architecture Design](docs/ARCHITECTURE.md) | System layered architecture, StateGraph and workflow design, core module sequence diagrams |
+| [Developer Guide](docs/DEVELOPER_GUIDE.md) | Development environment setup, detailed configuration manual, coding standards, extension development (vector DB/models) |
+| [Advanced Features](docs/ADVANCED_FEATURES.md) | API Key invocation, MCP server configuration, custom hybrid retrieval strategies, Python executor configuration |
+| [Knowledge Configuration Best Practices](docs/KNOWLEDGE_USAGE.md) | Explanation and usage of semantic models, business knowledge, and agent knowledge |
+
+## Community & Contribution
+
+- **DingTalk Group**: `154405001431` ("DataAgent User Group 1") Some users may not be able to join due to account security issues. If possible, please try with a different account.
+- **Contribution Guide**: Community contributions are welcome! Please refer to the [Developer Guide](docs/DEVELOPER_GUIDE.md) to learn how to submit PRs.
+
+## License
+
+This project is licensed under the Apache License 2.0.
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=spring-ai-alibaba/DataAgent&type=Date)](https://star-history.com/#spring-ai-alibaba/DataAgent&Date)
+
+## Contributors
+
+<a href="https://github.com/spring-ai-alibaba/DataAgent/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=spring-ai-alibaba/DataAgent" />
+</a>
+
+---
+
+<div align="center">
+    Made with ❤️ by Spring AI Alibaba DataAgent Team
+</div>
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 <div align="center">
+  <p>中文 | <a href="./README-en.md">English</a></p>
   <h1>Spring AI Alibaba DataAgent</h1>
   <p>
     <strong>基于 <a href="https://github.com/alibaba/spring-ai-alibaba" target="_blank">Spring AI Alibaba</a> 的企业级智能数据分析师</strong>
@@ -97,7 +98,7 @@ npm install && npm run dev
 
 ## 🤝 加入社区 & 贡献
 
-- **钉钉交流群**: `154405001431` ("DataAgent用户1群")
+- **钉钉交流群**: `154405001431` ("DataAgent用户1群") 部分用户可能因为账号安全问题无法加入，条件允许的情况下可换账号申请。
 - **贡献指南**: 欢迎社区贡献！请查阅 [开发者文档](docs/DEVELOPER_GUIDE.md) 了解如何提交 PR。
 
 ## 📄 许可证

diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,7 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please report any security issue or Higress crash report to [ASRC](https://security.alibaba.com/)(Alibaba Security Response Center) where the issue will be triaged appropriately.
+
+Thank you in advance for helping to keep Spring AI Alibaba DataAgent secure.
diff --git a/data-agent-frontend/.gitignore b/data-agent-frontend/.gitignore
@@ -7,6 +7,7 @@ yarn-error.log*
 pnpm-debug.log*
 lerna-debug.log*
 pnpm-lock.yaml
+pnpm-workspace.yaml
 
 node_modules
 dist

diff --git a/data-agent-frontend/package-lock.json b/data-agent-frontend/package-lock.json
diff --git a/data-agent-frontend/package.json b/data-agent-frontend/package.json
@@ -21,6 +21,8 @@
     "dompurify": "^3.2.4",
     "echarts": "^6.0.0",
     "highlight.js": "^11.11.1",
+    "markdown-it": "^12.0.6",
+    "markdown-it-container": "^3.0.0",
     "marked": "^12.0.2",
     "vue": "^3.4.0",
     "vue-router": "^4.2.0"