Create custom tool

curl --request POST \
  --url https://beta.getsales.io/integrations/v1/api/custom-tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "name": "<string>",
  "request": {
    "url": "<string>",
    "headers": {},
    "body": {}
  },
  "description": "<string>",
  "provider_connection_sid": "<string>",
  "input_schema": [
    {
      "key": "<string>",
      "required": true
    }
  ],
  "output_mapping": {}
}
'

import requests

url = "https://beta.getsales.io/integrations/v1/api/custom-tools"

payload = {
    "name": "<string>",
    "request": {
        "url": "<string>",
        "headers": {},
        "body": {}
    },
    "description": "<string>",
    "provider_connection_sid": "<string>",
    "input_schema": [
        {
            "key": "<string>",
            "required": True
        }
    ],
    "output_mapping": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Team-SID": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Team-SID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    request: {url: '<string>', headers: {}, body: JSON.stringify({})},
    description: '<string>',
    provider_connection_sid: '<string>',
    input_schema: [{key: '<string>', required: true}],
    output_mapping: {}
  })
};

fetch('https://beta.getsales.io/integrations/v1/api/custom-tools', 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://beta.getsales.io/integrations/v1/api/custom-tools",
  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>',
    'request' => [
        'url' => '<string>',
        'headers' => [
                
        ],
        'body' => [
                
        ]
    ],
    'description' => '<string>',
    'provider_connection_sid' => '<string>',
    'input_schema' => [
        [
                'key' => '<string>',
                'required' => true
        ]
    ],
    'output_mapping' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Team-SID: <api-key>"
  ],
]);

$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://beta.getsales.io/integrations/v1/api/custom-tools"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"request\": {\n    \"url\": \"<string>\",\n    \"headers\": {},\n    \"body\": {}\n  },\n  \"description\": \"<string>\",\n  \"provider_connection_sid\": \"<string>\",\n  \"input_schema\": [\n    {\n      \"key\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"output_mapping\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Team-SID", "<api-key>")
	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://beta.getsales.io/integrations/v1/api/custom-tools")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"request\": {\n    \"url\": \"<string>\",\n    \"headers\": {},\n    \"body\": {}\n  },\n  \"description\": \"<string>\",\n  \"provider_connection_sid\": \"<string>\",\n  \"input_schema\": [\n    {\n      \"key\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"output_mapping\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/integrations/v1/api/custom-tools")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"request\": {\n    \"url\": \"<string>\",\n    \"headers\": {},\n    \"body\": {}\n  },\n  \"description\": \"<string>\",\n  \"provider_connection_sid\": \"<string>\",\n  \"input_schema\": [\n    {\n      \"key\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"output_mapping\": {}\n}"

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

{
  "success": true,
  "operation": "create",
  "item": {
    "sid": "<string>",
    "team_sid": "<string>",
    "name": "<string>",
    "description": "<string>",
    "provider_connection_sid": "<string>",
    "request": {
      "method": "GET",
      "url": "<string>",
      "headers": {},
      "body": {}
    },
    "input_schema": [
      {
        "key": "<string>",
        "type": "<string>",
        "required": true
      }
    ],
    "output_mapping": {},
    "status": "on",
    "created_by": {
      "actor_type": "user",
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "actor_name": "<string>",
      "oauth_client_sid": "<string>",
      "reason": "<string>",
      "cluster_id": 123,
      "trace_id": "<string>"
    },
    "deleted_by": {
      "actor_type": "user",
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "actor_name": "<string>",
      "oauth_client_sid": "<string>",
      "reason": "<string>",
      "cluster_id": 123,
      "trace_id": "<string>"
    },
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  },
  "already_exists": true,
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "severity": "hard",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "severity": "hard",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

custom_tools

Create custom tool

Define a team HTTP tool in one write, validated whole so the executor can trust the row: the request template (https, a literal public host, placeholders in the path, query, header values and body strings), the input_schema that declares every placeholder, the output_mapping of names to dot-paths into the response, and the connection the tool authenticates with (provider custom; omit it for a public API). A vendor the platform ships (OpenAI, Hunter…) is a catalog operation, not a custom tool; an API key goes on a provider connection, never into a header. 422 on an undeclared placeholder, a placeholder in the host, a private or non-https target, an auth-shaped header name; 409 on a duplicate name. Then test_custom_tool.

Contract:

MCP tool create_custom_tool, registry package mcp.integrations/custom_tools, mount integrations.providers.
Operation create, response envelope create.
Flags: none.

POST

api

custom-tools

Create custom tool

curl --request POST \
  --url https://beta.getsales.io/integrations/v1/api/custom-tools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Team-SID: <api-key>' \
  --data '
{
  "name": "<string>",
  "request": {
    "url": "<string>",
    "headers": {},
    "body": {}
  },
  "description": "<string>",
  "provider_connection_sid": "<string>",
  "input_schema": [
    {
      "key": "<string>",
      "required": true
    }
  ],
  "output_mapping": {}
}
'

import requests

url = "https://beta.getsales.io/integrations/v1/api/custom-tools"

payload = {
    "name": "<string>",
    "request": {
        "url": "<string>",
        "headers": {},
        "body": {}
    },
    "description": "<string>",
    "provider_connection_sid": "<string>",
    "input_schema": [
        {
            "key": "<string>",
            "required": True
        }
    ],
    "output_mapping": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Team-SID": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Team-SID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    request: {url: '<string>', headers: {}, body: JSON.stringify({})},
    description: '<string>',
    provider_connection_sid: '<string>',
    input_schema: [{key: '<string>', required: true}],
    output_mapping: {}
  })
};

