Skip to content

Commit eb5b823

Browse files
committed
Add local agent interface and manuals
1 parent 446fefd commit eb5b823

10 files changed

Lines changed: 1860 additions & 8 deletions

.env.example

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ GOOGLE_OAUTH_CONNECTED_EMAIL=
5252
# Optional override. Empty => auto uses current local UI callback URL.
5353
GOOGLE_OAUTH_REDIRECT_URI=
5454
SETUP_WIZARD_COMPLETED=false
55+
AGENT_API_TOKEN=
5556
SEND_NOW_COOLDOWN_SECONDS=300
5657
SENT_HISTORY_DAYS=14
5758

@@ -60,6 +61,13 @@ ENABLE_LLM_AGENT=true
6061
GEMINI_API_KEY=
6162
ENABLE_GEMINI_ADVANCED_REASONING=true
6263
GEMINI_MODEL=gemini-3.1-pro
64+
65+
# Optional OPENAI-compatible backend (LM Studio, vLLM, Ollama OpenAI bridge, etc.)
66+
ENABLE_OPENAI_COMPAT_FALLBACK=false
67+
OPENAI_COMPAT_API_KEY=
68+
OPENAI_COMPAT_MODEL=
69+
OPENAI_COMPAT_API_BASE=
70+
6371
OUTPUT_LANGUAGE=en
6472

6573
# Optional fallback LLM (used when Gemini fails)

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Notes:
3838
## Key Features
3939
- Personalized LLM relevance ranking using your active projects.
4040
- Search intents for recent updates, best-fit papers, and broader discovery.
41+
- Local agent interface with brokered credentials and JSON output.
4142
- Per-project mail cadence (`daily` / `every_3_days` / `weekly`) in Topic Editor.
4243
- Local inbox mode with browser popup scheduling on a running PC.
4344
- Configurable cadence: `daily`, `every_3_days`, `weekly`.
@@ -50,8 +51,10 @@ Notes:
5051
## Quick Start
5152
- Beginner (English): [docs/manuals/MANUAL_FIRSTTIME_EN.md](docs/manuals/MANUAL_FIRSTTIME_EN.md)
5253
- Full operations (English): [docs/manuals/MANUAL_EN.md](docs/manuals/MANUAL_EN.md)
54+
- Agent/tool integration (English): [docs/manuals/MANUAL_AGENT_EN.md](docs/manuals/MANUAL_AGENT_EN.md)
5355
- Beginner (Korean): [docs/manuals/MANUAL_FIRSTTIME_KR.md](docs/manuals/MANUAL_FIRSTTIME_KR.md)
5456
- Full operations (Korean): [docs/manuals/MANUAL_KR.md](docs/manuals/MANUAL_KR.md)
57+
- Agent/tool integration (Korean): [docs/manuals/MANUAL_AGENT_KR.md](docs/manuals/MANUAL_AGENT_KR.md)
5558

5659
## Recommended First Path (Search-First, Local)
5760
Generate your first personalized search result before email or automation setup.
@@ -109,6 +112,18 @@ Main path for onboarding and preview-first setup:
109112
http://127.0.0.1:5050
110113
```
111114

115+
## Agent Mode
116+
Paper Morning can also be used as a local paper-search tool for research agents.
117+
118+
Security model:
119+
- your agent gets `AGENT_API_TOKEN`
120+
- Paper Morning keeps `GEMINI_API_KEY` or local backend credentials in `.env` / keyring
121+
- the agent never needs to see raw provider keys
122+
123+
Interfaces:
124+
- Local HTTP JSON endpoint: `POST /api/agent/search`
125+
- CLI JSON mode: `python app/paper_digest_app.py --agent-search ...`
126+
112127
## Build Distribution Files
113128
### Windows
114129
```powershell

0 commit comments

Comments
 (0)