Infer a tool output schema - Smithery

GET

servers

{qualifiedName}

experimental

tools

{toolName}

output-schema

Try it

Infer a tool output schema

cURL

curl --request GET \
  --url https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

401

403

404

503

{
  "qualifiedName": "smithery-ai/github",
  "toolName": "search_repositories",
  "sampleCount": 25,
  "zodSchema": "z.object({ \"items\": z.array(z.object({})).optional() })"
}

{
  "error": "No output samples found"
}

{
  "error": "No output samples found"
}

{
  "error": "No output samples found"
}

{
  "error": "No output samples found"
}

Authorizations

[

](#authorization-authorization)

Authorization

string

header

required

Smithery API key as Bearer token

Path Parameters

[

](#parameter-qualified-name)

qualifiedName

string

required

The server's qualified name (e.g. 'namespace/server' or 'namespace' for namespace-only servers). Use %2F to encode the slash.

[

](#parameter-tool-name)

toolName

string

required

Response

200

application/json

Inferred tool output schema

[

](#response-qualified-name)

qualifiedName

string

required

Example:

"smithery-ai/github"

[

](#response-tool-name)

toolName

string

required

Example:

"search_repositories"

[

](#response-sample-count)

sampleCount

number

required

Example:

25

[

](#response-zod-schema)

zodSchema

string

required

Example:

"z.object({ \"items\": z.array(z.object({})).optional() })"

Was this page helpful?

YesNo

⌘I

Infer a tool output schema

cURL

curl --request GET \
  --url https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smithery.ai/servers/{qualifiedName}/experimental/tools/{toolName}/output-schema")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

401

403

404

503

{
  "qualifiedName": "smithery-ai/github",
  "toolName": "search_repositories",
  "sampleCount": 25,
  "zodSchema": "z.object({ \"items\": z.array(z.object({})).optional() })"
}

{
  "error": "No output samples found"
}

{
  "error": "No output samples found"
}

{
  "error": "No output samples found"
}

{
  "error": "No output samples found"
}