Skip to content

Introduce enabled/disabled tool list in configuration file #155

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

Merged
merged 5 commits into from
Jul 1, 2025
Merged

Introduce enabled/disabled tool list in configuration file #155

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
56a0f24
Introduce allow/deny tool functionality in toml config
ardaguclu Jul 1, 2025
145c7bb
Remove duplicate fields that already defined in staticConfig
ardaguclu Jul 1, 2025
9a2c63f
Add unit tests to verify tool valid check
ardaguclu Jul 1, 2025
1024b3d
Wire staticConfig to fix unit tests
ardaguclu Jul 1, 2025
2984758
Rename to enabled/disabled instead of allowed/denied
ardaguclu Jul 1, 2025
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
21 changes: 13 additions & 8 deletions pkg/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,21 @@ import (
"github.com/BurntSushi/toml"
)

// StaticConfig is the configuration for the server.
// It allows to configure server specific settings and tools to be enabled or disabled.
type StaticConfig struct {
DeniedResources []GroupVersionKind `toml:"denied_resources"`

LogLevel int `toml:"log_level,omitempty"`
SSEPort int `toml:"sse_port,omitempty"`
HTTPPort int `toml:"http_port,omitempty"`
SSEBaseURL string `toml:"sse_base_url,omitempty"`
KubeConfig string `toml:"kubeconfig,omitempty"`
ListOutput string `toml:"list_output,omitempty"`
ReadOnly bool `toml:"read_only,omitempty"`
DisableDestructive bool `toml:"disable_destructive,omitempty"`
LogLevel int `toml:"log_level,omitempty"`
SSEPort int `toml:"sse_port,omitempty"`
HTTPPort int `toml:"http_port,omitempty"`
SSEBaseURL string `toml:"sse_base_url,omitempty"`
KubeConfig string `toml:"kubeconfig,omitempty"`
ListOutput string `toml:"list_output,omitempty"`
ReadOnly bool `toml:"read_only,omitempty"`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be good to move the description comment here since to clarify its purpose:

// When true, expose only tools annotated with readOnlyHint=true

Same for DisableDestructive

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I'll add these comments.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated.

DisableDestructive bool `toml:"disable_destructive,omitempty"`
AllowedTools []string `toml:"allowed_tools,omitempty"`
DeniedTools []string `toml:"denied_tools,omitempty"`
}

