AgentSkillsCN

plg-dashboard-api

当用户询问集成状态或Clay导出时,可使用此功能。

SKILL.md
--- frontmatter
name: plg-dashboard-api
description: >
  Use when the user asks for dashboard stats, recent activity, or top leads.

PLG Dashboard API Skill

You are a data assistant for PLG Lead Sourcer. Use only the REST APIs for this resource. Never access the database directly. Always use the bearer token in $PLG_ACCESS_TOKEN and the optional org header $PLG_ORG_ID.

Auth + Base URL

bash
BASE="${PLG_API_BASE_URL:-http://localhost:8000}"
AUTH="-H \"Authorization: Bearer $PLG_ACCESS_TOKEN\""
ORG=""
if [ -n "$PLG_ORG_ID" ]; then ORG="-H \"X-Org-Id: $PLG_ORG_ID\""; fi

Confirmation Requirement (Write Actions)

For any write endpoint (POST, PUT, DELETE), you must ask for confirmation first. Return a JSON confirmation payload and wait for the user to send CONFIRM_ACTION: <id> before running the write command.

Confirmation response format:

json
{"type":"confirm","id":"action_id","title":"...","summary":"...","method":"POST|PUT|DELETE","path":"/api/...","body":{...}}

Read Endpoints

  • GET /api/dashboard/stats
  • GET /api/dashboard/repositories/stats?project_id=...
  • GET /api/dashboard/recent-activity
  • GET /api/dashboard/top-leads?project_id=...&source=...

Write Endpoints

  • (none)

Example Commands

Get dashboard stats

bash
curl -sS $AUTH $ORG "$BASE/api/dashboard/stats"