Skip to content

docs(skills): add tq api reference and streamline CLI skill - #301

Merged
version-1 merged 4 commits into
mainfrom
docs/tq-api-skill-reference
Aug 1, 2026
Merged

docs(skills): add tq api reference and streamline CLI skill#301
version-1 merged 4 commits into
mainfrom
docs/tq-api-skill-reference

Conversation

@version-1

Copy link
Copy Markdown
Owner

tasq-cli skillのAPIリファレンス追加と全体整理

Summary

tasq-cli skillに、allowlist型raw API commandであるtq apiのオンデマンドリファレンスを追加します。あわせてskill全体を見直し、resourceをコマンド仕様、use caseを実行手順として整理し、重複記述を削減します。

主な変更点:

  • tq apiの構文、allowlist、入力制約、raw出力、exit code、安全境界を追加
  • SKILL.mdを小さな索引へ再構成し、必要なreferenceだけをロードできるよう整理
  • resourceとuse case間の重複を削減し、local operationsやproject操作の仕様を集約
  • migration rollback手順をCLIのstartup pre-flightと整合する内容へ修正

やったこと

  • references/resources/api.mdを追加
  • skill frontmatterのdescriptionへraw APIとlocal operationsを反映
  • project、service、workflow、issue、comment、global behaviorの記述を簡潔化
  • use caseから重複するcommand semanticsを削除し、仕様正本へのリンクへ置換
  • project removalとraw API mutationに明示的な安全境界を追加
  • fresh agentによるapi利用とproject bootstrap利用のforward testを実施

動作確認

  • quick_validate.py .agents/skills/tasq-cli
  • go test ./internal/cli/tq
  • go run ./cmd/tq --help
  • go run ./cmd/tq api --help
  • 全Markdown相対リンク検査
  • git diff --check

レビュー & 動作確認 チェックリスト

  • API仕様 - allowlist、path/query/header/body制約がCLI実装と一致しているか
  • 安全境界 - raw API mutationとproject removalが明示的な許可を要求しているか
  • 参照責務 - resourceが仕様、use caseが手順として分離されているか
  • Migration - forwardとrollbackの手順がservice startup pre-flightと整合しているか
  • Progressive disclosure - SKILL.mdから必要最小限のreferenceを選択できるか

推奨テスト計画:

  1. tasq-cli skillからapi.mdを選び、read/write requestの構文と注意点を回答させる
  2. project bootstrap要求でproject、workflow、service referenceだけが選ばれることを確認する
  3. migration rollback要求で、同じversionのserviceを即再起動しない案内になることを確認する

その他気になることや相談ごと

インストール済みtqが古い環境でも検証できるよう、CLI helpはリポジトリの現行ソースから実行しています。

Add an on-demand tasq-cli resource reference for the allowlisted raw API command, covering syntax, routes, validation, bodies, output, and exit codes. Update the skill index and trigger description so agents can discover the reference without loading it for unrelated tq tasks.\n\nVerified with quick_validate.py, go test ./internal/cli/tq, source-built tq api help, and a forward-use skill check.
Require explicit user authorization and target verification before agents execute write or delete requests through tq api. Clarify that the CLI allowlist and lack of prompts do not grant mutation authority.\n\nVerified with quick_validate.py and git diff --check.
Reorganize the tasq-cli index around resource specifications and ordered use cases. Remove repeated command semantics from procedural guides, consolidate local-operation behavior, and clarify destructive project removal while preserving links to the authoritative references.\n\nVerified with quick_validate.py, go test ./internal/cli/tq, source-built CLI help, Markdown link validation, and a fresh-agent forward-use check.
Verify migration state before restart and prevent agents from restarting current binaries against a deliberately rolled-back schema. Also scope the index ID convention to numeric resources while retaining string attachment identifiers.\n\nVerified with quick_validate.py, Markdown link validation, and git diff --check.
@version-1
version-1 merged commit d1644e8 into main Aug 1, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant