♻️ Refactor flag usage for mcp

issue #64

Author: OpenWaygate

cmd/activity/activity.go

@@ -7,17 +7,17 @@ import (
 )
 
 const (
-	shortUsage           = "List YouTube activities"
-	longUsage            = "List YouTube activities"
-	channelIdUsage       = "ID of the channel"
-	homeUsage            = "true or false or empty"
-	maxResultsUsage      = "The maximum number of items that should be returned"
-	mineUsage            = "true or false or empty"
-	publishedAfterUsage  = "Filter on activities published after this date"
-	publishedBeforeUsage = "Filter on activities published before this date"
-	regionCodeUsage      = ""
-	partsUsage           = "Comma separated parts"
-	outputUsage          = "json or yaml"
+	short       = "List YouTube activities"
+	long        = "List YouTube activities, such as likes, favorites, uploads, etc"
+	ciUsage     = "ID of the channel"
+	homeUsage   = "true, false, or empty"
+	mrUsage     = "The maximum number of items that should be returned"
+	mineUsage   = "true, false, or empty"
+	paUsage     = "Filter on activities published after this date"
+	pbUsage     = "Filter on activities published before this date"
+	rcUsage     = ""
+	partsUsage  = "Comma separated parts"
+	outputUsage = "json or yaml"
 )
 
 var (
@@ -34,8 +34,8 @@ var (
 
 var activityCmd = &cobra.Command{
 	Use:   "activity",
-	Short: shortUsage,
-	Long:  longUsage,
+	Short: short,
+	Long:  long,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
 		boolMap := map[string]*bool{
 			"home": home,

cmd/activity/list.go

@@ -11,40 +11,35 @@ import (
 	"io"
 )
 
-const (
-	listShortUsage = "List YouTube activities"
-	listLongUsage  = "List YouTube activities, such as likes, favorites, uploads, etc."
-)
-
 var defaultParts = []string{"id", "snippet", "contentDetails"}
 
 var listTool = mcp.NewTool(
 	"activity.list",
-	mcp.WithDescription(listLongUsage),
+	mcp.WithDescription(long),
 	mcp.WithString(
-		"channelId", mcp.DefaultString(""), mcp.Description(channelIdUsage),
+		"channelId", mcp.DefaultString(""), mcp.Description(ciUsage),
 	),
 	mcp.WithString(
 		"home", mcp.Enum("true", "false", ""),
 		mcp.DefaultString(""), mcp.Description(homeUsage),
 	),
 	mcp.WithNumber(
-		"maxResults", mcp.DefaultNumber(5), mcp.Description(maxResultsUsage),
+		"maxResults", mcp.DefaultNumber(5), mcp.Description(mrUsage),
 	),
 	mcp.WithString(
 		"mine", mcp.Enum("true", "false", ""),
 		mcp.DefaultString("true"), mcp.Description(mineUsage),
 	),
 	mcp.WithString(
 		"publishedAfter", mcp.DefaultString(""),
-		mcp.Description(publishedAfterUsage),
+		mcp.Description(paUsage),
 	),
 	mcp.WithString(
 		"publishedBefore", mcp.DefaultString(""),
-		mcp.Description(publishedBeforeUsage),
+		mcp.Description(pbUsage),
 	),
 	mcp.WithString(
-		"regionCode", mcp.DefaultString(""), mcp.Description(regionCodeUsage),
+		"regionCode", mcp.DefaultString(""), mcp.Description(rcUsage),
 	),
 	mcp.WithArray(
 		"parts", mcp.DefaultArray(defaultParts), mcp.Description(partsUsage),
@@ -69,8 +64,8 @@ func run(writer io.Writer) error {
 
 var listCmd = &cobra.Command{
 	Use:   "list",
-	Short: listShortUsage,
-	Long:  listLongUsage,
+	Short: short,
+	Long:  long,
 	Run: func(cmd *cobra.Command, args []string) {
 		err := run(cmd.OutOrStdout())
 		if err != nil {
@@ -83,25 +78,18 @@ var listCmd = &cobra.Command{
 func init() {
 	cmd.MCP.AddTool(listTool, listHandler)
 	activityCmd.AddCommand(listCmd)
-	listCmd.Flags().StringVarP(
-		&channelId, "channelId", "c", "", channelIdUsage,
-	)
+	listCmd.Flags().StringVarP(&channelId, "channelId", "c", "", ciUsage)
 	listCmd.Flags().BoolVarP(home, "home", "H", true, homeUsage)
-	listCmd.Flags().Int64VarP(
-		&maxResults, "maxResults", "n", 5, maxResultsUsage,
-	)
+	listCmd.Flags().Int64VarP(&maxResults, "maxResults", "n", 5, mrUsage)
 	listCmd.Flags().BoolVarP(mine, "mine", "M", true, mineUsage)
 	listCmd.Flags().StringVarP(
-		&publishedAfter, "publishedAfter", "a", "", publishedAfterUsage,
+		&publishedAfter, "publishedAfter", "a", "", paUsage,
 	)
 	listCmd.Flags().StringVarP(
-		&publishedBefore, "publishedBefore", "b", "", publishedBeforeUsage,
-	)
-	listCmd.Flags().StringVarP(&regionCode, "regionCode", "r", "", regionCodeUsage)
-
-	listCmd.Flags().StringArrayVarP(
-		&parts, "parts", "p", defaultParts, partsUsage,
+		&publishedBefore, "publishedBefore", "b", "", pbUsage,
 	)
+	listCmd.Flags().StringVarP(&regionCode, "regionCode", "r", "", rcUsage)
+	listCmd.Flags().StringArrayVarP(&parts, "parts", "p", defaultParts, partsUsage)
 	listCmd.Flags().StringVarP(&output, "output", "o", "", outputUsage)
 }
 

cmd/caption/caption.go

@@ -7,6 +7,26 @@ import (
 	"github.com/spf13/pflag"
 )
 
+const (
+	short         = "Manipulate YouTube captions"
+	long          = "List, insert, update, download, or delete YouTube captions"
+	idUsage       = "ID of the caption"
+	fileUsage     = "Path to save the caption file"
+	attUsage      = "unknown, primary, commentary, or descriptive"
+	iasUsage      = "Whether YouTube synchronized the caption track to the audio track in the video"
+	iscUsage      = "Whether the track contains closed captions for the deaf and hard of hearing"
+	isdUsage      = "whether the caption track is a draft"
+	iserUsage     = "Whether caption track is formatted for 'easy reader'"
+	islUsage      = "Whether the caption track uses large text for the vision-impaired"
+	languageUsage = "Language of the caption track"
+	nameUsage     = "Name of the caption track"
+	tkUsage       = "standard, ASR, or forced"
+	vidUsage      = "ID of the video"
+	partsUsage    = "Comma separated parts"
+	tfmtUsage     = "sbv, srt, or vtt"
+	tlangUsage    = "Translate the captions into this language"
+)
+
 var (
 	id                     string
 	file                   string
@@ -30,8 +50,8 @@ var (
 
 var captionCmd = &cobra.Command{
 	Use:   "caption",
-	Short: "Manipulate YouTube captions",
-	Long:  "List, insert, update, download, or delete YouTube captions",
+	Short: short,
+	Long:  long,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
 		resetFlags(cmd.Flags())
 	},

cmd/caption/delete.go

@@ -5,10 +5,15 @@ import (
 	"github.com/spf13/cobra"
 )
 
+const (
+	deleteShort = "Delete caption"
+	deleteLong  = "Delete caption of a video"
+)
+
 var deleteCmd = &cobra.Command{
 	Use:   "delete",
-	Short: "Delete caption",
-	Long:  "Delete caption of a video",
+	Short: deleteShort,
+	Long:  deleteLong,
 	Run: func(cmd *cobra.Command, args []string) {
 		c := caption.NewCation(
 			caption.WithID(id),
@@ -23,7 +28,7 @@ var deleteCmd = &cobra.Command{
 func init() {
 	captionCmd.AddCommand(deleteCmd)
 
-	deleteCmd.Flags().StringVarP(&id, "id", "i", "", "ID of the caption")
+	deleteCmd.Flags().StringVarP(&id, "id", "i", "", idUsage)
 	deleteCmd.Flags().StringVarP(&onBehalfOf, "onBehalfOf", "b", "", "")
 	deleteCmd.Flags().StringVarP(
 		&onBehalfOfContentOwner, "onBehalfOfContentOwner", "B", "", "",

cmd/caption/download.go

@@ -5,10 +5,15 @@ import (
 	"github.com/spf13/cobra"
 )
 
+const (
+	downloadShort = "Download caption"
+	downloadLong  = "Download caption from a video"
+)
+
 var downloadCmd = &cobra.Command{
 	Use:   "download",
-	Short: "Download caption",
-	Long:  "Download caption from a video",
+	Short: downloadShort,
+	Long:  downloadLong,
 	Run: func(cmd *cobra.Command, args []string) {
 		c := caption.NewCation(
 			caption.WithID(id),
@@ -26,14 +31,10 @@ var downloadCmd = &cobra.Command{
 func init() {
 	captionCmd.AddCommand(downloadCmd)
 
-	downloadCmd.Flags().StringVarP(&id, "id", "i", "", "ID of the caption")
-	downloadCmd.Flags().StringVarP(
-		&file, "file", "f", "", "Path to save the caption file",
-	)
-	downloadCmd.Flags().StringVarP(&tfmt, "tfmt", "t", "", "sbv, srt or vtt")
-	downloadCmd.Flags().StringVarP(
-		&tlang, "tlang", "l", "", "Translate the captions into this language",
-	)
+	downloadCmd.Flags().StringVarP(&id, "id", "i", "", idUsage)
+	downloadCmd.Flags().StringVarP(&file, "file", "f", "", fileUsage)
+	downloadCmd.Flags().StringVarP(&tfmt, "tfmt", "t", "", tfmtUsage)
+	downloadCmd.Flags().StringVarP(&tlang, "tlang", "l", "", tlangUsage)
 	downloadCmd.Flags().StringVarP(&onBehalfOf, "onBehalfOf", "b", "", "")
 	downloadCmd.Flags().StringVarP(
 		&onBehalfOfContentOwner, "onBehalfOfContentOwner", "B", "", "",

cmd/caption/insert.go

@@ -5,10 +5,16 @@ import (
 	"github.com/spf13/cobra"
 )
 
+const (
+	insertShort       = "Insert caption"
+	insertLong        = "Insert caption to a video"
+	insertOutputUsage = "json, yaml, or silent"
+)
+
 var insertCmd = &cobra.Command{
 	Use:   "insert",
-	Short: "Insert caption",
-	Long:  "Insert caption to a video",
+	Short: insertShort,
+	Long:  insertLong,
 	Run: func(cmd *cobra.Command, args []string) {
 		c := caption.NewCation(
 			caption.WithFile(file),
@@ -33,47 +39,28 @@ var insertCmd = &cobra.Command{
 func init() {
 	captionCmd.AddCommand(insertCmd)
 
+	insertCmd.Flags().StringVarP(&file, "file", "f", "", fileUsage)
 	insertCmd.Flags().StringVarP(
-		&file, "file", "f", "", "Path to the caption file",
-	)
-	insertCmd.Flags().StringVarP(
-		&audioTrackType, "audioTrackType", "a", "unknown",
-		"unknown, primary, commentary or descriptive",
-	)
-	insertCmd.Flags().BoolVarP(
-		isAutoSynced, "isAutoSynced", "A", true,
-		"Whether YouTube synchronized the caption track to the audio track in the video",
-	)
-	insertCmd.Flags().BoolVarP(
-		isCC, "isCC", "C", false,
-		"Whether the track contains closed captions for the deaf and hard of hearing",
+		&audioTrackType, "audioTrackType", "a", "unknown", attUsage,
 	)
 	insertCmd.Flags().BoolVarP(
-		isDraft, "isDraft", "D", false, "whether the caption track is a draft",
+		isAutoSynced, "isAutoSynced", "A", true, iasUsage,
 	)
+	insertCmd.Flags().BoolVarP(isCC, "isCC", "C", false, iscUsage)
+	insertCmd.Flags().BoolVarP(isDraft, "isDraft", "D", false, isdUsage)
 	insertCmd.Flags().BoolVarP(
-		isEasyReader, "isEasyReader", "E", false,
-		"Whether caption track is formatted for 'easy reader'",
-	)
-	insertCmd.Flags().BoolVarP(
-		isLarge, "isLarge", "L", false,
-		"Whether the caption track uses large text for the vision-impaired",
-	)
-	insertCmd.Flags().StringVarP(
-		&language, "language", "l", "", "Language of the caption track",
+		isEasyReader, "isEasyReader", "E", false, iserUsage,
 	)
+	insertCmd.Flags().BoolVarP(isLarge, "isLarge", "L", false, islUsage)
+	insertCmd.Flags().StringVarP(&language, "language", "l", "", languageUsage)
+	insertCmd.Flags().StringVarP(&name, "name", "n", "", nameUsage)
 	insertCmd.Flags().StringVarP(
-		&name, "name", "n", "", "Name of the caption track",
+		&trackKind, "trackKind", "t", "standard", tkUsage,
 	)
-	insertCmd.Flags().StringVarP(
-		&trackKind, "trackKind", "t", "standard", "standard, ASR or forced",
-	)
-	insertCmd.Flags().StringVarP(&videoId, "videoId", "v", "", "ID of the video")
+	insertCmd.Flags().StringVarP(&videoId, "videoId", "v", "", vidUsage)
 	insertCmd.Flags().StringVarP(&onBehalfOf, "onBehalfOf", "b", "", "")
 	insertCmd.Flags().StringVarP(
 		&onBehalfOfContentOwner, "onBehalfOfContentOwner", "B", "", "",
 	)
-	insertCmd.Flags().StringVarP(
-		&output, "output", "o", "", "json, yaml or silent",
-	)
+	insertCmd.Flags().StringVarP(&output, "output", "o", "", insertOutputUsage)
 }

cmd/caption/list.go

@@ -5,6 +5,10 @@ import (
 	"github.com/spf13/cobra"
 )
 
+const (
+	listOutputUsage = "json or yaml"
+)
+
 var listCmd = &cobra.Command{
 	Use:   "list",
 	Short: "List captions",
@@ -24,14 +28,14 @@ var listCmd = &cobra.Command{
 func init() {
 	captionCmd.AddCommand(listCmd)
 
-	listCmd.Flags().StringVarP(&id, "id", "i", "", "ID of the caption")
-	listCmd.Flags().StringVarP(&videoId, "videoId", "v", "", "ID of the video")
+	listCmd.Flags().StringVarP(&id, "id", "i", "", idUsage)
+	listCmd.Flags().StringVarP(&videoId, "videoId", "v", "", vidUsage)
 	listCmd.Flags().StringVarP(&onBehalfOf, "onBehalfOf", "b", "", "")
 	listCmd.Flags().StringVarP(
 		&onBehalfOfContentOwner, "onBehalfOfContentOwner", "B", "", "",
 	)
 	listCmd.Flags().StringArrayVarP(
-		&parts, "parts", "p", []string{"id", "snippet"}, "Comma separated parts",
+		&parts, "parts", "p", []string{"id", "snippet"}, partsUsage,
 	)
-	listCmd.Flags().StringVarP(&output, "output", "o", "", "json or yaml")
+	listCmd.Flags().StringVarP(&output, "output", "o", "", listOutputUsage)
 }