ContextQMD
Back to Smithery

Get tool

docs-api-reference-connect-get-tool.md

latest7.0 KB
Original Source

GET

/

connect

/

{namespace}

/

{connectionId}

/

.tools

/

{toolPath}

Try it

Get tool

cURL

curl --request GET \
  --url https://api.smithery.ai/connect/{namespace}/{connectionId}/.tools/{toolPath} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.smithery.ai/connect/{namespace}/{connectionId}/.tools/{toolPath}"

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/connect/{namespace}/{connectionId}/.tools/{toolPath}', 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/connect/{namespace}/{connectionId}/.tools/{toolPath}",
  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/connect/{namespace}/{connectionId}/.tools/{toolPath}"

	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/connect/{namespace}/{connectionId}/.tools/{toolPath}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smithery.ai/connect/{namespace}/{connectionId}/.tools/{toolPath}")

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

404

{
  "name": "<string>",
  "inputSchema": {
    "type": "object",
    "properties": {},
    "required": [
      "<string>"
    ]
  },
  "title": "<string>",
  "icons": [
    {
      "src": "<string>",
      "mimeType": "<string>",
      "sizes": [
        "<string>"
      ],
      "theme": "light"
    }
  ],
  "description": "<string>",
  "outputSchema": {
    "type": "object",
    "properties": {},
    "required": [
      "<string>"
    ]
  },
  "annotations": {
    "title": "<string>",
    "readOnlyHint": true,
    "destructiveHint": true,
    "idempotentHint": true,
    "openWorldHint": true
  },
  "execution": {
    "taskSupport": "required"
  },
  "_meta": {}
}

{
  "error": "not_found",
  "message": "Resource not found"
}

Authorizations

[​

](#authorization-authorization)

Authorization

string

header

required

Smithery API key as Bearer token

Path Parameters

[​

](#parameter-namespace)

namespace

string

required

[​

](#parameter-connection-id)

connectionId

string

required

[​

](#parameter-tool-path)

toolPath

string

required

Response

200

application/json

Tool metadata or category listing

Option 1

Option 2

[​

](#response-one-of-0-name)

name

string

required

[​

](#response-one-of-0-input-schema)

inputSchema

object

required

Show child attributes

[​

](#response-one-of-0-title)

title

string

[​

](#response-one-of-0-icons)

icons

object[]

Show child attributes

[​

](#response-one-of-0-description)

description

string

[​

](#response-one-of-0-output-schema)

outputSchema

object

Show child attributes

[​

](#response-one-of-0-annotations)

annotations

object

Show child attributes

[​

](#response-one-of-0-execution)

execution

object

Show child attributes

[​

](#response-one-of-0-meta)

_meta

object

Show child attributes

Was this page helpful?

YesNo

⌘I

Get tool

cURL

curl --request GET \
  --url https://api.smithery.ai/connect/{namespace}/{connectionId}/.tools/{toolPath} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.smithery.ai/connect/{namespace}/{connectionId}/.tools/{toolPath}"

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/connect/{namespace}/{connectionId}/.tools/{toolPath}', 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/connect/{namespace}/{connectionId}/.tools/{toolPath}",
  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/connect/{namespace}/{connectionId}/.tools/{toolPath}"

	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/connect/{namespace}/{connectionId}/.tools/{toolPath}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smithery.ai/connect/{namespace}/{connectionId}/.tools/{toolPath}")

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

404

{
  "name": "<string>",
  "inputSchema": {
    "type": "object",
    "properties": {},
    "required": [
      "<string>"
    ]
  },
  "title": "<string>",
  "icons": [
    {
      "src": "<string>",
      "mimeType": "<string>",
      "sizes": [
        "<string>"
      ],
      "theme": "light"
    }
  ],
  "description": "<string>",
  "outputSchema": {
    "type": "object",
    "properties": {},
    "required": [
      "<string>"
    ]
  },
  "annotations": {
    "title": "<string>",
    "readOnlyHint": true,
    "destructiveHint": true,
    "idempotentHint": true,
    "openWorldHint": true
  },
  "execution": {
    "taskSupport": "required"
  },
  "_meta": {}
}

{
  "error": "not_found",
  "message": "Resource not found"
}