- feature: tools backend as tool argument

dcSpark · Aug 29, 2024 · de27493 · de27493
1 parent 979964a
commit de27493
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 25 deletions.
diff --git a/libs/shinkai-tools-runner/src/built_in_tools.test.rs b/libs/shinkai-tools-runner/src/built_in_tools.test.rs
@@ -6,7 +6,7 @@ use crate::built_in_tools::{get_tool, get_tools};
 async fn get_tools_all_load() {
     let tools = get_tools();
     for (tool_name, tool_definition) in tools {
-        let mut tool_instance = crate::tools::tool::Tool::new(tool_definition.code.unwrap(), Value::Null);
+        let mut tool_instance = crate::tools::tool::Tool::new(tool_definition.code.unwrap(), Value::Null, None);
         let defintion = tool_instance
             .get_definition()
             .await;

diff --git a/libs/shinkai-tools-runner/src/lib.test.rs b/libs/shinkai-tools-runner/src/lib.test.rs
@@ -7,6 +7,7 @@ async fn shinkai_tool_echo() {
     let tool = Tool::new(
         tool_definition.code.clone().unwrap(),
         serde_json::Value::Null,
+        None,
     );
     let run_result = tool
         .run(serde_json::json!({ "message": "valparaíso" }), None)
@@ -21,6 +22,7 @@ async fn shinkai_tool_weather_by_city() {
     let tool = Tool::new(
         tool_definition.code.clone().unwrap(),
         serde_json::json!({ "apiKey": "63d35ff6068c3103ccd1227526935675" }),
+        None,
     );
     let run_result = tool
         .run(serde_json::json!({ "city": "valparaíso" }), None)
@@ -55,7 +57,7 @@ async fn shinkai_tool_inline() {
 
     globalThis.tool = { Tool };
 "#;
-    let tool = Tool::new(js_code.to_string(), serde_json::Value::Null);
+    let tool = Tool::new(js_code.to_string(), serde_json::Value::Null, None);
     let run_result = tool
         .run(serde_json::json!({ "name": "world" }), None)
         .await
@@ -69,6 +71,7 @@ async fn shinkai_tool_web3_eth_balance() {
     let tool = Tool::new(
         tool_definition.code.clone().unwrap(),
         serde_json::Value::Null,
+        None,
     );
     let run_result = tool
         .run(
@@ -86,6 +89,7 @@ async fn shinkai_tool_web3_eth_uniswap() {
     let tool = Tool::new(
         tool_definition.code.clone().unwrap(),
         serde_json::Value::Null,
+        None,
     );
     let run_result = tool
         .run(
@@ -109,6 +113,7 @@ async fn shinkai_tool_download_page() {
     let tool = Tool::new(
         tool_definition.code.clone().unwrap(),
         serde_json::Value::Null,
+        None,
     );
     let run_result = tool
         .run(
@@ -178,6 +183,7 @@ async fn shinkai_tool_download_page_stack_overflow() {
                 let tool = Tool::new(
                     tool_definition.code.clone().unwrap(),
                     serde_json::Value::Null,
+                    None,
                 );
                 tool.run(
                     serde_json::json!({
@@ -200,6 +206,7 @@ async fn shinkai_tool_leiden() {
     let tool = Tool::new(
         tool_definition.code.clone().unwrap(),
         serde_json::Value::Null,
+        None,
     );
     let edges = vec![
         (2, 1, 1),
@@ -303,6 +310,7 @@ async fn shinkai_tool_duckduckgo_search() {
     let tool = Tool::new(
         tool_definition.code.clone().unwrap(),
         serde_json::Value::Null,
+        None,
     );
     let run_result = tool
         .run(
@@ -328,6 +336,7 @@ async fn shinkai_tool_playwright_example() {
     let tool = Tool::new(
         tool_definition.code.clone().unwrap(),
         serde_json::json!({ "chromePath": std::env::var("CHROME_PATH").ok().unwrap_or("".to_string()) }),
+        None,
     );
     let run_result = tool
         .run(
@@ -353,6 +362,7 @@ async fn shinkai_tool_defillama_lending_tvl_rankings() {
     let tool = Tool::new(
         tool_definition.code.clone().unwrap(),
         serde_json::json!({ "chromePath": std::env::var("CHROME_PATH").ok().unwrap_or("".to_string()) }),
+        None,
     );
     let run_result = tool.run(serde_json::json!({ "all": true }), None).await;
     assert!(run_result.is_ok());
@@ -365,6 +375,7 @@ async fn shinkai_tool_aave_loan_requester() {
     let tool = Tool::new(
         tool_definition.code.clone().unwrap(),
         serde_json::json!({ "chromePath": std::env::var("CHROME_PATH").ok().unwrap_or("".to_string()) }),
+        None,
     );
     let run_result = tool
         .run(

diff --git a/libs/shinkai-tools-runner/src/tools/mod.rs b/libs/shinkai-tools-runner/src/tools/mod.rs
@@ -2,4 +2,5 @@ pub mod tool;
 pub mod run_result;
 pub mod tool_definition;
 pub mod execution_error;
+pub mod shinkai_tools_backend_options;
 pub mod shinkai_tools_backend;
diff --git a/libs/shinkai-tools-runner/src/tools/shinkai_tools_backend.rs b/libs/shinkai-tools-runner/src/tools/shinkai_tools_backend.rs
@@ -1,18 +1,19 @@
 use std::process::{Child, Command};
 
+use super::shinkai_tools_backend_options::ShinkaiToolsBackendOptions;
+
+#[derive(Default)]
 pub struct ShinkaiToolsBackend {
     child: Option<Child>,
-}
-
-impl Default for ShinkaiToolsBackend {
-    fn default() -> Self {
-        Self { child: None }
-    }
+    options: ShinkaiToolsBackendOptions,
 }
 
 impl ShinkaiToolsBackend {
-    fn new() -> Self {
-        ShinkaiToolsBackend::default()
+    pub fn new(options: ShinkaiToolsBackendOptions) -> Self {
+        ShinkaiToolsBackend {
+            options,
+            ..Default::default()
+        }
     }
 
     pub async fn run(&mut self) -> Result<(), std::io::Error> {
@@ -21,11 +22,13 @@ impl ShinkaiToolsBackend {
             self.kill().await?;
         }
 
-        // Spawn the child process using native spawn
-        let child_process = Command::new("./shinkai-tools-runner-resources/shinkai-tools-backend").spawn().map_err(|e| {
-            println!("Error spawning child process: {}", e);
-            e
-        })?;
+        let child_process = Command::new(self.options.binary_path.clone())
+            .env("PORT", self.options.api_port.to_string())
+            .spawn()
+            .map_err(|e| {
+                println!("Error spawning child process: {}", e);
+                e
+            })?;
         let pid = child_process.id();
         self.child = Some(child_process);
         println!("Started new child process with PID: {}", pid);

diff --git a/libs/shinkai-tools-runner/src/tools/shinkai_tools_backend_options.rs b/libs/shinkai-tools-runner/src/tools/shinkai_tools_backend_options.rs
@@ -0,0 +1,16 @@
+use std::path::PathBuf;
+
+#[derive(Clone)]
+pub struct ShinkaiToolsBackendOptions {
+    pub binary_path: PathBuf,
+    pub api_port: u16,
+}
+
+impl Default for ShinkaiToolsBackendOptions {
+    fn default() -> Self {
+        Self {
+            binary_path: PathBuf::from("./shinkai-tools-runner-resources/shinkai-tools-backend"),
+            api_port: 9650,
+        }
+    }
+}
diff --git a/libs/shinkai-tools-runner/src/tools/tool.rs b/libs/shinkai-tools-runner/src/tools/tool.rs
@@ -1,29 +1,39 @@
-use std::time::Duration;
+use std::{path::PathBuf, time::Duration};
 
 use reqwest::{header, Client};
 use serde_json::Value;
 
 use super::{
-    execution_error::ExecutionError, run_result::RunResult,
-    shinkai_tools_backend::ShinkaiToolsBackend, tool_definition::ToolDefinition,
+    execution_error::ExecutionError,
+    run_result::RunResult,
+    shinkai_tools_backend::{self, ShinkaiToolsBackend},
+    shinkai_tools_backend_options::ShinkaiToolsBackendOptions,
+    tool_definition::ToolDefinition,
 };
 
 pub struct Tool {
     tool_backend_url: String,
     code: String,
     configurations: Value,
     http_client: Client,
+    shinkai_tools_backend_options: ShinkaiToolsBackendOptions,
 }
 
 impl Tool {
     pub const MAX_EXECUTION_TIME_MS_INTERNAL_OPS: u64 = 1000;
 
-    pub fn new(code: String, configurations: Value) -> Self {
+    pub fn new(
+        code: String,
+        configurations: Value,
+        shinkai_tools_backend_options: Option<ShinkaiToolsBackendOptions>,
+    ) -> Self {
+        let options = shinkai_tools_backend_options.unwrap_or_default();
         Tool {
-            tool_backend_url: "http://127.0.0.1:3000".to_string(),
+            tool_backend_url: format!("http://127.0.0.1:{}", options.api_port).to_string(),
             code,
             configurations,
             http_client: Self::build_http_client(),
+            shinkai_tools_backend_options: options,
         }
     }
 
@@ -86,7 +96,7 @@ impl Tool {
     }
 
     pub async fn get_definition(&mut self) -> Result<ToolDefinition, ExecutionError> {
-        let mut shinkai_tool_backend = ShinkaiToolsBackend::default();
+        let mut shinkai_tool_backend = ShinkaiToolsBackend::new(self.shinkai_tools_backend_options.clone());
         let _ = shinkai_tool_backend.run().await;
         let result = self.internal_get_definition().await;
         let _ = shinkai_tool_backend.kill().await;
@@ -156,7 +166,7 @@ impl Tool {
         parameters: Value,
         max_execution_time_s: Option<u64>,
     ) -> Result<RunResult, ExecutionError> {
-        let mut shinkai_tool_backend = ShinkaiToolsBackend::default();
+        let mut shinkai_tool_backend = ShinkaiToolsBackend::new(self.shinkai_tools_backend_options.clone());
         let _ = shinkai_tool_backend.run().await;
         let result = self.internal_run(parameters, max_execution_time_s).await;
         let _ = shinkai_tool_backend.kill().await;

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@shinkai_protocol/source",
-  "version": "0.7.4",
+  "version": "0.7.5",
   "description": "This repository serves as the ecosystem to execute Shinkai tools, provided by the Shinkai team or third-party developers, in a secure environment. It provides a sandboxed space for executing these tools, ensuring that they run safely and efficiently, while also allowing for seamless integration with Rust code.",
   "main": "index.js",
   "author": "",