Skip to content

Commit d6cf289

Browse files
committed
Update GARSS RSS API skill metadata
1 parent c9e6c6b commit d6cf289

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

skills/garss-studio-rss-api/SKILL.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
11
---
22
name: garss-studio-rss-api
33
description: Use when an AI agent needs to read, refresh, summarize, or inspect RSS news from this GARSS Studio project through its backend API. Covers login with access code, Bearer token usage, reader item endpoints, subscription lookup, and the single-port API constraint.
4+
version: 1.0.0
45
metadata:
56
short-description: Read GARSS Studio RSS news through the backend API
7+
openclaw:
8+
requires:
9+
bins:
10+
- curl
11+
envVars:
12+
- name: GARSS_BASE_URL
13+
required: false
14+
description: Optional GARSS Studio base URL. Defaults to http://127.0.0.1:25173.
15+
- name: GARSS_ACCESS_CODE
16+
required: false
17+
description: Optional GARSS Studio access code. Defaults to banana for the local dev setup.
618
---
719

820
# GARSS Studio RSS API
@@ -15,10 +27,47 @@ Use this skill when the user asks an AI agent to get RSS news from this project,
1527

1628
- Use the single public entrypoint only: `http://127.0.0.1:25173` in local dev unless the user gives another base URL.
1729
- Do not access the backend container port or RSSHub container directly.
30+
- If the local service is not running and the user wants live data, start GARSS Studio from the repository before calling APIs.
1831
- Authenticate before calling protected endpoints.
1932
- Prefer cached reads unless the user explicitly asks to refresh.
2033
- Preserve source names and original article links in user-facing summaries.
2134

35+
## Local Startup
36+
37+
Use these steps when the user asks for live GARSS data and `http://127.0.0.1:25173/api/health` is not reachable.
38+
39+
1. Go to the project:
40+
41+
```bash
42+
cd path/to/garss/garss-studio
43+
```
44+
45+
If the repository is not present, clone `https://github.com/zhaoolee/garss` first, then enter `garss-studio`.
46+
47+
2. Ensure env file exists:
48+
49+
```bash
50+
cp .env.example .env
51+
```
52+
53+
Skip this if `.env` already exists.
54+
55+
3. Start the local development stack:
56+
57+
```bash
58+
docker compose -f docker-compose.dev.yml up --build -d
59+
```
60+
61+
Development mode exposes only one public port: `http://127.0.0.1:25173`. The backend and RSSHub services stay behind the frontend gateway. The dev compose defaults `SCHEDULER_ENABLED=false`, so startup should not trigger a full automatic RSS refresh.
62+
63+
4. Verify service health:
64+
65+
```bash
66+
curl -sS http://127.0.0.1:25173/api/health
67+
```
68+
69+
The browser entry is `http://127.0.0.1:25173/reader?pw=banana`.
70+
2271
## Auth Flow
2372

2473
1. Login:

0 commit comments

Comments
 (0)