Tyk AI Studio Plugin System Overview

import "github.com/TykTechnologies/midsommar/v2/pkg/plugin_sdk"

type EnrichmentPlugin struct {
    plugin_sdk.BasePlugin
}

func NewEnrichmentPlugin() *EnrichmentPlugin {
    return &EnrichmentPlugin{
        BasePlugin: plugin_sdk.NewBasePlugin(
            "request-enricher",
            "1.0.0",
            "Enriches requests with metadata",
        ),
    }
}

// Implement PostAuthHandler capability
func (p *EnrichmentPlugin) HandlePostAuth(ctx plugin_sdk.Context, req *pb.EnrichedRequest) (*pb.PluginResponse, error) {
    // Add custom metadata
    req.Headers["X-Request-ID"] = generateID()
    req.Headers["X-App-Name"] = ctx.AppName

    ctx.Services.Logger().Info("Request enriched",
        "app_id", ctx.AppID,
        "request_id", req.Headers["X-Request-ID"],
    )

    return &pb.PluginResponse{
        Modified: true,
        Request:  req,
    }, nil
}

func main() {
    plugin_sdk.Serve(NewEnrichmentPlugin())
}

{
  "id": "com.example.my-plugin",
  "name": "My Plugin",
  "version": "1.0.0",
  "plugin_type": "ai_studio",
  "permissions": {
    "services": ["llms.read", "apps.read", "kv.readwrite"]
  },
  "ui": {
    "slots": [
      {
        "slot": "sidebar.section",
        "label": "My Plugin",
        "icon": "settings",
        "route": "/my-plugin"
      }
    ],
    "routes": [
      {
        "path": "/my-plugin",
        "component": "my-plugin-view"
      }
    ]
  }
}

import "github.com/TykTechnologies/midsommar/v2/pkg/plugin_sdk"

type EchoAgentPlugin struct {
    plugin_sdk.BasePlugin
    prefix string
    suffix string
}

func NewEchoAgentPlugin() *EchoAgentPlugin {
    return &EchoAgentPlugin{
        BasePlugin: plugin_sdk.NewBasePlugin(
            "echo-agent",
            "1.0.0",
            "Wraps LLM responses with prefix/suffix",
        ),
        prefix: "[AGENT] ",
        suffix: " [/AGENT]",
    }
}

// Implement AgentPlugin capability
func (p *EchoAgentPlugin) HandleAgentMessage(
    req *pb.AgentMessageRequest,
    stream pb.PluginService_HandleAgentMessageServer) error {

    // Call LLM via Service API
    llmStream, err := ai_studio_sdk.CallLLM(
        stream.Context(),
        req.AvailableLlms[0].Id,
        req.AvailableLlms[0].DefaultModel,
        messages,
        0.7, 1000, nil, false,
    )

    // Receive and wrap response
    var llmContent string
    for {
        resp, err := llmStream.Recv()
        if err == io.EOF {
            break
        }
        llmContent += resp.Content
    }

    wrappedContent := fmt.Sprintf("%s%s%s", p.prefix, llmContent, p.suffix)

    // Stream back to user
    stream.Send(&pb.AgentMessageChunk{
        Type:    pb.AgentMessageChunk_CONTENT,
        Content: wrappedContent,
    })

    stream.Send(&pb.AgentMessageChunk{
        Type:    pb.AgentMessageChunk_DONE,
        IsFinal: true,
    })

    return nil
}

func main() {
    plugin_sdk.Serve(NewEchoAgentPlugin())
}

import "github.com/TykTechnologies/midsommar/v2/pkg/plugin_sdk"

type LLMValidatorPlugin struct {
    plugin_sdk.BasePlugin
}

// Register hooks
func (p *LLMValidatorPlugin) GetObjectHookRegistrations() ([]*pb.ObjectHookRegistration, error) {
    return []*pb.ObjectHookRegistration{
        {
            ObjectType: "llm",
            HookTypes:  []string{"before_create", "before_update"},
            Priority:   10, // Lower runs first
        },
    }, nil
}

// Handle hook invocation
func (p *LLMValidatorPlugin) HandleObjectHook(ctx plugin_sdk.Context, req *pb.ObjectHookRequest) (*pb.ObjectHookResponse, error) {
    var llm LLM
    json.Unmarshal([]byte(req.ObjectJson), &llm)

    // Enforce HTTPS
    if !strings.HasPrefix(llm.APIEndpoint, "https://") {
        return &pb.ObjectHookResponse{
            AllowOperation:  false,
            RejectionReason: "API endpoint must use HTTPS",
        }, nil
    }

    // Allow with validation metadata
    return &pb.ObjectHookResponse{
        AllowOperation: true,
        PluginMetadata: map[string]string{
            "validated_by": "llm-validator",
            "validated_at": time.Now().Format(time.RFC3339),
        },
    }, nil
}

func main() {
    plugin_sdk.Serve(NewLLMValidatorPlugin())
}

file:///path/to/plugin-binary

grpc://plugin-host:50051

oci://registry.example.com/plugins/my-plugin:v1.0.0

{
  "permissions": {
    "services": [
      "llms.proxy",      // Call LLMs via proxy
      "llms.read",       // List and read LLM configs
      "tools.execute",   // Execute tools
      "datasources.query", // Query datasources
      "kv.readwrite",    // Key-value storage
      "analytics.read"   // Read analytics data
    ]
  }
}

go get github.com/TykTechnologies/midsommar/v2/pkg/plugin_sdk

import "github.com/TykTechnologies/midsommar/v2/pkg/plugin_sdk"

type MyPlugin struct {
    plugin_sdk.BasePlugin
}

func main() {
    plugin_sdk.Serve(NewMyPlugin())
}