@laitszkin/apollo-toolkit 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +62 -0
- package/CHANGELOG.md +100 -0
- package/LICENSE +21 -0
- package/README.md +144 -0
- package/align-project-documents/SKILL.md +94 -0
- package/align-project-documents/agents/openai.yaml +4 -0
- package/analyse-app-logs/LICENSE +21 -0
- package/analyse-app-logs/README.md +126 -0
- package/analyse-app-logs/SKILL.md +121 -0
- package/analyse-app-logs/agents/openai.yaml +4 -0
- package/analyse-app-logs/references/investigation-checklist.md +58 -0
- package/analyse-app-logs/references/log-signal-patterns.md +52 -0
- package/answering-questions-with-research/SKILL.md +46 -0
- package/answering-questions-with-research/agents/openai.yaml +4 -0
- package/bin/apollo-toolkit.js +7 -0
- package/commit-and-push/LICENSE +21 -0
- package/commit-and-push/README.md +26 -0
- package/commit-and-push/SKILL.md +70 -0
- package/commit-and-push/agents/openai.yaml +4 -0
- package/commit-and-push/references/branch-naming.md +15 -0
- package/commit-and-push/references/commit-messages.md +19 -0
- package/deep-research-topics/LICENSE +21 -0
- package/deep-research-topics/README.md +43 -0
- package/deep-research-topics/SKILL.md +84 -0
- package/deep-research-topics/agents/openai.yaml +4 -0
- package/develop-new-features/LICENSE +21 -0
- package/develop-new-features/README.md +52 -0
- package/develop-new-features/SKILL.md +105 -0
- package/develop-new-features/agents/openai.yaml +4 -0
- package/develop-new-features/references/testing-e2e.md +35 -0
- package/develop-new-features/references/testing-integration.md +42 -0
- package/develop-new-features/references/testing-property-based.md +44 -0
- package/develop-new-features/references/testing-unit.md +37 -0
- package/discover-edge-cases/CHANGELOG.md +19 -0
- package/discover-edge-cases/LICENSE +21 -0
- package/discover-edge-cases/README.md +87 -0
- package/discover-edge-cases/SKILL.md +124 -0
- package/discover-edge-cases/agents/openai.yaml +4 -0
- package/discover-edge-cases/references/architecture-edge-cases.md +41 -0
- package/discover-edge-cases/references/code-edge-cases.md +46 -0
- package/docs-to-voice/.env.example +106 -0
- package/docs-to-voice/CHANGELOG.md +71 -0
- package/docs-to-voice/LICENSE +21 -0
- package/docs-to-voice/README.md +118 -0
- package/docs-to-voice/SKILL.md +107 -0
- package/docs-to-voice/agents/openai.yaml +4 -0
- package/docs-to-voice/scripts/docs_to_voice.py +1385 -0
- package/docs-to-voice/scripts/docs_to_voice.sh +11 -0
- package/docs-to-voice/tests/test_docs_to_voice_api_max_chars.py +210 -0
- package/docs-to-voice/tests/test_docs_to_voice_sentence_timeline.py +115 -0
- package/docs-to-voice/tests/test_docs_to_voice_settings.py +43 -0
- package/docs-to-voice/tests/test_docs_to_voice_speech_rate.py +57 -0
- package/enhance-existing-features/CHANGELOG.md +35 -0
- package/enhance-existing-features/LICENSE +21 -0
- package/enhance-existing-features/README.md +54 -0
- package/enhance-existing-features/SKILL.md +120 -0
- package/enhance-existing-features/agents/openai.yaml +4 -0
- package/enhance-existing-features/references/e2e-tests.md +25 -0
- package/enhance-existing-features/references/integration-tests.md +30 -0
- package/enhance-existing-features/references/property-based-tests.md +33 -0
- package/enhance-existing-features/references/unit-tests.md +29 -0
- package/feature-propose/LICENSE +21 -0
- package/feature-propose/README.md +23 -0
- package/feature-propose/SKILL.md +107 -0
- package/feature-propose/agents/openai.yaml +4 -0
- package/feature-propose/references/enhancement-features.md +25 -0
- package/feature-propose/references/important-features.md +25 -0
- package/feature-propose/references/mvp-features.md +25 -0
- package/feature-propose/references/performance-features.md +25 -0
- package/financial-research/SKILL.md +208 -0
- package/financial-research/agents/openai.yaml +4 -0
- package/financial-research/assets/weekly_market_report_template.md +45 -0
- package/fix-github-issues/SKILL.md +98 -0
- package/fix-github-issues/agents/openai.yaml +4 -0
- package/fix-github-issues/scripts/list_issues.py +148 -0
- package/fix-github-issues/tests/test_list_issues.py +127 -0
- package/generate-spec/LICENSE +21 -0
- package/generate-spec/README.md +61 -0
- package/generate-spec/SKILL.md +96 -0
- package/generate-spec/agents/openai.yaml +4 -0
- package/generate-spec/references/templates/checklist.md +78 -0
- package/generate-spec/references/templates/spec.md +55 -0
- package/generate-spec/references/templates/tasks.md +35 -0
- package/generate-spec/scripts/create-specs +123 -0
- package/harden-app-security/CHANGELOG.md +27 -0
- package/harden-app-security/LICENSE +21 -0
- package/harden-app-security/README.md +46 -0
- package/harden-app-security/SKILL.md +127 -0
- package/harden-app-security/agents/openai.yaml +4 -0
- package/harden-app-security/references/agent-attack-catalog.md +117 -0
- package/harden-app-security/references/common-software-attack-catalog.md +168 -0
- package/harden-app-security/references/red-team-extreme-scenarios.md +81 -0
- package/harden-app-security/references/risk-checklist.md +78 -0
- package/harden-app-security/references/security-test-patterns-agent.md +101 -0
- package/harden-app-security/references/security-test-patterns-finance.md +88 -0
- package/harden-app-security/references/test-snippets.md +73 -0
- package/improve-observability/SKILL.md +114 -0
- package/improve-observability/agents/openai.yaml +4 -0
- package/learn-skill-from-conversations/CHANGELOG.md +15 -0
- package/learn-skill-from-conversations/LICENSE +22 -0
- package/learn-skill-from-conversations/README.md +47 -0
- package/learn-skill-from-conversations/SKILL.md +85 -0
- package/learn-skill-from-conversations/agents/openai.yaml +4 -0
- package/learn-skill-from-conversations/scripts/extract_recent_conversations.py +369 -0
- package/learn-skill-from-conversations/tests/test_extract_recent_conversations.py +176 -0
- package/learning-error-book/SKILL.md +112 -0
- package/learning-error-book/agents/openai.yaml +4 -0
- package/learning-error-book/assets/error_book_template.md +66 -0
- package/learning-error-book/scripts/render_markdown_to_pdf.py +367 -0
- package/lib/cli.js +338 -0
- package/lib/installer.js +225 -0
- package/maintain-project-constraints/SKILL.md +109 -0
- package/maintain-project-constraints/agents/openai.yaml +4 -0
- package/maintain-skill-catalog/README.md +18 -0
- package/maintain-skill-catalog/SKILL.md +66 -0
- package/maintain-skill-catalog/agents/openai.yaml +4 -0
- package/novel-to-short-video/CHANGELOG.md +53 -0
- package/novel-to-short-video/LICENSE +21 -0
- package/novel-to-short-video/README.md +63 -0
- package/novel-to-short-video/SKILL.md +233 -0
- package/novel-to-short-video/agents/openai.yaml +4 -0
- package/novel-to-short-video/references/plan-template.md +71 -0
- package/novel-to-short-video/references/roles-json.md +41 -0
- package/open-github-issue/LICENSE +21 -0
- package/open-github-issue/README.md +97 -0
- package/open-github-issue/SKILL.md +119 -0
- package/open-github-issue/agents/openai.yaml +4 -0
- package/open-github-issue/scripts/open_github_issue.py +380 -0
- package/open-github-issue/tests/test_open_github_issue.py +159 -0
- package/open-source-pr-workflow/CHANGELOG.md +32 -0
- package/open-source-pr-workflow/LICENSE +21 -0
- package/open-source-pr-workflow/README.md +23 -0
- package/open-source-pr-workflow/SKILL.md +123 -0
- package/open-source-pr-workflow/agents/openai.yaml +4 -0
- package/openai-text-to-image-storyboard/.env.example +10 -0
- package/openai-text-to-image-storyboard/CHANGELOG.md +49 -0
- package/openai-text-to-image-storyboard/LICENSE +21 -0
- package/openai-text-to-image-storyboard/README.md +99 -0
- package/openai-text-to-image-storyboard/SKILL.md +107 -0
- package/openai-text-to-image-storyboard/agents/openai.yaml +4 -0
- package/openai-text-to-image-storyboard/scripts/generate_storyboard_images.py +763 -0
- package/package.json +36 -0
- package/record-spending/SKILL.md +113 -0
- package/record-spending/agents/openai.yaml +4 -0
- package/record-spending/references/account-format.md +33 -0
- package/record-spending/references/workbook-layout.md +84 -0
- package/resolve-review-comments/SKILL.md +122 -0
- package/resolve-review-comments/agents/openai.yaml +4 -0
- package/resolve-review-comments/references/adoption-criteria.md +23 -0
- package/resolve-review-comments/scripts/review_threads.py +425 -0
- package/resolve-review-comments/tests/test_review_threads.py +74 -0
- package/review-change-set/LICENSE +21 -0
- package/review-change-set/README.md +55 -0
- package/review-change-set/SKILL.md +103 -0
- package/review-change-set/agents/openai.yaml +4 -0
- package/review-codebases/LICENSE +21 -0
- package/review-codebases/README.md +67 -0
- package/review-codebases/SKILL.md +109 -0
- package/review-codebases/agents/openai.yaml +4 -0
- package/scripts/install_skills.ps1 +283 -0
- package/scripts/install_skills.sh +262 -0
- package/scripts/validate_openai_agent_config.py +194 -0
- package/scripts/validate_skill_frontmatter.py +110 -0
- package/specs-to-project-docs/LICENSE +21 -0
- package/specs-to-project-docs/README.md +57 -0
- package/specs-to-project-docs/SKILL.md +111 -0
- package/specs-to-project-docs/agents/openai.yaml +4 -0
- package/specs-to-project-docs/references/templates/architecture.md +29 -0
- package/specs-to-project-docs/references/templates/configuration.md +29 -0
- package/specs-to-project-docs/references/templates/developer-guide.md +33 -0
- package/specs-to-project-docs/references/templates/docs-index.md +39 -0
- package/specs-to-project-docs/references/templates/features.md +25 -0
- package/specs-to-project-docs/references/templates/getting-started.md +38 -0
- package/specs-to-project-docs/references/templates/readme.md +49 -0
- package/systematic-debug/LICENSE +21 -0
- package/systematic-debug/README.md +81 -0
- package/systematic-debug/SKILL.md +59 -0
- package/systematic-debug/agents/openai.yaml +4 -0
- package/text-to-short-video/.env.example +36 -0
- package/text-to-short-video/LICENSE +21 -0
- package/text-to-short-video/README.md +82 -0
- package/text-to-short-video/SKILL.md +221 -0
- package/text-to-short-video/agents/openai.yaml +4 -0
- package/text-to-short-video/scripts/enforce_video_aspect_ratio.py +350 -0
- package/version-release/CHANGELOG.md +53 -0
- package/version-release/LICENSE +21 -0
- package/version-release/README.md +28 -0
- package/version-release/SKILL.md +94 -0
- package/version-release/agents/openai.yaml +4 -0
- package/version-release/references/branch-naming.md +15 -0
- package/version-release/references/changelog-writing.md +8 -0
- package/version-release/references/commit-messages.md +19 -0
- package/version-release/references/readme-writing.md +12 -0
- package/version-release/references/semantic-versioning.md +12 -0
- package/video-production/CHANGELOG.md +104 -0
- package/video-production/LICENSE +18 -0
- package/video-production/README.md +68 -0
- package/video-production/SKILL.md +213 -0
- package/video-production/agents/openai.yaml +4 -0
- package/video-production/references/plan-template.md +54 -0
- package/video-production/references/roles-json.md +41 -0
- package/weekly-financial-event-report/SKILL.md +195 -0
- package/weekly-financial-event-report/agents/openai.yaml +4 -0
- package/weekly-financial-event-report/assets/financial_event_report_template.md +53 -0
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: analyse-app-logs
|
|
3
|
+
description: Comprehensive application log investigation workflow that reads logs end-to-end, correlates signals with code paths and runtime context, and identifies evidence-backed issues with impact and remediation steps. Use when users ask to analyze logs, investigate incidents, find root causes from log records, explain recurring warnings/errors, or check whether logs reveal hidden system problems.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Analyse App Logs
|
|
7
|
+
|
|
8
|
+
## Dependencies
|
|
9
|
+
|
|
10
|
+
- Required: none.
|
|
11
|
+
- Conditional: `open-github-issue` when confirmed issues should be published.
|
|
12
|
+
- Optional: none.
|
|
13
|
+
- Fallback: If publication is needed and `open-github-issue` is unavailable, return draft issue content instead of inventing another publisher.
|
|
14
|
+
|
|
15
|
+
## Standards
|
|
16
|
+
|
|
17
|
+
- Evidence: Use a bounded investigation window and correlate log lines with code, runtime context, and concrete identifiers.
|
|
18
|
+
- Execution: Scope the incident, build a timeline, validate candidate issues, then prioritize and optionally publish them.
|
|
19
|
+
- Quality: Separate confirmed issues from hypotheses and include time-window, log, code, impact, and confidence evidence for each report.
|
|
20
|
+
- Output: Return incident summary, confirmed issues, hypotheses, monitoring improvements, and publication status.
|
|
21
|
+
|
|
22
|
+
## Overview
|
|
23
|
+
|
|
24
|
+
Use this skill to analyze application logs systematically with the codebase and runtime context, then report confirmed issues with clear evidence, confidence, and next actions.
|
|
25
|
+
|
|
26
|
+
## Core principles
|
|
27
|
+
|
|
28
|
+
- Prioritize evidence over assumptions; avoid speculative conclusions.
|
|
29
|
+
- Prefer a bounded, recent investigation window over unbounded history; anchor analysis on a concrete time boundary such as the last container restart, pod recreation, deploy, or first failure.
|
|
30
|
+
- Correlate log symptoms with code paths, configuration, and external dependencies.
|
|
31
|
+
- Distinguish clearly between confirmed issues and hypotheses.
|
|
32
|
+
- Keep findings actionable: impact, urgency, and fix direction.
|
|
33
|
+
|
|
34
|
+
## Workflow
|
|
35
|
+
|
|
36
|
+
1. Define investigation scope
|
|
37
|
+
- Confirm service/component, environment, and incident time window.
|
|
38
|
+
- If the user does not provide a trustworthy window, derive one from a concrete runtime boundary first, such as the last container restart, pod recreation, deploy start, worker boot, or first failure after a known healthy state.
|
|
39
|
+
- Prefer analyzing logs only inside that bounded window first (for example, from the last restart until now) to avoid stale logs polluting the diagnosis; widen the window only when the bounded slice cannot explain the symptom.
|
|
40
|
+
- Identify relevant identifiers (trace ID, request ID, user ID, job ID, tx hash).
|
|
41
|
+
2. Build a timeline from logs
|
|
42
|
+
- Extract key events in chronological order within the chosen window: deploys, config changes, warnings, errors, retries, and recoveries.
|
|
43
|
+
- Group repeated symptoms by signature (error type, message prefix, stack frame, endpoint).
|
|
44
|
+
3. Correlate across context
|
|
45
|
+
- Link related log lines using identifiers and timestamps.
|
|
46
|
+
- Map stack traces and log messages to exact code locations.
|
|
47
|
+
- Cross-check with runtime context (feature flags, env vars, dependency health, upstream/downstream services).
|
|
48
|
+
4. Validate candidate issues
|
|
49
|
+
- Use `references/investigation-checklist.md` to verify each candidate issue before reporting.
|
|
50
|
+
- Use `references/log-signal-patterns.md` to classify common failure patterns and avoid false positives.
|
|
51
|
+
5. Prioritize and propose actions
|
|
52
|
+
- Rank by severity and user/business impact.
|
|
53
|
+
- Recommend the smallest safe fixes first.
|
|
54
|
+
- Suggest additional instrumentation only when current logs cannot confirm root cause.
|
|
55
|
+
6. Publish confirmed issues through dependency skill
|
|
56
|
+
- Invoke `open-github-issue` once per confirmed issue.
|
|
57
|
+
- Pass the prepared title, problem description, suspected cause, reproduction conditions, and target repo.
|
|
58
|
+
- Reuse the dependency output to report `gh-cli` / `github-token` / `draft-only` publication mode.
|
|
59
|
+
|
|
60
|
+
## Evidence requirements
|
|
61
|
+
|
|
62
|
+
For each reported issue, include:
|
|
63
|
+
|
|
64
|
+
- Time-window evidence: selected start/end boundaries, timezone, and why this window was chosen.
|
|
65
|
+
- Log evidence: concrete lines, timestamps, IDs, and frequency.
|
|
66
|
+
- Code evidence: `path:line` mapping to the probable failing logic.
|
|
67
|
+
- Impact statement: affected functionality, users, or data integrity risk.
|
|
68
|
+
- Confidence level: high / medium / low, with reason.
|
|
69
|
+
|
|
70
|
+
If evidence is insufficient, report as **hypothesis** and specify exactly what additional logs/metrics are needed.
|
|
71
|
+
|
|
72
|
+
## GitHub issue handoff rules
|
|
73
|
+
|
|
74
|
+
For each confirmed issue, delegate exactly one GitHub issue publication to `open-github-issue`.
|
|
75
|
+
|
|
76
|
+
Pass these fields to the dependency skill:
|
|
77
|
+
|
|
78
|
+
- `title`: short symptom summary such as `[Log] payment timeout spike`
|
|
79
|
+
- `problem-description`: symptom, impact, and key log evidence
|
|
80
|
+
- `suspected-cause`: `path:line`, causal chain, and confidence
|
|
81
|
+
- `reproduction`: steps/conditions if known; otherwise leave empty
|
|
82
|
+
- `repo`: target repository in `owner/repo` format when known
|
|
83
|
+
|
|
84
|
+
Issue body sections must always include these three parts:
|
|
85
|
+
|
|
86
|
+
- Chinese-language repositories: use localized equivalents of
|
|
87
|
+
`Problem Description`, `Suspected Cause`, and `Reproduction Conditions (if available)`.
|
|
88
|
+
- Non-Chinese repositories: use
|
|
89
|
+
`Problem Description`, `Suspected Cause`, and `Reproduction Conditions (if available)`.
|
|
90
|
+
|
|
91
|
+
If reproduction is unknown, let `open-github-issue` insert the default language-appropriate non-reproducible note.
|
|
92
|
+
|
|
93
|
+
## Output format
|
|
94
|
+
|
|
95
|
+
Use this structure in responses:
|
|
96
|
+
|
|
97
|
+
1. Incident summary
|
|
98
|
+
- Scope, timeframe, and overall health status.
|
|
99
|
+
2. Confirmed issues (ordered by severity)
|
|
100
|
+
- Symptom
|
|
101
|
+
- Log evidence
|
|
102
|
+
- Code correlation (`path:line`)
|
|
103
|
+
- Root cause analysis
|
|
104
|
+
- Impact
|
|
105
|
+
- Recommended remediation
|
|
106
|
+
3. Hypotheses and required validation
|
|
107
|
+
- What is suspected
|
|
108
|
+
- Why confidence is limited
|
|
109
|
+
- Required data to confirm/deny
|
|
110
|
+
4. Monitoring and prevention improvements
|
|
111
|
+
- Missing alerts/log fields
|
|
112
|
+
- Suggested guardrails or dashboards
|
|
113
|
+
5. GitHub issue publication status
|
|
114
|
+
- Publication mode (`gh-cli` / `github-token` / `draft-only`)
|
|
115
|
+
- Created issue URLs or draft bodies with fallback reason
|
|
116
|
+
|
|
117
|
+
## Resources
|
|
118
|
+
|
|
119
|
+
- `references/investigation-checklist.md`: Step-by-step checklist for evidence-driven log investigations.
|
|
120
|
+
- `references/log-signal-patterns.md`: Common log signatures, likely causes, validation hints, and false-positive guards.
|
|
121
|
+
- Dependency skill: `open-github-issue` for deterministic issue publishing with auth fallback and README language detection.
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
interface:
|
|
2
|
+
display_name: "Analyse App Logs"
|
|
3
|
+
short_description: "Analyze logs with code context to detect issues"
|
|
4
|
+
default_prompt: "Use $analyse-app-logs to inspect application logs with code context, first anchor the investigation to a bounded recent time window such as the last container restart or deploy, identify evidence-backed issues, suggest concrete remediation steps, and delegate confirmed GitHub issue publication to $open-github-issue."
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Investigation Checklist
|
|
2
|
+
|
|
3
|
+
Use this checklist before finalizing conclusions.
|
|
4
|
+
|
|
5
|
+
## 1) Scope and data quality
|
|
6
|
+
|
|
7
|
+
- [ ] Confirm the exact incident window (start/end time and timezone).
|
|
8
|
+
- [ ] Prefer a fixed, recent window anchored to a concrete runtime boundary (last container restart, pod recreation, deploy, worker boot, or first post-recovery failure).
|
|
9
|
+
- [ ] If no explicit window is given, derive one before reading broad log history and record why it was chosen.
|
|
10
|
+
- [ ] Confirm logs come from the correct service, environment, and version.
|
|
11
|
+
- [ ] Confirm log completeness (no ingestion gaps, rotated files missing, or sampling blind spots).
|
|
12
|
+
|
|
13
|
+
## 2) Signal extraction
|
|
14
|
+
|
|
15
|
+
- [ ] Collect all `ERROR` and `WARN` signatures within the window.
|
|
16
|
+
- [ ] Count frequency and burst periods for each signature.
|
|
17
|
+
- [ ] Identify leading indicators before the first hard failure.
|
|
18
|
+
|
|
19
|
+
## 3) Correlation
|
|
20
|
+
|
|
21
|
+
- [ ] Correlate events by trace/request/job/transaction ID.
|
|
22
|
+
- [ ] Correlate failures with deploys, config changes, and dependency incidents.
|
|
23
|
+
- [ ] Correlate user-facing symptoms with backend exceptions.
|
|
24
|
+
|
|
25
|
+
## 4) Code mapping
|
|
26
|
+
|
|
27
|
+
- [ ] Map stack traces/log callsites to concrete code locations.
|
|
28
|
+
- [ ] Verify execution path and guard conditions around the failing point.
|
|
29
|
+
- [ ] Check recent changes in related modules and configuration defaults.
|
|
30
|
+
|
|
31
|
+
## 5) Root-cause validation
|
|
32
|
+
|
|
33
|
+
- [ ] Confirm at least one reproducible or strongly evidenced causal chain.
|
|
34
|
+
- [ ] Rule out common alternatives (bad input, timeout, dependency outage, race condition, resource pressure).
|
|
35
|
+
- [ ] Mark unverified claims as hypotheses, not confirmed findings.
|
|
36
|
+
|
|
37
|
+
## 6) Impact and prioritization
|
|
38
|
+
|
|
39
|
+
- [ ] Define affected users/systems and blast radius.
|
|
40
|
+
- [ ] Estimate severity (critical/high/medium/low) using impact × frequency.
|
|
41
|
+
- [ ] Separate immediate containment steps from permanent fixes.
|
|
42
|
+
|
|
43
|
+
## 7) Preventive improvements
|
|
44
|
+
|
|
45
|
+
- [ ] Identify missing log fields needed for faster diagnosis.
|
|
46
|
+
- [ ] Suggest alert thresholds for early detection.
|
|
47
|
+
- [ ] Recommend observability gaps to close (metrics/traces/health checks).
|
|
48
|
+
|
|
49
|
+
## 8) GitHub issue publication
|
|
50
|
+
|
|
51
|
+
- [ ] Resolve target repo (`--repo owner/name` or git `origin`).
|
|
52
|
+
- [ ] Detect issue language from target repo remote README (Chinese repo -> localized issue body; otherwise English issue body).
|
|
53
|
+
- [ ] If `gh auth status` succeeds, publish with `gh issue create`.
|
|
54
|
+
- [ ] If `gh` is not authenticated, publish with `GITHUB_TOKEN`/`GH_TOKEN` via REST API.
|
|
55
|
+
- [ ] If both auth paths are unavailable, return draft issue content and reason.
|
|
56
|
+
- [ ] Ensure every issue body includes `Problem Description` (or localized equivalent).
|
|
57
|
+
- [ ] Ensure every issue body includes `Suspected Cause` (or localized equivalent).
|
|
58
|
+
- [ ] Ensure every issue body includes `Reproduction Conditions (if available)` (or localized equivalent).
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Log Signal Patterns
|
|
2
|
+
|
|
3
|
+
Map common log signals to likely causes. Always validate with surrounding context.
|
|
4
|
+
|
|
5
|
+
## Timeout / deadline exceeded
|
|
6
|
+
|
|
7
|
+
- Typical signals: `timeout`, `deadline exceeded`, `upstream request timed out`
|
|
8
|
+
- Common causes: upstream latency spike, connection pool exhaustion, DNS/TLS stalls
|
|
9
|
+
- Validate by checking: dependency latency trend, queue depth, connection usage, retry storms
|
|
10
|
+
- False-positive guard: short-lived network blips may not explain sustained failures
|
|
11
|
+
|
|
12
|
+
## Retry storm / thundering herd
|
|
13
|
+
|
|
14
|
+
- Typical signals: repeated retry messages with shrinking intervals
|
|
15
|
+
- Common causes: missing backoff/jitter, synchronized workers, transient dependency failures
|
|
16
|
+
- Validate by checking: retry counts, concurrency bursts, same request IDs repeated rapidly
|
|
17
|
+
- False-positive guard: scheduled batch windows can look bursty but expected
|
|
18
|
+
|
|
19
|
+
## Authentication / authorization failures
|
|
20
|
+
|
|
21
|
+
- Typical signals: `401`, `403`, `invalid token`, `signature mismatch`, `permission denied`
|
|
22
|
+
- Common causes: expired credentials, clock skew, role misconfiguration, key rotation mismatch
|
|
23
|
+
- Validate by checking: token expiry, IAM/ACL changes, auth service logs, server clock drift
|
|
24
|
+
- False-positive guard: malicious probing traffic may not indicate platform regression
|
|
25
|
+
|
|
26
|
+
## Resource exhaustion
|
|
27
|
+
|
|
28
|
+
- Typical signals: `OOM`, `too many open files`, `connection refused`, `cannot allocate memory`
|
|
29
|
+
- Common causes: memory leaks, unbounded queues, file descriptor leaks, pool mis-sizing
|
|
30
|
+
- Validate by checking: memory/FD trends, GC pauses, restart cadence, worker lifecycle
|
|
31
|
+
- False-positive guard: one-off deploy spikes can mimic leaks
|
|
32
|
+
|
|
33
|
+
## Data integrity / schema mismatch
|
|
34
|
+
|
|
35
|
+
- Typical signals: `constraint violation`, `invalid format`, `deserialization error`, `column missing`
|
|
36
|
+
- Common causes: incompatible deploy order, partial migrations, producer-consumer contract drift
|
|
37
|
+
- Validate by checking: migration history, payload schema version, deploy timeline
|
|
38
|
+
- False-positive guard: corrupt legacy records may produce localized errors only
|
|
39
|
+
|
|
40
|
+
## Concurrency / race condition
|
|
41
|
+
|
|
42
|
+
- Typical signals: duplicate operations, intermittent lock errors, non-deterministic failures
|
|
43
|
+
- Common causes: missing idempotency, lock scope too narrow, stale read-modify-write cycles
|
|
44
|
+
- Validate by checking: duplicate keys, overlapping timestamps, critical-section boundaries
|
|
45
|
+
- False-positive guard: manual replays can create similar duplicate traces
|
|
46
|
+
|
|
47
|
+
## External dependency outage
|
|
48
|
+
|
|
49
|
+
- Typical signals: transport errors, DNS failures, handshake failures, 5xx bursts from upstream
|
|
50
|
+
- Common causes: provider outage, certificate changes, network partition, rate limiting
|
|
51
|
+
- Validate by checking: provider status pages, cross-region behavior, status-code distribution
|
|
52
|
+
- False-positive guard: local config errors can appear as dependency outage
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: answering-questions-with-research
|
|
3
|
+
description: This skill should be used when the user asks a question that needs complete, evidence-based answers by combining repository discovery with web research.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Answering Questions With Research
|
|
7
|
+
|
|
8
|
+
## Dependencies
|
|
9
|
+
|
|
10
|
+
- Required: none.
|
|
11
|
+
- Conditional: none.
|
|
12
|
+
- Optional: none.
|
|
13
|
+
- Fallback: not applicable.
|
|
14
|
+
|
|
15
|
+
## Standards
|
|
16
|
+
|
|
17
|
+
- Evidence: Verify repository facts from local files first and confirm time-sensitive claims with current external sources.
|
|
18
|
+
- Execution: Perform repository discovery before web research, then combine both into one evidence-based answer.
|
|
19
|
+
- Quality: Prefer official or primary sources, state what was and was not verified, and do not guess.
|
|
20
|
+
- Output: Respond concisely, separate confirmed facts from uncertainty, and include external source links when used.
|
|
21
|
+
|
|
22
|
+
## Trigger Conditions
|
|
23
|
+
|
|
24
|
+
Use this skill whenever the user asks a question and expects a complete, factual answer.
|
|
25
|
+
|
|
26
|
+
## Required Workflow
|
|
27
|
+
|
|
28
|
+
1. Perform repository discovery first.
|
|
29
|
+
- Explore the codebase before answering.
|
|
30
|
+
- Locate relevant files with fast search tools (for example, `rg --files` and `rg`).
|
|
31
|
+
- Read only the files needed to confirm facts.
|
|
32
|
+
2. Perform web search second.
|
|
33
|
+
- Gather external information relevant to the user question.
|
|
34
|
+
- Prefer official docs and primary sources.
|
|
35
|
+
- Verify time-sensitive facts with current sources.
|
|
36
|
+
3. Produce a complete answer.
|
|
37
|
+
- Combine repository findings and web findings.
|
|
38
|
+
- Address all user concerns as fully as possible.
|
|
39
|
+
- Clearly separate confirmed facts from assumptions.
|
|
40
|
+
- Include source links for externally verified claims.
|
|
41
|
+
|
|
42
|
+
## Quality Rules
|
|
43
|
+
|
|
44
|
+
- Do not guess when evidence is missing.
|
|
45
|
+
- State what was verified and what could not be verified.
|
|
46
|
+
- Keep the answer concise, direct, and actionable.
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
interface:
|
|
2
|
+
display_name: "Answering Questions With Research"
|
|
3
|
+
short_description: "Combine repo discovery and web research for evidence-based answers"
|
|
4
|
+
default_prompt: "Use $answering-questions-with-research to answer this question by exploring the repository first, then verifying relevant external facts with current primary sources, and clearly separate confirmed findings from unknowns or assumptions."
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Lai Tsz Kin
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# commit-and-push
|
|
2
|
+
|
|
3
|
+
A Codex skill for commit-and-push workflows without release/version operations.
|
|
4
|
+
|
|
5
|
+
## What this skill does
|
|
6
|
+
|
|
7
|
+
`commit-and-push` helps agents safely submit local changes by:
|
|
8
|
+
|
|
9
|
+
1. Inspecting git status and staged state.
|
|
10
|
+
2. Running `specs-to-project-docs` when the current change set contains new completed spec files.
|
|
11
|
+
3. Running `align-project-documents` and `maintain-project-constraints` before commit.
|
|
12
|
+
4. Running additional dependency skills for code-affecting diffs.
|
|
13
|
+
5. Committing with a concise Conventional Commit message.
|
|
14
|
+
6. Pushing to the current branch.
|
|
15
|
+
|
|
16
|
+
## Scope
|
|
17
|
+
|
|
18
|
+
Use this skill when the user asks to commit/push/submit changes and does **not** request:
|
|
19
|
+
|
|
20
|
+
- version bumping
|
|
21
|
+
- tagging
|
|
22
|
+
- release changelog workflows
|
|
23
|
+
|
|
24
|
+
If the current diff includes new completed specs, convert them into categorized project docs first and let `specs-to-project-docs` remove or archive the superseded spec files.
|
|
25
|
+
|
|
26
|
+
For release workflows, use `version-release`.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: commit-and-push
|
|
3
|
+
description: "Guide the agent to submit local changes with commit and push only (no versioning). Use when users ask to commit, submit, or push changes without requesting tag/version/release operations. If the current change set includes new completed spec files, run `specs-to-project-docs` before the final commit so project docs are standardized into categorized files and the old specs are removed or archived."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Commit and Push
|
|
7
|
+
|
|
8
|
+
## Dependencies
|
|
9
|
+
|
|
10
|
+
- Required: `align-project-documents` and `maintain-project-constraints` before the final commit.
|
|
11
|
+
- Conditional: `review-change-set`, `discover-edge-cases`, and `harden-app-security` for code-affecting changes; `specs-to-project-docs` when the current change set includes new completed spec files.
|
|
12
|
+
- Optional: none.
|
|
13
|
+
- Fallback: If any required dependency is unavailable, or if `specs-to-project-docs` is required for spec conversion but unavailable, stop and report the missing dependency.
|
|
14
|
+
|
|
15
|
+
## Standards
|
|
16
|
+
|
|
17
|
+
- Evidence: Inspect git state and classify the change set before deciding which quality gates apply.
|
|
18
|
+
- Execution: Run the dependency skills in order, standardize project docs into categorized outputs when new specs are present, preserve staging intent, then commit and push without release steps.
|
|
19
|
+
- Quality: Re-run relevant validation for runtime changes and keep project docs plus agent constraints synchronized before committing.
|
|
20
|
+
- Output: Produce a concise Conventional Commit and push it to the current branch only.
|
|
21
|
+
|
|
22
|
+
## Overview
|
|
23
|
+
|
|
24
|
+
Run a standardized commit-and-push workflow without release/version steps.
|
|
25
|
+
|
|
26
|
+
## References
|
|
27
|
+
|
|
28
|
+
Load only when needed:
|
|
29
|
+
|
|
30
|
+
- `references/commit-messages.md`
|
|
31
|
+
- `references/branch-naming.md`
|
|
32
|
+
|
|
33
|
+
## Workflow
|
|
34
|
+
|
|
35
|
+
1. Inspect current state
|
|
36
|
+
- Run `git status -sb`, `git diff --stat`, and `git diff --cached --stat`.
|
|
37
|
+
- Check staged files with `git diff --cached --name-only`.
|
|
38
|
+
2. Classify changes
|
|
39
|
+
- `code-affecting`: runtime code, tests, build scripts, CI logic, or behavior-changing config.
|
|
40
|
+
- `docs-only`: content updates only (for example README, docs, comments).
|
|
41
|
+
- `new-specs-present`: the current change set adds or updates completed planning files such as `spec.md`, `tasks.md`, `checklist.md`, or their containing plan directories.
|
|
42
|
+
3. Run code-affecting dependency skills (when applicable)
|
|
43
|
+
- Execute `review-change-set` first to challenge architecture and simplification assumptions.
|
|
44
|
+
- Execute `discover-edge-cases` next to surface unresolved edge-case risks.
|
|
45
|
+
- Resolve any confirmed findings.
|
|
46
|
+
- Ensure `harden-app-security` has been executed for the same code-affecting scope as an adversarial quality gate.
|
|
47
|
+
- Re-run relevant tests when runtime logic changes.
|
|
48
|
+
4. Standardize project docs when new specs are present
|
|
49
|
+
- Execute `specs-to-project-docs` when `new-specs-present` is true and the related implementation scope is already complete enough for documentation consolidation.
|
|
50
|
+
- Let `specs-to-project-docs` convert the relevant specs into categorized project docs such as `docs/README.md`, `docs/getting-started.md`, `docs/configuration.md`, `docs/architecture.md`, `docs/features.md`, and `docs/developer-guide.md`.
|
|
51
|
+
- Let the skill normalize any existing project docs to the same structure and remove or archive superseded source spec files.
|
|
52
|
+
- If the specs still represent active unfinished work, do not convert them yet; report that the spec files remain active and should not be deleted.
|
|
53
|
+
5. Run pre-commit sync dependencies
|
|
54
|
+
- Execute `align-project-documents` after spec conversion and code/doc scans are complete.
|
|
55
|
+
- Execute `maintain-project-constraints` immediately before the commit.
|
|
56
|
+
6. Keep docs synchronized when needed
|
|
57
|
+
- Apply the output from `specs-to-project-docs` when new specs were converted into categorized project docs.
|
|
58
|
+
- Apply the output from `align-project-documents` when behavior or usage changed.
|
|
59
|
+
- Apply the output from `maintain-project-constraints` when agent workflow/rules changed.
|
|
60
|
+
7. Commit
|
|
61
|
+
- Preserve user staging intent where possible.
|
|
62
|
+
- Write a concise Conventional Commit message using `references/commit-messages.md`.
|
|
63
|
+
8. Push
|
|
64
|
+
- Push commit(s) to the current branch.
|
|
65
|
+
|
|
66
|
+
## Notes
|
|
67
|
+
|
|
68
|
+
- Never run version bump, tag creation, or changelog release steps in this skill.
|
|
69
|
+
- If release/version/tag work is requested, use `version-release` instead.
|
|
70
|
+
- If a new branch is required, follow `references/branch-naming.md`.
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
interface:
|
|
2
|
+
display_name: "Commit and Push"
|
|
3
|
+
short_description: "Submit local changes with commit and push only"
|
|
4
|
+
default_prompt: "Use $commit-and-push to inspect the current git state, classify the diff, run required dependency skills ($align-project-documents and $maintain-project-constraints, plus $review-change-set, $discover-edge-cases, and $harden-app-security as quality gates for code-affecting changes), run $specs-to-project-docs when the current change set includes new completed spec files so project docs are standardized into categorized files and old specs are removed or archived, then create a concise Conventional Commit and push to the current branch without any versioning or release steps."
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Branch Naming Instructions
|
|
2
|
+
|
|
3
|
+
Use a short, descriptive branch name in this pattern:
|
|
4
|
+
|
|
5
|
+
- type/short-description
|
|
6
|
+
- type/issue-id-short-description (if issue ids are used)
|
|
7
|
+
|
|
8
|
+
Guidelines:
|
|
9
|
+
- Use lowercase letters and hyphens only.
|
|
10
|
+
- Align type with commit message types (feat, fix, docs, chore, refactor, test).
|
|
11
|
+
- Do not rename the current branch unless the user explicitly asks.
|
|
12
|
+
|
|
13
|
+
Examples:
|
|
14
|
+
- feat/add-rpc-timeouts
|
|
15
|
+
- fix/1234-parse-registry
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Commit Message Instructions
|
|
2
|
+
|
|
3
|
+
Use a concise Conventional Commit style:
|
|
4
|
+
|
|
5
|
+
- Format: type: short subject
|
|
6
|
+
- Subject: imperative, lower case, no trailing period, <= 72 chars
|
|
7
|
+
- Scope: include only if the repo already uses it (type(scope): subject)
|
|
8
|
+
- Select `type` from the actual change intent in the staged diff (feature, bugfix, docs, etc.)
|
|
9
|
+
- Do not use version-only subjects (for example `feat: v1.2.3`)
|
|
10
|
+
- If the commit only contains release metadata, use `chore(release): ...`
|
|
11
|
+
|
|
12
|
+
Common types:
|
|
13
|
+
- feat, fix, docs, chore, refactor, test, style, perf, build, ci
|
|
14
|
+
|
|
15
|
+
Examples:
|
|
16
|
+
- feat: add rpc retry backoff
|
|
17
|
+
- fix: handle empty response payload
|
|
18
|
+
- docs: update env var table
|
|
19
|
+
- chore(release): bump version and update changelog
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 LaiTszKin
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Deep Research Topics
|
|
2
|
+
|
|
3
|
+
`deep-research-topics` is a reusable research skill for producing evidence-based topic deliverables.
|
|
4
|
+
|
|
5
|
+
It helps an agent:
|
|
6
|
+
|
|
7
|
+
1. Understand and scope a research request.
|
|
8
|
+
2. Break the topic into concrete research questions.
|
|
9
|
+
3. Perform deep research with authoritative sources.
|
|
10
|
+
4. Read workspace files to match the existing writing style.
|
|
11
|
+
5. Produce a final file in PDF by default, or Word/slides output when requested.
|
|
12
|
+
|
|
13
|
+
## Dependency skills
|
|
14
|
+
|
|
15
|
+
- `pdf`: default output format
|
|
16
|
+
- `doc`: optional Word output when requested
|
|
17
|
+
- `slides`: optional slide output when requested
|
|
18
|
+
|
|
19
|
+
## Language behavior
|
|
20
|
+
|
|
21
|
+
- Default output language: Chinese
|
|
22
|
+
- If the user requests another language, follow the user request.
|
|
23
|
+
- If the workspace already has a dominant language and the user does not override it, follow the workspace language.
|
|
24
|
+
- Use characters and formatting that are safe for Chinese or mixed CJK output.
|
|
25
|
+
|
|
26
|
+
## Repository layout
|
|
27
|
+
|
|
28
|
+
- `SKILL.md`: trigger rules, workflow, and dependency contract
|
|
29
|
+
- `agents/openai.yaml`: agent-facing metadata
|
|
30
|
+
|
|
31
|
+
## Typical use cases
|
|
32
|
+
|
|
33
|
+
Use this skill for:
|
|
34
|
+
|
|
35
|
+
- topic briefings
|
|
36
|
+
- background research memos
|
|
37
|
+
- literature scans
|
|
38
|
+
- competitive or landscape research
|
|
39
|
+
- decision-support reports
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
|
|
43
|
+
MIT. See `LICENSE`.
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: deep-research-topics
|
|
3
|
+
description: "Research specific topics deeply and turn them into evidence-based deliverables. Use when users need a structured research report, briefing, background memo, literature scan, or decision-support document grounded in authoritative sources. Default to PDF output, but switch to DOCX or PPTX when the user explicitly asks for those formats."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Deep Research Topics
|
|
7
|
+
|
|
8
|
+
## Dependencies
|
|
9
|
+
|
|
10
|
+
- Required: none.
|
|
11
|
+
- Conditional: `pdf` by default, `doc` when Word output is requested, and `slides` when slides are requested.
|
|
12
|
+
- Optional: none.
|
|
13
|
+
- Fallback: If the required output skill is unavailable, stop and report the missing dependency instead of inventing another export path.
|
|
14
|
+
|
|
15
|
+
## Standards
|
|
16
|
+
|
|
17
|
+
- Evidence: Prioritize authoritative sources, verify time-sensitive claims, and keep traceable notes for important facts.
|
|
18
|
+
- Execution: Define research questions, inspect workspace style, draft the content, then hand off to exactly one output skill unless multiple formats are explicitly requested.
|
|
19
|
+
- Quality: Distinguish verified facts from analysis or inference and call out limitations, conflicts, or stale data explicitly.
|
|
20
|
+
- Output: Deliver a polished research file with clear sections, citations, dates, and source links.
|
|
21
|
+
|
|
22
|
+
## Overview
|
|
23
|
+
|
|
24
|
+
Use this skill when a user needs topic research that goes beyond a quick answer and should end as a polished file deliverable.
|
|
25
|
+
|
|
26
|
+
## Required Workflow
|
|
27
|
+
|
|
28
|
+
1. Understand the request
|
|
29
|
+
- Identify the research goal, target audience, decision context, time range, geography, and required depth.
|
|
30
|
+
- Extract explicit deliverable requirements such as format, sections, length, and citation expectations.
|
|
31
|
+
2. Break the topic into research questions
|
|
32
|
+
- Define the topic boundary and key terms.
|
|
33
|
+
- Split the work into the main subtopics, competing views, recent developments, supporting data, and open questions.
|
|
34
|
+
- Turn vague requests into a concrete research checklist before drafting.
|
|
35
|
+
3. Perform deep research
|
|
36
|
+
- Prioritize authoritative sources: official documentation, government or regulator materials, academic papers, standards bodies, company filings, and well-established institutions.
|
|
37
|
+
- Use secondary reporting only to triangulate, summarize, or discover primary sources.
|
|
38
|
+
- Verify time-sensitive facts with current sources and record publication dates.
|
|
39
|
+
- Keep traceable notes for claims, metrics, dates, and citations.
|
|
40
|
+
4. Read workspace files before writing
|
|
41
|
+
- Inspect relevant files in the current workspace to learn the existing language, tone, terminology, heading structure, table style, and citation pattern.
|
|
42
|
+
- Reuse established structure and vocabulary when a clear house style already exists.
|
|
43
|
+
- If no relevant files exist, use a clean evidence-first structure.
|
|
44
|
+
5. Decide output language and character compatibility
|
|
45
|
+
- Default to Chinese.
|
|
46
|
+
- If the user explicitly requests another language, follow the user request.
|
|
47
|
+
- Otherwise, if the workspace already has a dominant language, follow that language for consistency.
|
|
48
|
+
- Use characters, punctuation, and fonts that are safe for Chinese or mixed CJK output. Avoid unusual glyphs that commonly break in PDF, DOCX, or PPTX rendering.
|
|
49
|
+
6. Draft the deliverable
|
|
50
|
+
- Include an executive summary or research overview.
|
|
51
|
+
- Organize findings by research question or subtopic.
|
|
52
|
+
- Distinguish verified facts from analysis or inference.
|
|
53
|
+
- Include citations, dates, and source links for important claims.
|
|
54
|
+
- State limitations, unresolved questions, and conflicts in the evidence when they exist.
|
|
55
|
+
7. Hand off to the selected output skill
|
|
56
|
+
- Use `pdf` by default.
|
|
57
|
+
- Switch to `doc` or `slides` only when requested or clearly required by the workspace convention.
|
|
58
|
+
- Preserve headings, tables, citations, and appendix material during the handoff.
|
|
59
|
+
- If the selected output skill is `pdf`, require PDF visual QA before completion:
|
|
60
|
+
- open the rendered PDF locally
|
|
61
|
+
- capture temporary screenshots from representative pages
|
|
62
|
+
- inspect layout, spacing, glyph rendering, tables, and dense text blocks
|
|
63
|
+
- regenerate if the visual result is wrong or unattractive
|
|
64
|
+
- delete all temporary QA screenshots after the final PDF passes inspection unless the user explicitly asks to keep them
|
|
65
|
+
|
|
66
|
+
## Source Quality Rules
|
|
67
|
+
|
|
68
|
+
- Prefer primary and authoritative sources over commentary.
|
|
69
|
+
- Use multiple high-quality sources when the claim is important or contested.
|
|
70
|
+
- Do not guess when evidence is incomplete.
|
|
71
|
+
- Call out uncertainty, disagreement, or stale data explicitly.
|
|
72
|
+
- Keep citations specific enough that another agent can trace them quickly.
|
|
73
|
+
|
|
74
|
+
## Output Expectations
|
|
75
|
+
|
|
76
|
+
The final deliverable should usually contain:
|
|
77
|
+
|
|
78
|
+
1. Title and scope
|
|
79
|
+
2. Executive summary
|
|
80
|
+
3. Research questions or evaluation framework
|
|
81
|
+
4. Findings by section
|
|
82
|
+
5. Evidence and citations
|
|
83
|
+
6. Implications, recommendations, or next steps when requested
|
|
84
|
+
7. Limitations or open questions
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
interface:
|
|
2
|
+
display_name: "Deep Research Topics"
|
|
3
|
+
short_description: "Research a topic deeply and deliver a file-backed briefing"
|
|
4
|
+
default_prompt: "Use $deep-research-topics to understand the user's research goal, break the topic into concrete research questions, gather high-credibility and authoritative sources, inspect relevant workspace files for language and style consistency, and produce a polished deliverable in PDF by default or DOCX/PPTX when the user requests those formats."
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Lai Tsz Kin
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|