Skip to content

refactor(tools): add ScopesRequired to Tool config and interface #3048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
duwenxin99 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

refactor(tools): add ScopesRequired to Tool config and interface #3048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
957e05c
refactor(tools): add `ScopesRequired` to Tool config and interface
duwenxin99 Apr 13, 2026
2aed062
update serverless spark
duwenxin99 Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions internal/server/mocks.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,10 @@ func (t MockTool) GetAuthTokenHeaderName(tools.SourceProvider) (string, error) {
return "Authorization", nil
}

func (t MockTool) GetScopesRequired() []string {
return nil
}

// MockPrompt is used to mock prompts in tests
type MockPrompt struct {
Name string
Expand Down
6 changes: 6 additions & 0 deletions internal/tools/alloydb/alloydbcreatecluster/alloydbcreatecluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ type Config struct {
Description string `yaml:"description"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -206,3 +208,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/alloydb/alloydbcreateinstance/alloydbcreateinstance.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ type Config struct {
Description string `yaml:"description"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -211,3 +213,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/alloydb/alloydbcreateuser/alloydbcreateuser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ type Config struct {
Description string `yaml:"description"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -216,3 +218,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/alloydb/alloydbgetcluster/alloydbgetcluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ type Config struct {
AuthRequired []string `yaml:"authRequired"`
BaseURL string `yaml:"baseURL"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -187,3 +189,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/alloydb/alloydbgetinstance/alloydbgetinstance.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ type Config struct {
AuthRequired []string `yaml:"authRequired"`
BaseURL string `yaml:"baseURL"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -191,3 +193,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/alloydb/alloydbgetuser/alloydbgetuser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ type Config struct {
AuthRequired []string `yaml:"authRequired"`
BaseURL string `yaml:"baseURL"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -191,3 +193,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/alloydb/alloydblistclusters/alloydblistclusters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ type Config struct {
AuthRequired []string `yaml:"authRequired"`
BaseURL string `yaml:"baseURL"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -181,3 +183,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/alloydb/alloydblistinstances/alloydblistinstances.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ type Config struct {
AuthRequired []string `yaml:"authRequired"`
BaseURL string `yaml:"baseURL"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -186,3 +188,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/alloydb/alloydblistusers/alloydblistusers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ type Config struct {
AuthRequired []string `yaml:"authRequired"`
BaseURL string `yaml:"baseURL"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -186,3 +188,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/alloydb/alloydbwaitforoperation/alloydbwaitforoperation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ type Config struct {
Multiplier float64 `yaml:"multiplier"`
MaxRetries int `yaml:"maxRetries"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -306,3 +308,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/alloydbainl/alloydbainl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ type Config struct {
AuthRequired []string `yaml:"authRequired"`
NLConfigParameters parameters.Parameters `yaml:"nlConfigParameters"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -179,3 +181,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.Parameters
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigquery/bigqueryanalyzecontribution/bigqueryanalyzecontribution.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ type Config struct {
Description string `yaml:"description" validate:"required"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -353,3 +355,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.Parameters
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigquery/bigqueryconversationalanalytics/bigqueryconversationalanalytics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ type Config struct {
Description string `yaml:"description" validate:"required"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -468,3 +470,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.Parameters
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigquery/bigqueryexecutesql/bigqueryexecutesql.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ type Config struct {
Description string `yaml:"description" validate:"required"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -324,3 +326,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.Parameters
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigquery/bigqueryforecast/bigqueryforecast.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ type Config struct {
Description string `yaml:"description" validate:"required"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -314,3 +316,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.Parameters
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigquery/bigquerygetdatasetinfo/bigquerygetdatasetinfo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ type Config struct {
Description string `yaml:"description" validate:"required"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -197,3 +199,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.Parameters
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigquery/bigquerygettableinfo/bigquerygettableinfo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ type Config struct {
Description string `yaml:"description" validate:"required"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -207,3 +209,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.Parameters
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigquery/bigquerylistdatasetids/bigquerylistdatasetids.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ type Config struct {
Description string `yaml:"description" validate:"required"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -203,3 +205,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.Parameters
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigquery/bigquerylisttableids/bigquerylisttableids.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ type Config struct {
Description string `yaml:"description" validate:"required"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -213,3 +215,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.Parameters
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigquery/bigquerysearchcatalog/bigquerysearchcatalog.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ type Config struct {
Description string `yaml:"description"`
AuthRequired []string `yaml:"authRequired"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -291,3 +293,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.Parameters
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigquery/bigquerysql/bigquerysql.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ type Config struct {
Parameters parameters.Parameters `yaml:"parameters"`
TemplateParameters parameters.Parameters `yaml:"templateParameters"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -286,3 +288,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
6 changes: 6 additions & 0 deletions internal/tools/bigtable/bigtable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ type Config struct {
Parameters parameters.Parameters `yaml:"parameters"`
TemplateParameters parameters.Parameters `yaml:"templateParameters"`
Annotations *tools.ToolAnnotations `yaml:"annotations,omitempty"`

ScopesRequired []string `yaml:"scopesRequired"`
}

// validate interface
Expand Down Expand Up @@ -151,3 +153,7 @@ func (t Tool) GetAuthTokenHeaderName(resourceMgr tools.SourceProvider) (string,
func (t Tool) GetParameters() parameters.Parameters {
return t.AllParams
}

func (t Tool) GetScopesRequired() []string {
return t.ScopesRequired
}
Loading
Loading