From 0a157288b775305e014bc8f0321fd73e321e00f4 Mon Sep 17 00:00:00 2001 From: aserrador Date: Sun, 8 Mar 2026 00:07:44 -0500 Subject: [PATCH] docs: add AGENTS.md for agent documentation guidelines --- AGENTS.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..aed0303 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,34 @@ +# AGENTS.md + +This file specifies documentation guidelines for the NaliiaBot project. + +## Project Overview + +NaliiaBot is a conversational agent based on LangGraph for appointment scheduling management. It provides customer service through a Telegram-like interface and integrates with LLM models (Anthropic Claude, DeepSeek). + +## Key Components + +| Component | Path | Description | +|-----------|------|-------------| +| Agent | `src/naliiabot/bot/agent/agent.py` | LangGraph-based conversational agent | +| Tools | `src/naliiabot/bot/tools/naliia_tools.py` | Tools available to the agent | +| API | `src/naliiabotapi/main.py` | FastAPI REST API | +| Database | `docker-compose.yaml` | PostgreSQL for state checkpointing | + +## Available Commands + +- `task dev` - Run API server on port 8010 +- `task test` - Run all tests with pytest +- `task test-cov` - Run tests with coverage report + +## Development Notes + +- Uses Python 3.13 +- LLM models configured via `LLM_MODEL` env var (default: "deepseek") +- MCP server runs on `http://localhost:8001/mcp` +- Database uses PostgreSQL with checkpoint persistence +- Timezone: America/Bogota + +## Testing + +Run tests with: `pytest -v`