butterfly-bot 0.2.2

Butterfly Bot is an opinionated personal-ops AI assistant built for people who want results, not setup overhead.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

use async_trait::async_trait;
use serde_json::Value;

use crate::error::Result;

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ToolSecret {
    pub name: String,
    pub prompt: String,
}

impl ToolSecret {
    pub fn new(name: &str, prompt: &str) -> Self {
        Self {
            name: name.to_string(),
            prompt: prompt.to_string(),
        }
    }
}

#[async_trait]
pub trait Tool: Send + Sync {
    fn name(&self) -> &str;
    fn description(&self) -> &str;
    fn parameters(&self) -> Value;
    fn required_secrets(&self) -> Vec<ToolSecret> {
        Vec::new()
    }
    fn required_secrets_for_config(&self, _config: &Value) -> Vec<ToolSecret> {
        self.required_secrets()
    }
    fn configure(&self, _config: &Value) -> Result<()> {
        Ok(())
    }
    async fn execute(&self, params: Value) -> Result<Value>;
}

pub trait Plugin: Send + Sync {
    fn name(&self) -> &str;
    fn description(&self) -> &str;
    fn initialize(&self, tool_registry: &crate::plugins::registry::ToolRegistry) -> bool;
}

pub trait PluginManager: Send + Sync {
    fn register_plugin(&mut self, plugin: Box<dyn Plugin>) -> bool;
    fn load_plugins(&mut self) -> Vec<String>;
    fn get_plugin(&self, name: &str) -> Option<&dyn Plugin>;
    fn list_plugins(&self) -> Vec<serde_json::Value>;
    fn configure(&mut self, config: Value);
}