Cortex

🚀 Cortex Framework Documentation

Cortex is a powerful framework that offers a variety of features and capabilities, including multi - protocol support, custom tool creation, and a robust plugin system. This documentation will guide you through its main functionalities.

🚀 Quick Start

✨ Features

Cortex provides support for multiple communication protocols:

• STDIO Protocol
• HTTP Protocol (Integrated with Server - Sent Events technology)
• TCP Protocol
• WebSocket Protocol

📦 Installation

No installation steps are provided in the original document, so this section is skipped.

💻 Usage Examples

Basic Usage - Creating Custom Tools

You can easily create and manage custom tools through the pkg/tools package:

package main

import (
    "context"
    "log"

    "github.com/FreePeak/cortex/pkg/server"
    "github.com/FreePeak/cortex/pkg/tools"
)

func main() {
    // Create a basic service context
    ctx := context.Background()

    // Initialize the server
    srv := server.NewServer(ctx, &server.Config{
        Name: "My Custom Tool",
        Desc: "This is a custom tool for demonstration purposes",
        Tools: []*tools.Tool{
            {
                Name:    "echo",
                Desc:    "Echo function",
                Handler: echoHandler,
            },
        },
    })

    // Start the server
    if err := srv.ServeStdio(); err != nil {
        log.Fatal("Failed to start the server:", err)
    }
}

func echoHandler(ctx context.Context, req *server.Request) (*server.Response, error) {
    return &server.Response{
        Body: req.Body,
    }, nil
}

Advanced Usage - Running Multiple Protocols Simultaneously

You can easily implement a multi - protocol server:

package main

import (
    "context"
    "log"
    "os"
    "syscall"
    "time"

    "github.com/FreePeak/cortex/pkg/server"
)

func main() {
    ctx := context.Background()
    srv := server.NewServer(ctx, &server.Config{
        Name: "Multi - Protocol Demonstration Server",
        Desc: "Show how to use multiple protocols simultaneously",
    })

    // Start the HTTP service
    go func() {
        if err := srv.ServeHTTP(":8080"); err != nil {
            log.Fatalf("Failed to start the HTTP service:", err)
        }
    }()

    // Start the STDIO service
    go func() {
        if err := srv.ServeStdio(); err != nil {
            log.Fatalf("Failed to start the STDIO service:", err)
        }
    }()

    // Wait for termination signal
    stopChan := make(chan os.Signal, 1)
    signal.Notify(stopChan, os.Interrupt, syscall.SIGTERM)
    <-stopChan

    // Safely shut down the server
    ctxShutdown, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    defer cancel()
    if err := srv.Shutdown(ctxShutdown); err != nil {
        log.Fatalf("Failed to shut down the server:", err)
    }
}

Plugin System Usage

Cortex provides a powerful plugin extension mechanism:

package main

import (
    "context"
    "log"

    "github.com/FreePeak/cortex/pkg/plugin"
)

type MyPlugin struct {
    *plugin.BasePlugin
}

func NewMyPlugin(logger *log.Logger) (*MyPlugin, error) {
    pluginInfo := &plugin.ProviderInfo{
        ID:          "my-plugin-id",
        Name:        "My Plugin Name",
        Version:     "1.0.0",
        Description: "This is a plugin for demonstration purposes",
        Author:      "Your Name",
        URL:         "https://github.com/yourusername/myplugin",
    }

    basePlugin := plugin.NewBasePlugin(pluginInfo, logger)
    return &MyPlugin{
        BasePlugin: basePlugin,
    }, nil
}

📚 Documentation

Contribution Guide

Contributions are welcome! Please follow these steps:

1. Create a Repository
   Fork the project repository to your account.
2. Submit Changes
   Make changes on your own branch and ensure you follow the coding standards.
3. Submit a Pull Request
   Submit a Pull Request to the main repository with detailed descriptions.
4. Participate in Discussions
   Respond to the maintainers' comments and adjust your code according to the feedback.

Contributors List

• John Doe - Initial project creator
• Jane Smith - Core development member
• Bob Johnson - Main contributor to the plugin system

Documentation History

• v1.0.0 - October 2023: Initial version released, including STDIO and HTTP support.
• v1.1.0 - November 2023: Added TCP and WebSocket support.
• v1.2.0 - January 2024: Plugin system functionality improved.

Getting Help

If you encounter problems during use, you can get help in the following ways:

• Email Support: framework - support@freepeak.org
• GitHub Issue Tracking: https://github.com/FreePeak/cortex/issues

🔧 Technical Details

No technical details (more than 50 - word specific technical descriptions) are provided in the original document, so this section is skipped.

📄 License

No license information is provided in the original document, so this section is skipped.

API Documentation

The complete API documentation can be found at: https://pkg.go.dev/github.com/FreePeak/cortex