Dry-run plan for a tool (does not execute the handler)
curl --request POST \
--url http://localhost:3000/api/v1/tools/test \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"args": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/tools/test"
payload = {
"name": "<string>",
"args": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', args: '<string>'})
};
fetch('http://localhost:3000/api/v1/tools/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/tools/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'args' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/tools/test"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"args\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/tools/test")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"args\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/tools/test")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"args\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"access": {
"action": "<string>",
"kind": "<string>",
"resource": "<string>",
"risk": "<string>"
},
"args": {},
"executed": false,
"invokeCommand": "<string>",
"mode": "dry_run",
"schema": {},
"tool": {
"description": "<string>",
"metadata": {
"args": [
{}
],
"command": "<string>",
"group": "<string>",
"method": "<string>",
"options": [
{}
],
"access": {
"action": "<string>",
"kind": "<string>",
"resource": "<string>",
"risk": "<string>"
},
"scope": "<string>",
"skillGate": {
"skill": "<string>",
"source": "<string>",
"ruleId": "<string>"
}
},
"name": "<string>"
}
}tools
Dry-run plan for a tool (does not execute the handler)
POST
/
api
/
v1
/
tools
/
test
Dry-run plan for a tool (does not execute the handler)
curl --request POST \
--url http://localhost:3000/api/v1/tools/test \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"args": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/tools/test"
payload = {
"name": "<string>",
"args": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', args: '<string>'})
};
fetch('http://localhost:3000/api/v1/tools/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/tools/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'args' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/tools/test"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"args\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/tools/test")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"args\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/tools/test")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"args\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"access": {
"action": "<string>",
"kind": "<string>",
"resource": "<string>",
"risk": "<string>"
},
"args": {},
"executed": false,
"invokeCommand": "<string>",
"mode": "dry_run",
"schema": {},
"tool": {
"description": "<string>",
"metadata": {
"args": [
{}
],
"command": "<string>",
"group": "<string>",
"method": "<string>",
"options": [
{}
],
"access": {
"action": "<string>",
"kind": "<string>",
"resource": "<string>",
"risk": "<string>"
},
"scope": "<string>",
"skillGate": {
"skill": "<string>",
"source": "<string>",
"ruleId": "<string>"
}
},
"name": "<string>"
}
}Response
Success — body conforms to the @Returns schema.