mcp.go 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  1. package mcpservers
  2. import (
  3. "context"
  4. "errors"
  5. "fmt"
  6. "github.com/labring/aiproxy/core/model"
  7. "github.com/mark3labs/mcp-go/mcp"
  8. )
  9. type ConfigValueValidator func(value string) error
  10. type ConfigRequiredType int
  11. const (
  12. ConfigRequiredTypeInitOptional ConfigRequiredType = iota
  13. ConfigRequiredTypeReusingOptional
  14. ConfigRequiredTypeInitOnly
  15. ConfigRequiredTypeReusingOnly
  16. ConfigRequiredTypeInitOrReusingOnly
  17. )
  18. func (c ConfigRequiredType) Validate(config, reusingConfig string) error {
  19. switch c {
  20. case ConfigRequiredTypeInitOnly:
  21. if config == "" {
  22. return errors.New("config is required")
  23. }
  24. case ConfigRequiredTypeReusingOnly:
  25. if reusingConfig == "" {
  26. return errors.New("reusing config is required")
  27. }
  28. case ConfigRequiredTypeInitOrReusingOnly:
  29. if config == "" && reusingConfig == "" {
  30. return errors.New("config or reusing config is required")
  31. }
  32. if config != "" && reusingConfig != "" {
  33. return errors.New(
  34. "config and reusing config are both provided, but only one is allowed",
  35. )
  36. }
  37. }
  38. return nil
  39. }
  40. type ConfigTemplate struct {
  41. Name string `json:"name"`
  42. Required ConfigRequiredType `json:"required"`
  43. Example string `json:"example,omitempty"`
  44. Default string `json:"default,omitempty"`
  45. Description string `json:"description,omitempty"`
  46. Validator ConfigValueValidator `json:"-"`
  47. }
  48. type ConfigTemplates = map[string]ConfigTemplate
  49. type ProxyConfigTemplate struct {
  50. ConfigTemplate
  51. Type model.ProxyParamType
  52. }
  53. type ProxyConfigTemplates = map[string]ProxyConfigTemplate
  54. func ValidateConfigTemplatesConfig(
  55. ct ConfigTemplates,
  56. config, reusingConfig map[string]string,
  57. ) error {
  58. if len(ct) == 0 {
  59. return nil
  60. }
  61. for key, template := range ct {
  62. c := config[key]
  63. rc := reusingConfig[key]
  64. if err := template.Required.Validate(c, rc); err != nil {
  65. return fmt.Errorf("config required %s is invalid: %w", key, err)
  66. }
  67. if template.Validator != nil {
  68. if c != "" {
  69. if err := template.Validator(c); err != nil {
  70. return fmt.Errorf("config %s is invalid: %w", key, err)
  71. }
  72. } else if rc != "" {
  73. if err := template.Validator(rc); err != nil {
  74. return fmt.Errorf("reusing config %s is invalid: %w", key, err)
  75. }
  76. }
  77. }
  78. }
  79. return nil
  80. }
  81. func CheckConfigTemplatesValidate(ct ConfigTemplates) error {
  82. for key, value := range ct {
  83. err := CheckConfigTemplateValidate(value)
  84. if err != nil {
  85. return fmt.Errorf("config %s validate error: %w", key, err)
  86. }
  87. }
  88. return nil
  89. }
  90. func CheckProxyConfigTemplatesValidate(ct ProxyConfigTemplates) error {
  91. for key, value := range ct {
  92. err := CheckConfigTemplateValidate(value.ConfigTemplate)
  93. if err != nil {
  94. return fmt.Errorf("config %s validate error: %w", key, err)
  95. }
  96. }
  97. return nil
  98. }
  99. func CheckConfigTemplateValidate(value ConfigTemplate) error {
  100. if value.Name == "" {
  101. return errors.New("name is required")
  102. }
  103. if value.Description == "" {
  104. return errors.New("description is required")
  105. }
  106. if value.Example != "" && value.Validator != nil {
  107. if err := value.Validator(value.Example); err != nil {
  108. return fmt.Errorf("example is invalid: %w", err)
  109. }
  110. }
  111. if value.Default != "" && value.Validator != nil {
  112. if err := value.Validator(value.Default); err != nil {
  113. return fmt.Errorf("default is invalid: %w", err)
  114. }
  115. }
  116. return nil
  117. }
  118. type (
  119. NewServerFunc func(config, reusingConfig map[string]string) (Server, error)
  120. ListToolsFunc func(ctx context.Context) ([]mcp.Tool, error)
  121. )
  122. type McpServer struct {
  123. model.PublicMCP
  124. ConfigTemplates ConfigTemplates
  125. ProxyConfigTemplates ProxyConfigTemplates
  126. newServer NewServerFunc
  127. listTools ListToolsFunc
  128. disableCache bool
  129. }
  130. type McpConfig func(*McpServer)
  131. func WithNameCN(nameCN string) McpConfig {
  132. return func(e *McpServer) {
  133. e.NameCN = nameCN
  134. }
  135. }
  136. func WithDescription(description string) McpConfig {
  137. return func(e *McpServer) {
  138. e.Description = description
  139. }
  140. }
  141. func WithDescriptionCN(descriptionCN string) McpConfig {
  142. return func(e *McpServer) {
  143. e.DescriptionCN = descriptionCN
  144. }
  145. }
  146. func WithReadme(readme string) McpConfig {
  147. return func(e *McpServer) {
  148. e.Readme = readme
  149. }
  150. }
  151. func WithReadmeCN(readmeCN string) McpConfig {
  152. return func(e *McpServer) {
  153. e.ReadmeCN = readmeCN
  154. }
  155. }
  156. func WithReadmeURL(readmeURL string) McpConfig {
  157. return func(e *McpServer) {
  158. e.ReadmeURL = readmeURL
  159. }
  160. }
  161. func WithReadmeCNURL(readmeCNURL string) McpConfig {
  162. return func(e *McpServer) {
  163. e.ReadmeCNURL = readmeCNURL
  164. }
  165. }
  166. func WithGitHubURL(gitHubURL string) McpConfig {
  167. return func(e *McpServer) {
  168. e.GitHubURL = gitHubURL
  169. }
  170. }
  171. func WithType(t model.PublicMCPType) McpConfig {
  172. return func(e *McpServer) {
  173. e.Type = t
  174. }
  175. }
  176. func WithLogoURL(logoURL string) McpConfig {
  177. return func(e *McpServer) {
  178. e.LogoURL = logoURL
  179. }
  180. }
  181. func WithTags(tags []string) McpConfig {
  182. return func(e *McpServer) {
  183. e.Tags = tags
  184. }
  185. }
  186. func WithConfigTemplates(configTemplates ConfigTemplates) McpConfig {
  187. return func(e *McpServer) {
  188. e.ConfigTemplates = configTemplates
  189. }
  190. }
  191. func WithProxyConfigTemplates(proxyConfigTemplates ProxyConfigTemplates) McpConfig {
  192. return func(e *McpServer) {
  193. e.ProxyConfigTemplates = proxyConfigTemplates
  194. }
  195. }
  196. func WithListToolsFunc(listTools ListToolsFunc) McpConfig {
  197. return func(e *McpServer) {
  198. e.listTools = listTools
  199. }
  200. }
  201. func WithNewServerFunc(newServer NewServerFunc) McpConfig {
  202. return func(e *McpServer) {
  203. e.newServer = newServer
  204. }
  205. }
  206. func WithDisableCache(disableCache bool) McpConfig {
  207. return func(e *McpServer) {
  208. e.disableCache = disableCache
  209. }
  210. }
  211. func NewMcp(id, name string, mcpType model.PublicMCPType, opts ...McpConfig) McpServer {
  212. e := McpServer{
  213. PublicMCP: model.PublicMCP{
  214. ID: id,
  215. Name: name,
  216. Type: mcpType,
  217. },
  218. }
  219. for _, opt := range opts {
  220. opt(&e)
  221. }
  222. return e
  223. }
  224. var (
  225. ErrNotImplNewServer = errors.New("not impl new server")
  226. ErrNotImplListTools = errors.New("not impl list tools")
  227. )
  228. func (e *McpServer) NewServer(config, reusingConfig map[string]string) (Server, error) {
  229. if e.newServer == nil {
  230. return nil, ErrNotImplNewServer
  231. }
  232. if err := ValidateConfigTemplatesConfig(e.ConfigTemplates, config, reusingConfig); err != nil {
  233. return nil, fmt.Errorf("mcp %s config is invalid: %w", e.ID, err)
  234. }
  235. return e.newServer(config, reusingConfig)
  236. }
  237. func (e *McpServer) ListTools(ctx context.Context) ([]mcp.Tool, error) {
  238. if e.listTools == nil {
  239. return nil, ErrNotImplListTools
  240. }
  241. return e.listTools(ctx)
  242. }