Connect MCP client

Connect to an MCP client

POST /ai/mcpClients/connect

Connect MCP client

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/ai/mcpClients/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mcpClient": {
    "kind": "<string>",
    "name": "<string>",
    "url": "<string>",
    "authentication": {
      "issuedAt": "<string>",
      "accessToken": "<string>",
      "expiresIn": 123,
      "refreshToken": "<string>",
      "scope": "<string>",
      "tokenType": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>"
    },
    "disabledToolSlugs": [
      "<string>"
    ]
  }
}
'

import requests

url = "https://api.getcargo.io/v1/ai/mcpClients/connect"

payload = { "mcpClient": {
        "kind": "<string>",
        "name": "<string>",
        "url": "<string>",
        "authentication": {
            "issuedAt": "<string>",
            "accessToken": "<string>",
            "expiresIn": 123,
            "refreshToken": "<string>",
            "scope": "<string>",
            "tokenType": "<string>",
            "clientId": "<string>",
            "clientSecret": "<string>"
        },
        "disabledToolSlugs": ["<string>"]
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    mcpClient: {
      kind: '<string>',
      name: '<string>',
      url: '<string>',
      authentication: {
        issuedAt: '<string>',
        accessToken: '<string>',
        expiresIn: 123,
        refreshToken: '<string>',
        scope: '<string>',
        tokenType: '<string>',
        clientId: '<string>',
        clientSecret: '<string>'
      },
      disabledToolSlugs: ['<string>']
    }
  })
};

fetch('https://api.getcargo.io/v1/ai/mcpClients/connect', 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.getcargo.io/v1/ai/mcpClients/connect",
  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([
    'mcpClient' => [
        'kind' => '<string>',
        'name' => '<string>',
        'url' => '<string>',
        'authentication' => [
                'issuedAt' => '<string>',
                'accessToken' => '<string>',
                'expiresIn' => 123,
                'refreshToken' => '<string>',
                'scope' => '<string>',
                'tokenType' => '<string>',
                'clientId' => '<string>',
                'clientSecret' => '<string>'
        ],
        'disabledToolSlugs' => [
                '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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 := "https://api.getcargo.io/v1/ai/mcpClients/connect"

	payload := strings.NewReader("{\n  \"mcpClient\": {\n    \"kind\": \"<string>\",\n    \"name\": \"<string>\",\n    \"url\": \"<string>\",\n    \"authentication\": {\n      \"issuedAt\": \"<string>\",\n      \"accessToken\": \"<string>\",\n      \"expiresIn\": 123,\n      \"refreshToken\": \"<string>\",\n      \"scope\": \"<string>\",\n      \"tokenType\": \"<string>\",\n      \"clientId\": \"<string>\",\n      \"clientSecret\": \"<string>\"\n    },\n    \"disabledToolSlugs\": [\n      \"<string>\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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("https://api.getcargo.io/v1/ai/mcpClients/connect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mcpClient\": {\n    \"kind\": \"<string>\",\n    \"name\": \"<string>\",\n    \"url\": \"<string>\",\n    \"authentication\": {\n      \"issuedAt\": \"<string>\",\n      \"accessToken\": \"<string>\",\n      \"expiresIn\": 123,\n      \"refreshToken\": \"<string>\",\n      \"scope\": \"<string>\",\n      \"tokenType\": \"<string>\",\n      \"clientId\": \"<string>\",\n      \"clientSecret\": \"<string>\"\n    },\n    \"disabledToolSlugs\": [\n      \"<string>\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/ai/mcpClients/connect")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mcpClient\": {\n    \"kind\": \"<string>\",\n    \"name\": \"<string>\",\n    \"url\": \"<string>\",\n    \"authentication\": {\n      \"issuedAt\": \"<string>\",\n      \"accessToken\": \"<string>\",\n      \"expiresIn\": 123,\n      \"refreshToken\": \"<string>\",\n      \"scope\": \"<string>\",\n      \"tokenType\": \"<string>\",\n      \"clientId\": \"<string>\",\n      \"clientSecret\": \"<string>\"\n    },\n    \"disabledToolSlugs\": [\n      \"<string>\"\n    ]\n  }\n}"

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

200

{
  "outcome": "<string>",
  "tools": [
    {
      "slug": "<string>",
      "config": {
        "jsonSchema": "<unknown>"
      },
      "description": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

mcpClient · MCP client · object · required

MCP client connection details.

MCP client

MCP client

Show child attributes

Response

200

application/json

Successful response

outcome · string · required

Connection outcome.

Allowed value: "connected"

tools · Tools · object[] · required

Available tools from the MCP server.

Show child attributes