docs: add AGENTS.md for agent documentation guidelines
This commit is contained in:
34
AGENTS.md
Normal file
34
AGENTS.md
Normal file
@@ -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`
|
||||||
Reference in New Issue
Block a user