Refactor tool configuration and initialization (#18)

Introduce a centralized tools registry to manage tool configurations and
initialization, removing redundant setup logic. This update enhances
modularity, simplifies tool integration, and ensures configuration
validation and default setup consistency for all tools.

Author: shahariaazam

README.md

@@ -1,13 +1,11 @@
-# MCP Kit - Model Context Protocol Toolkit
+# MCP Kit - Model Context Protocol Toolkit 🌐🤖
 
-This project is a playground for experimenting with the Model Context Protocol (MCP) and Large Language Models (LLMs).
+🔬 A cutting-edge toolkit for experimenting with Large Language Models (LLMs) and the Model Context Protocol (MCP).
 
-The MCP Kit provides a platform that facilitates interaction with Large Language Models (LLMs) using the Model Context Protocol (MCP).
-It enables AI assistants to interact with external tools and services, extending their capabilities beyond their confined contexts.
-This toolkit offers a standardized way for AI models to communicate with external systems.
+## Overview 🌟
+
+MCP Kit is an innovative platform designed to revolutionize AI model interactions by providing a standardized, extensible framework for communication between AI assistants and external tools/services. It enables developers to build intelligent, context-aware applications with seamless integration across various AI models and services.
 
-**Disclaimer**: This project is a proof-of-concept and is not intended for production use. Feel free to explore, experiment, 
-and contribute to the project. For production systems, consider using separate, well-established components mentioned in this project
 and services tailored to your needs. For any questions or feedback, please open an issue or contact the maintainers.
 
 ## Components
@@ -102,7 +100,7 @@ flowchart LR
 
 Feel free to explore the [MCP Kit Frontend](https://github.com/shaharia-lab/mcp-frontend) project.
 
-## Getting Started
+## Getting Started 🚀
 
 ### Prerequisites
 
@@ -237,6 +235,17 @@ your commit messages.
 
 Please note that by contributing to this project, you agree to adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md).
 
+## Monitoring and Observability
+
+MCP Kit comes with built-in monitoring and observability features using popular open-source tools:
+
+- **Prometheus**: For metrics collection and monitoring
+- **Grafana**: For visualization and dashboards
+- **Loki**: For log aggregation
+- **Promtail**: For log shipping and collection
+
+These tools are pre-configured in the `monitoring/` directory and can be easily deployed using Docker Compose.
+
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details. Each component may have its own license, so please check the respective repositories/libraries for more information.

cmd/server.go

@@ -3,13 +3,9 @@ package cmd
 import (
 	"context"
 	"fmt"
-	"github.com/shaharia-lab/mcp-kit/internal/config"
-
 	"github.com/shaharia-lab/goai/mcp"
-	goaiObs "github.com/shaharia-lab/goai/observability"
 	"github.com/shaharia-lab/mcp-kit/internal/prompt"
 	"github.com/shaharia-lab/mcp-kit/internal/tools"
-	mcptools "github.com/shaharia-lab/mcp-tools"
 	"github.com/spf13/cobra"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/codes"
@@ -75,14 +71,19 @@ func NewServerCmd() *cobra.Command {
 			if err != nil {
 				logger.Fatalf("Failed to create Gmail service: %v", err)
 			}
-			toolsLists := setupTools(container.LogrusLoggerImpl, gmailSvc, container.Config)
 
 			err = container.BaseMCPServer.AddPrompts(prompt.MCPPromptsRegistry...)
 			if err != nil {
 				return fmt.Errorf("failed to add prompts: %w", err)
 			}
 
-			err = container.BaseMCPServer.AddTools(toolsLists...)
+			toolsRegistry := tools.NewRegistry(container.Config.Tools, container.LogrusLoggerImpl, gmailSvc)
+			err = toolsRegistry.Init()
+			if err != nil {
+				return fmt.Errorf("failed to initialize tools registry: %w", err)
+			}
+
+			err = container.BaseMCPServer.AddTools(toolsRegistry.GetToolLists()...)
 			if err != nil {
 				return fmt.Errorf("failed to add tools: %w", err)
 			}
@@ -99,46 +100,3 @@ func NewServerCmd() *cobra.Command {
 		},
 	}
 }
-
-func setupTools(logger goaiObs.Logger, gmailService *gmail.Service, config *config.Config) []mcp.Tool {
-	ts := tools.MCPToolsRegistry
-
-	ghConfig := mcptools.NewGitHubTool(logger, mcptools.GitHubConfig{})
-	fileSystem := mcptools.NewFileSystem(logger, mcptools.FileSystemConfig{})
-	docker := mcptools.NewDocker(logger)
-	git := mcptools.NewGit(logger, mcptools.GitConfig{})
-	curl := mcptools.NewCurl(logger, mcptools.CurlConfig{})
-	postgres := mcptools.NewPostgreSQL(logger, mcptools.PostgreSQLConfig{})
-
-	ts = append(
-		ts,
-
-		// Curl tools
-		curl.CurlAllInOneTool(),
-
-		// Git tools
-		git.GitAllInOneTool(),
-
-		// Docker tools
-		docker.DockerAllInOneTool(),
-
-		// File system tools
-		fileSystem.FileSystemAllInOneTool(),
-
-		// GitHub tools
-		ghConfig.GetIssuesTool(),
-		ghConfig.GetPullRequestsTool(),
-		ghConfig.GetRepositoryTool(),
-		ghConfig.GetSearchTool(),
-
-		// PostgreSQL tools
-		postgres.PostgreSQLAllInOneTool(),
-	)
-
-	if config.GoogleServiceConfig.Enabled {
-		gmailTool := mcptools.NewGmail(logger, gmailService, mcptools.GmailConfig{})
-		ts = append(ts, gmailTool.GmailAllInOneTool())
-	}
-
-	return ts
-}

config.example.yaml

@@ -31,4 +31,57 @@ google:
     - "https://www.googleapis.com/auth/userinfo.profile"
   state_cookie: "static-value-for-now"
   token_source_file: "/tmp/google_auth_token_source.json"
-  enabled: false
+  enabled: false
+
+tools:
+  get_wether:
+    enabled: true
+  postgres:
+    enabled: true
+    databases:
+      - name: "mcp_kit"
+        host: "localhost"
+        username: "root"
+        password: "root"
+        port: 5432
+        sslmode: "disable"
+  github_repository:
+    enabled: true
+    token: "${GITHUB_TOKEN}"
+  github_issues:
+    enabled: true
+    token: "${GITHUB_TOKEN}"
+  github_pull_requests:
+    enabled: true
+    token: "${GITHUB_TOKEN}"
+  github_search:
+    enabled: true
+    token: "${GITHUB_TOKEN}"
+  filesystem:
+    enabled: true
+    allowed_directory: "/tmp"
+    blocked_pattern:
+      - "secret"
+      - "password"
+  git:
+    enabled: true
+    default_repo_path: "/tmp"
+    blocked_commands:
+      - "push"
+      - "pull"
+      - "fetch"
+  curl:
+    enabled: true
+    blocked_methods:
+      - "POST"
+      - "PUT"
+      - "DELETE"
+  bash:
+    enabled: true
+  sed:
+    enabled: true
+  grep:
+    enabled: true
+  gmail:
+    enabled: true
+    token: "${GMAIL_TOKEN}"

go.mod

@@ -13,12 +13,13 @@ require (
 	github.com/fatih/color v1.18.0
 	github.com/go-chi/chi/v5 v5.2.1
 	github.com/go-chi/cors v1.2.1
+	github.com/go-playground/validator/v10 v10.25.0
 	github.com/google/uuid v1.6.0
 	github.com/google/wire v0.6.0
 	github.com/openai/openai-go v0.1.0-alpha.61
 	github.com/prometheus/client_golang v1.21.1
 	github.com/shaharia-lab/goai v0.12.0
-	github.com/shaharia-lab/mcp-tools v0.0.4
+	github.com/shaharia-lab/mcp-tools v0.0.5
 	github.com/sirupsen/logrus v1.9.3
 	github.com/spf13/cobra v1.9.1
 	github.com/spf13/viper v1.20.0
@@ -55,9 +56,12 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/fsnotify/fsnotify v1.8.0 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.8 // indirect
 	github.com/go-jose/go-jose/v4 v4.0.5 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
 	github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
 	github.com/google/go-github/v60 v60.0.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
@@ -67,6 +71,7 @@ require (
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.26.3 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/klauspost/compress v1.18.0 // indirect
+	github.com/leodido/go-urn v1.4.0 // indirect
 	github.com/lib/pq v1.10.9 // indirect
 	github.com/mattn/go-colorable v0.1.14 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect

go.sum

@@ -62,6 +62,8 @@ github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHk
 github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
 github.com/fsnotify/fsnotify v1.8.0 h1:dAwr6QBTBZIkG8roQaJjGof0pp0EeF+tNV7YBP3F/8M=
 github.com/fsnotify/fsnotify v1.8.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0=
+github.com/gabriel-vasile/mimetype v1.4.8 h1:FfZ3gj38NjllZIeJAmMhr+qKL8Wu+nOoI3GqacKw1NM=
+github.com/gabriel-vasile/mimetype v1.4.8/go.mod h1:ByKUIKGjh1ODkGM1asKUbQZOLGrPjydw3hYPU2YU9t8=
 github.com/go-chi/chi/v5 v5.2.1 h1:KOIHODQj58PmL80G2Eak4WdvUzjSJSm0vG72crDCqb8=
 github.com/go-chi/chi/v5 v5.2.1/go.mod h1:L2yAIGWB3H+phAw1NxKwWM+7eUH/lU8pOMm5hHcoops=
 github.com/go-chi/cors v1.2.1 h1:xEC8UT3Rlp2QuWNEr4Fs/c2EAGVKBwy/1vHx3bppil4=
@@ -77,6 +79,14 @@ github.com/go-pg/pg/v10 v10.11.0 h1:CMKJqLgTrfpE/aOVeLdybezR2om071Vh38OLZjsyMI0=
 github.com/go-pg/pg/v10 v10.11.0/go.mod h1:4BpHRoxE61y4Onpof3x1a2SQvi9c+q1dJnrNdMjsroA=
 github.com/go-pg/zerochecker v0.2.0 h1:pp7f72c3DobMWOb2ErtZsnrPaSvHd2W4o9//8HtF4mU=
 github.com/go-pg/zerochecker v0.2.0/go.mod h1:NJZ4wKL0NmTtz0GKCoJ8kym6Xn/EQzXRl2OnAe7MmDo=
+github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s=
+github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
+github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA=
+github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY=
+github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY=
+github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY=
+github.com/go-playground/validator/v10 v10.25.0 h1:5Dh7cjvzR7BRZadnsVOzPhWsrwUr0nmsZJxEAnFLNO8=
+github.com/go-playground/validator/v10 v10.25.0/go.mod h1:GGzBIJMuE98Ic/kJsBXbz1x/7cByt++cQ+YOuDM5wus=
 github.com/go-viper/mapstructure/v2 v2.2.1 h1:ZAaOCxANMuZx5RCeg0mBdEZk7DZasvvZIxtHqx8aGss=
 github.com/go-viper/mapstructure/v2 v2.2.1/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
 github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
@@ -126,6 +136,8 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
 github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
+github.com/leodido/go-urn v1.4.0 h1:WT9HwE9SGECu3lg4d/dIA+jxlljEa1/ffXKmRjqdmIQ=
+github.com/leodido/go-urn v1.4.0/go.mod h1:bvxc+MVxLKB4z00jd1z+Dvzr47oO32F/QSNjSBOlFxI=
 github.com/lib/pq v1.10.9 h1:YXG7RB+JIjhP29X+OtkiDnYaXQwpS4JEWq7dtCCRUEw=
 github.com/lib/pq v1.10.9/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o=
 github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE=
@@ -136,8 +148,6 @@ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
 github.com/openai/openai-go v0.1.0-alpha.61 h1:dLJW1Dk15VAwm76xyPsiPt/Ky94NNGoMLETAI1ISoBY=
 github.com/openai/openai-go v0.1.0-alpha.61/go.mod h1:3SdE6BffOX9HPEQv8IL/fi3LYZ5TUpRYaqGQZbyk11A=
-github.com/openai/openai-go v0.1.0-alpha.63 h1:bOlYE6NJcPdjG3OMl9rZnxJrxmwcG6zlEKOD1MHP9Is=
-github.com/openai/openai-go v0.1.0-alpha.63/go.mod h1:3SdE6BffOX9HPEQv8IL/fi3LYZ5TUpRYaqGQZbyk11A=
 github.com/pelletier/go-toml/v2 v2.2.3 h1:YmeHyLY8mFWbdkNWwpr+qIL2bEqT0o95WSdkNHvL12M=
 github.com/pelletier/go-toml/v2 v2.2.3/go.mod h1:MfCQTFTvCcUyyvvwm1+G6H/jORL20Xlb6rzQu9GuUkc=
 github.com/pgvector/pgvector-go v0.3.0 h1:Ij+Yt78R//uYqs3Zk35evZFvr+G0blW0OUN+Q2D1RWc=
@@ -159,8 +169,8 @@ github.com/sagikazarmark/locafero v0.8.0 h1:mXaMVw7IqxNBxfv3LdWt9MDmcWDQ1fagDH91
 github.com/sagikazarmark/locafero v0.8.0/go.mod h1:UBUyz37V+EdMS3hDF3QWIiVr/2dPrx49OMO0Bn0hJqk=
 github.com/shaharia-lab/goai v0.12.0 h1:s177idIsM6GJhX3JJmyZRZ+4ve5pJnQ/QL3FaC4fMsc=
 github.com/shaharia-lab/goai v0.12.0/go.mod h1:EKzvGwFBTL8eLUIw3pTA+X18IMjfy5mncFQXhvQCnAo=
-github.com/shaharia-lab/mcp-tools v0.0.4 h1:va0aYPLuuhS+IhXXS1UtEHPtlyGOfukplXjYgNIws00=
-github.com/shaharia-lab/mcp-tools v0.0.4/go.mod h1:fcAmptmJ+RhK7zwAM+dpIr6cCOtjJyn3yKjvPj98DYw=
+github.com/shaharia-lab/mcp-tools v0.0.5 h1:Hwfigbu0CVLhGHDuqZpFxmUBGEfHiHsYj9phiP/ZQbM=
+github.com/shaharia-lab/mcp-tools v0.0.5/go.mod h1:fcAmptmJ+RhK7zwAM+dpIr6cCOtjJyn3yKjvPj98DYw=
 github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
 github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/sourcegraph/conc v0.3.0 h1:OQTbbt6P72L20UqAkXXuLOj79LfEanQ+YQFNpLA9ySo=

internal/config/config.go

@@ -1,20 +1,23 @@
 package config
 
 import (
+	"fmt"
+	"github.com/shaharia-lab/mcp-kit/internal/tools"
 	"strings"
 	"time"
 
 	"github.com/spf13/viper"
 )
 
 type Config struct {
-	APIServerPort       int           `mapstructure:"api_server_port"`
-	MCPServerURL        string        `mapstructure:"mcp_server_url"`
-	MCPServerPort       int           `mapstructure:"mcp_server_port"`
-	ToolsEnabled        []string      `mapstructure:"tools_enabled"`
-	Tracing             TracingConfig `mapstructure:"tracing"`
-	Auth                AuthConfig    `mapstructure:"auth"`
-	GoogleServiceConfig GoogleConfig  `mapstructure:"google"`
+	APIServerPort       int                `mapstructure:"api_server_port"`
+	MCPServerURL        string             `mapstructure:"mcp_server_url"`
+	MCPServerPort       int                `mapstructure:"mcp_server_port"`
+	ToolsEnabled        []string           `mapstructure:"tools_enabled"`
+	Tracing             TracingConfig      `mapstructure:"tracing"`
+	Auth                AuthConfig         `mapstructure:"auth"`
+	GoogleServiceConfig GoogleConfig       `mapstructure:"google"`
+	Tools               *tools.ToolsConfig `yaml:"tools" validate:"required"`
 }
 
 // TracingConfig holds the configuration for the tracing service
@@ -54,6 +57,7 @@ func Load(configFile string) (*Config, error) {
 	var cfg Config
 
 	setDefaults()
+	tools.SetDefaults(viper.GetViper())
 
 	// Configure Viper
 	viper.SetConfigType("yaml")
@@ -73,6 +77,11 @@ func Load(configFile string) (*Config, error) {
 		return nil, err
 	}
 
+	// Validate tools configuration
+	if err := cfg.Tools.Validate(); err != nil {
+		return nil, fmt.Errorf("tools validation failed: %w", err)
+	}
+
 	return &cfg, nil
 }