From b04dad1fd20ea681a18c3b74849c16664e40e634 Mon Sep 17 00:00:00 2001
From: Soulter <905617992@qq.com>
Date: Mon, 26 Jan 2026 21:21:06 +0800
Subject: [PATCH] docs: add AGENTS.md

---
 AGENTS.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 AGENTS.md

diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 000000000..2ad76a28b
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,33 @@
+## Setup commands
+
+### Core
+
+```
+uv sync
+uv run main.py
+```
+
+Exposed an API server on `http://localhost:6185` by default.
+
+### Dashboard(WebUI)
+
+```
+cd dashboard
+pnpm install # First time only. Use npm install -g pnpm if pnpm is not installed.
+pnpm dev
+```
+
+Runs on `http://localhost:3000` by default.
+
+## Dev environment tips
+
+1. When modifying the WebUI, be sure to maintain componentization and clean code. Avoid duplicate code.
+2. Do not add any report files such as xxx_SUMMARY.md.
+3. After finishing, use `ruff format .` and `ruff check .` to format and check the code.
+4. When committing, ensure to use conventional commits messages, such as `feat: add new agent for data analysis` or `fix: resolve bug in provider manager`.
+5. Use English for all new comments.
+
+## PR instructions
+
+1. Title format: use conventional commit messages
+2. Use English to write PR title and descriptions.