fetch('https://beta.getsales.io/integrations/v1/api/custom-tools', 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://beta.getsales.io/integrations/v1/api/custom-tools",
  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>',
    'request' => [
        'url' => '<string>',
        'headers' => [
                
        ],
        'body' => [
                
        ]
    ],
    'description' => '<string>',
    'provider_connection_sid' => '<string>',
    'input_schema' => [
        [
                'key' => '<string>',
                'required' => true
        ]
    ],
    'output_mapping' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Team-SID: <api-key>"
  ],
]);

$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://beta.getsales.io/integrations/v1/api/custom-tools"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"request\": {\n    \"url\": \"<string>\",\n    \"headers\": {},\n    \"body\": {}\n  },\n  \"description\": \"<string>\",\n  \"provider_connection_sid\": \"<string>\",\n  \"input_schema\": [\n    {\n      \"key\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"output_mapping\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Team-SID", "<api-key>")
	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://beta.getsales.io/integrations/v1/api/custom-tools")
  .header("Authorization", "Bearer <token>")
  .header("Team-SID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"request\": {\n    \"url\": \"<string>\",\n    \"headers\": {},\n    \"body\": {}\n  },\n  \"description\": \"<string>\",\n  \"provider_connection_sid\": \"<string>\",\n  \"input_schema\": [\n    {\n      \"key\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"output_mapping\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://beta.getsales.io/integrations/v1/api/custom-tools")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"request\": {\n    \"url\": \"<string>\",\n    \"headers\": {},\n    \"body\": {}\n  },\n  \"description\": \"<string>\",\n  \"provider_connection_sid\": \"<string>\",\n  \"input_schema\": [\n    {\n      \"key\": \"<string>\",\n      \"required\": true\n    }\n  ],\n  \"output_mapping\": {}\n}"

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

{
  "success": true,
  "operation": "create",
  "item": {
    "sid": "<string>",
    "team_sid": "<string>",
    "name": "<string>",
    "description": "<string>",
    "provider_connection_sid": "<string>",
    "request": {
      "method": "GET",
      "url": "<string>",
      "headers": {},
      "body": {}
    },
    "input_schema": [
      {
        "key": "<string>",
        "type": "<string>",
        "required": true
      }
    ],
    "output_mapping": {},
    "status": "on",
    "created_by": {
      "actor_type": "user",
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "actor_name": "<string>",
      "oauth_client_sid": "<string>",
      "reason": "<string>",
      "cluster_id": 123,
      "trace_id": "<string>"
    },
    "deleted_by": {
      "actor_type": "user",
      "actor_sid": "<string>",
      "team_sid": "<string>",
      "permissions": {},
      "actor_name": "<string>",
      "oauth_client_sid": "<string>",
      "reason": "<string>",
      "cluster_id": 123,
      "trace_id": "<string>"
    },
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  },
  "already_exists": true,
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "severity": "hard",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "recoverable": true,
    "suggestion": "<string>",
    "field_errors": {},
    "blockers": [
      {
        "type": "<string>",
        "severity": "hard",
        "description": "<string>",
        "entity_sid": "<string>",
        "resolution": "<string>",
        "resolution_hint": "<string>",
        "count": 123
      }
    ],
    "context": {}
  },
  "meta": {
    "trace_id": "<string>",
    "span_id": "<string>",
    "timestamp": "<string>",
    "duration_ms": 1,
    "team_sid": "<string>",
    "actor_type": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID

string

header

required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_custom_tool.

name

string

required

Unique within the team, 1..255 chars.

Required string length: 1 - 255

request

object

required

The request template: method, https URL with a literal host, headers and a JSON body, placeholders {{key}} in the path, query, header values and body strings.

Show child attributes

description

string | null

Free text, up to 2000 chars.

Maximum string length: 2000

provider_connection_sid

string | null

A provider connection of provider custom this tool authenticates with (in_cn_...); null = a public API, no auth injected.

Required string length: 18

Pattern: ^in_cn_

input_schema

object[]

The declared inputs, up to 30; default none.

Maximum array length: 30

Show child attributes

output_mapping

object

name to dot-path (person.title), up to 20 entries; default {} = the raw body.

Show child attributes

status

enum<string>

Default on.

Available options:

on,

off

Response

create success envelope.

success

enum<boolean>

required

Available options:

true

operation

enum<string>

required

Available options:

create

item

object

required

Show child attributes

already_exists

boolean

required

Overview

Playtables API

Unibox API

Signals API

Integrations API

ID and Teams API

Create custom tool

Authorizations

Body

Response