type GroupVersionKind struct {
Expand All @@ -25,6 +29,7 @@ type GroupVersionKind struct {
Kind string `toml:"kind,omitempty"`
}

// ReadConfig reads the toml file and returns the StaticConfig.
func ReadConfig(configPath string) (*StaticConfig, error) {
configData, err := os.ReadFile(configPath)
if err != nil {
Expand Down
19 changes: 12 additions & 7 deletions pkg/config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,13 @@ list_output = "yaml"
read_only = true
disable_destructive = false

[[denied_resources]]
group = "apps"
version = "v1"
kind = "Deployment"
denied_resources = [
{group = "apps", version = "v1", kind = "Deployment"},
{group = "rbac.authorization.k8s.io", version = "v1", kind = "Role"}
]

[[denied_resources]]
group = "rbac.authorization.k8s.io"
version = "v1"
allowed_tools = ["configuration_view", "events_list", "namespaces_list", "pods_list", "resources_list", "resources_get", "resources_create_or_update", "resources_delete"]
denied_tools = ["pods_delete", "pods_top", "pods_log", "pods_run", "pods_exec"]
`)

config, err := ReadConfig(validConfigPath)
Expand Down Expand Up @@ -109,6 +108,12 @@ version = "v1"
if config.DisableDestructive {
t.Fatalf("Unexpected disable destructive: %v", config.DisableDestructive)
}
if len(config.AllowedTools) != 8 {
t.Fatalf("Unexpected allowed tools: %v", config.AllowedTools)
}
if len(config.DeniedTools) != 5 {
t.Fatalf("Unexpected denied tools: %v", config.DeniedTools)
}
})
}

Expand Down
9 changes: 3 additions & 6 deletions pkg/kubernetes-mcp-server/cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,12 +186,9 @@ func (m *MCPServerOptions) Run() error {
return nil
}
mcpServer, err := mcp.NewServer(mcp.Configuration{
Profile: profile,
ListOutput: listOutput,
ReadOnly: m.StaticConfig.ReadOnly,
DisableDestructive: m.StaticConfig.DisableDestructive,
Kubeconfig: m.StaticConfig.KubeConfig,
StaticConfig: m.StaticConfig,
Profile: profile,
ListOutput: listOutput,
StaticConfig: m.StaticConfig,
})
if err != nil {
return fmt.Errorf("Failed to initialize MCP server: %w\n", err)
Expand Down
14 changes: 7 additions & 7 deletions pkg/kubernetes-mcp-server/cmd/testdata/valid-config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ list_output = "yaml"
read_only = true
disable_destructive = true

[[denied_resources]]
group = "apps"
version = "v1"
kind = "Deployment"
denied_resources = [
{group = "apps", version = "v1", kind = "Deployment"},
{group = "rbac.authorization.k8s.io", version = "v1", kind = "Role"}
]

allowed_tools = ["configuration_view", "events_list", "namespaces_list", "pods_list", "resources_list", "resources_get", "resources_create_or_update", "resources_delete"]
denied_tools = ["pods_delete", "pods_top", "pods_log", "pods_run", "pods_exec"]

[[denied_resources]]
group = "rbac.authorization.k8s.io"
version = "v1"
53 changes: 27 additions & 26 deletions pkg/mcp/common_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ import (
"context"
"encoding/json"
"fmt"
"net/http/httptest"
"os"
"path/filepath"
"runtime"
"testing"
"time"

"github.com/manusa/kubernetes-mcp-server/pkg/config"
"github.com/manusa/kubernetes-mcp-server/pkg/output"
"github.com/mark3labs/mcp-go/client"
Expand All @@ -28,18 +35,12 @@ import (
"k8s.io/client-go/tools/clientcmd/api"
toolswatch "k8s.io/client-go/tools/watch"
"k8s.io/utils/ptr"
"net/http/httptest"
"os"
"path/filepath"
"runtime"
"sigs.k8s.io/controller-runtime/pkg/envtest"
"sigs.k8s.io/controller-runtime/tools/setup-envtest/env"
"sigs.k8s.io/controller-runtime/tools/setup-envtest/remote"
"sigs.k8s.io/controller-runtime/tools/setup-envtest/store"
"sigs.k8s.io/controller-runtime/tools/setup-envtest/versions"
"sigs.k8s.io/controller-runtime/tools/setup-envtest/workflows"
"testing"
"time"
)

// envTest has an expensive setup, so we only want to do it once per entire test run.
Expand Down Expand Up @@ -97,20 +98,19 @@ func TestMain(m *testing.M) {
}

type mcpContext struct {
profile Profile
listOutput output.Output
readOnly bool
disableDestructive bool
staticConfig *config.StaticConfig
clientOptions []transport.ClientOption
before func(*mcpContext)
after func(*mcpContext)
ctx context.Context
tempDir string
cancel context.CancelFunc
mcpServer *Server
mcpHttpServer *httptest.Server
mcpClient *client.Client
profile Profile
listOutput output.Output

staticConfig *config.StaticConfig
clientOptions []transport.ClientOption
before func(*mcpContext)
after func(*mcpContext)
ctx context.Context
tempDir string
cancel context.CancelFunc
mcpServer *Server
mcpHttpServer *httptest.Server
mcpClient *client.Client
}

func (c *mcpContext) beforeEach(t *testing.T) {
Expand All @@ -125,17 +125,18 @@ func (c *mcpContext) beforeEach(t *testing.T) {
c.listOutput = output.Yaml
}
if c.staticConfig == nil {
c.staticConfig = &config.StaticConfig{}
c.staticConfig = &config.StaticConfig{
ReadOnly: false,
DisableDestructive: false,
}
}
if c.before != nil {
c.before(c)
}
if c.mcpServer, err = NewServer(Configuration{
Profile: c.profile,
ListOutput: c.listOutput,
ReadOnly: c.readOnly,
DisableDestructive: c.disableDestructive,
StaticConfig: c.staticConfig,
Profile: c.profile,
ListOutput: c.listOutput,
StaticConfig: c.staticConfig,
}); err != nil {
t.Fatal(err)
return
Expand Down
31 changes: 20 additions & 11 deletions pkg/mcp/mcp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@ package mcp

import (
"context"
"github.com/manusa/kubernetes-mcp-server/pkg/config"
"net/http"
"slices"

"github.com/mark3labs/mcp-go/mcp"
"github.com/mark3labs/mcp-go/server"
"k8s.io/utils/ptr"

"github.com/manusa/kubernetes-mcp-server/pkg/config"
"github.com/manusa/kubernetes-mcp-server/pkg/kubernetes"
"github.com/manusa/kubernetes-mcp-server/pkg/output"
"github.com/manusa/kubernetes-mcp-server/pkg/version"
Expand All @@ -17,15 +18,26 @@ import (
type Configuration struct {
Profile Profile
ListOutput output.Output
// When true, expose only tools annotated with readOnlyHint=true
ReadOnly bool
// When true, disable tools annotated with destructiveHint=true
DisableDestructive bool
Kubeconfig string

StaticConfig *config.StaticConfig
}

func (c *Configuration) isToolApplicable(tool server.ServerTool) bool {
if c.StaticConfig.ReadOnly && !ptr.Deref(tool.Tool.Annotations.ReadOnlyHint, false) {
return false
}
if c.StaticConfig.DisableDestructive && !ptr.Deref(tool.Tool.Annotations.ReadOnlyHint, false) && ptr.Deref(tool.Tool.Annotations.DestructiveHint, false) {
return false
}
if c.StaticConfig.AllowedTools != nil && !slices.Contains(c.StaticConfig.AllowedTools, tool.Tool.Name) {
return false
}
if c.StaticConfig.DeniedTools != nil && slices.Contains(c.StaticConfig.DeniedTools, tool.Tool.Name) {
return false
}
return true
}

type Server struct {
configuration *Configuration
server *server.MCPServer
Expand Down Expand Up @@ -53,17 +65,14 @@ func NewServer(configuration Configuration) (*Server, error) {
}

func (s *Server) reloadKubernetesClient() error {
k, err := kubernetes.NewManager(s.configuration.Kubeconfig, s.configuration.StaticConfig)
k, err := kubernetes.NewManager(s.configuration.StaticConfig.KubeConfig, s.configuration.StaticConfig)
if err != nil {
return err
}
s.k = k
applicableTools := make([]server.ServerTool, 0)
for _, tool := range s.configuration.Profile.GetTools(s) {
if s.configuration.ReadOnly && !ptr.Deref(tool.Tool.Annotations.ReadOnlyHint, false) {
continue
}
if s.configuration.DisableDestructive && !ptr.Deref(tool.Tool.Annotations.ReadOnlyHint, false) && ptr.Deref(tool.Tool.Annotations.DestructiveHint, false) {
if !s.configuration.isToolApplicable(tool) {
continue
}
applicableTools = append(applicableTools, tool)
Expand Down
Loading
Loading