v1
Create Mcp Server Connection
Create an MCP server spec and instance in one transaction.
POST
/
v1
/
mcp-server-instances
/
with-spec
Create Mcp Server Connection
curl --request POST \
--url https://api.example.com/v1/mcp-server-instances/with-spec \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"instance": {
"name": "<string>",
"auth_config_id": "<string>",
"description": "<string>",
"json_spec": {}
},
"server": {
"description": "<string>",
"name": "<string>",
"cmd": [
"<string>"
],
"docker_image_url": "<string>",
"env_schema": [
{}
],
"is_public": false,
"json_spec": {},
"registry_url": "<string>",
"remote_url": "<string>",
"tags": [
"<string>"
],
"version": "1.0.0"
}
}
'import requests
url = "https://api.example.com/v1/mcp-server-instances/with-spec"
payload = {
"instance": {
"name": "<string>",
"auth_config_id": "<string>",
"description": "<string>",
"json_spec": {}
},
"server": {
"description": "<string>",
"name": "<string>",
"cmd": ["<string>"],
"docker_image_url": "<string>",
"env_schema": [{}],
"is_public": False,
"json_spec": {},
"registry_url": "<string>",
"remote_url": "<string>",
"tags": ["<string>"],
"version": "1.0.0"
}
}
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({
instance: {
name: '<string>',
auth_config_id: '<string>',
description: '<string>',
json_spec: {}
},
server: {
description: '<string>',
name: '<string>',
cmd: ['<string>'],
docker_image_url: '<string>',
env_schema: [{}],
is_public: false,
json_spec: {},
registry_url: '<string>',
remote_url: '<string>',
tags: ['<string>'],
version: '1.0.0'
}
})
};
fetch('https://api.example.com/v1/mcp-server-instances/with-spec', 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.example.com/v1/mcp-server-instances/with-spec",
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([
'instance' => [
'name' => '<string>',
'auth_config_id' => '<string>',
'description' => '<string>',
'json_spec' => [
]
],
'server' => [
'description' => '<string>',
'name' => '<string>',
'cmd' => [
'<string>'
],
'docker_image_url' => '<string>',
'env_schema' => [
[
]
],
'is_public' => false,
'json_spec' => [
],
'registry_url' => '<string>',
'remote_url' => '<string>',
'tags' => [
'<string>'
],
'version' => '1.0.0'
]
]),
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.example.com/v1/mcp-server-instances/with-spec"
payload := strings.NewReader("{\n \"instance\": {\n \"name\": \"<string>\",\n \"auth_config_id\": \"<string>\",\n \"description\": \"<string>\",\n \"json_spec\": {}\n },\n \"server\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"cmd\": [\n \"<string>\"\n ],\n \"docker_image_url\": \"<string>\",\n \"env_schema\": [\n {}\n ],\n \"is_public\": false,\n \"json_spec\": {},\n \"registry_url\": \"<string>\",\n \"remote_url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\"\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.example.com/v1/mcp-server-instances/with-spec")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"instance\": {\n \"name\": \"<string>\",\n \"auth_config_id\": \"<string>\",\n \"description\": \"<string>\",\n \"json_spec\": {}\n },\n \"server\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"cmd\": [\n \"<string>\"\n ],\n \"docker_image_url\": \"<string>\",\n \"env_schema\": [\n {}\n ],\n \"is_public\": false,\n \"json_spec\": {},\n \"registry_url\": \"<string>\",\n \"remote_url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/mcp-server-instances/with-spec")
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 \"instance\": {\n \"name\": \"<string>\",\n \"auth_config_id\": \"<string>\",\n \"description\": \"<string>\",\n \"json_spec\": {}\n },\n \"server\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"cmd\": [\n \"<string>\"\n ],\n \"docker_image_url\": \"<string>\",\n \"env_schema\": [\n {}\n ],\n \"is_public\": false,\n \"json_spec\": {},\n \"registry_url\": \"<string>\",\n \"remote_url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\"\n }\n}"
response = http.request(request)
puts response.read_body{
"created_at": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"json_spec": {},
"name": "<string>",
"server_spec_id": "<string>",
"updated_at": "<string>",
"verification": {},
"auth_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_dispatch": {},
"tools": [
{}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Show child attributes
Show child attributes
Payload for creating an MCP server spec (catalog template).
Either docker_image_url (for container-based servers) or
remote_url (for HTTP-based servers like GitHub Copilot) should be
supplied. env_schema describes the variables an instance built from
this spec needs to provide; secret entries (isSecret: true) are
routed through the secret manager rather than stored in plaintext.
Show child attributes
Show child attributes
Response
Successful Response
⌘I
Create Mcp Server Connection
curl --request POST \
--url https://api.example.com/v1/mcp-server-instances/with-spec \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"instance": {
"name": "<string>",
"auth_config_id": "<string>",
"description": "<string>",
"json_spec": {}
},
"server": {
"description": "<string>",
"name": "<string>",
"cmd": [
"<string>"
],
"docker_image_url": "<string>",
"env_schema": [
{}
],
"is_public": false,
"json_spec": {},
"registry_url": "<string>",
"remote_url": "<string>",
"tags": [
"<string>"
],
"version": "1.0.0"
}
}
'import requests
url = "https://api.example.com/v1/mcp-server-instances/with-spec"
payload = {
"instance": {
"name": "<string>",
"auth_config_id": "<string>",
"description": "<string>",
"json_spec": {}
},
"server": {
"description": "<string>",
"name": "<string>",
"cmd": ["<string>"],
"docker_image_url": "<string>",
"env_schema": [{}],
"is_public": False,
"json_spec": {},
"registry_url": "<string>",
"remote_url": "<string>",
"tags": ["<string>"],
"version": "1.0.0"
}
}
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({
instance: {
name: '<string>',
auth_config_id: '<string>',
description: '<string>',
json_spec: {}
},
server: {
description: '<string>',
name: '<string>',
cmd: ['<string>'],
docker_image_url: '<string>',
env_schema: [{}],
is_public: false,
json_spec: {},
registry_url: '<string>',
remote_url: '<string>',
tags: ['<string>'],
version: '1.0.0'
}
})
};
fetch('https://api.example.com/v1/mcp-server-instances/with-spec', 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.example.com/v1/mcp-server-instances/with-spec",
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([
'instance' => [
'name' => '<string>',
'auth_config_id' => '<string>',
'description' => '<string>',
'json_spec' => [
]
],
'server' => [
'description' => '<string>',
'name' => '<string>',
'cmd' => [
'<string>'
],
'docker_image_url' => '<string>',
'env_schema' => [
[
]
],
'is_public' => false,
'json_spec' => [
],
'registry_url' => '<string>',
'remote_url' => '<string>',
'tags' => [
'<string>'
],
'version' => '1.0.0'
]
]),
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.example.com/v1/mcp-server-instances/with-spec"
payload := strings.NewReader("{\n \"instance\": {\n \"name\": \"<string>\",\n \"auth_config_id\": \"<string>\",\n \"description\": \"<string>\",\n \"json_spec\": {}\n },\n \"server\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"cmd\": [\n \"<string>\"\n ],\n \"docker_image_url\": \"<string>\",\n \"env_schema\": [\n {}\n ],\n \"is_public\": false,\n \"json_spec\": {},\n \"registry_url\": \"<string>\",\n \"remote_url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\"\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.example.com/v1/mcp-server-instances/with-spec")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"instance\": {\n \"name\": \"<string>\",\n \"auth_config_id\": \"<string>\",\n \"description\": \"<string>\",\n \"json_spec\": {}\n },\n \"server\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"cmd\": [\n \"<string>\"\n ],\n \"docker_image_url\": \"<string>\",\n \"env_schema\": [\n {}\n ],\n \"is_public\": false,\n \"json_spec\": {},\n \"registry_url\": \"<string>\",\n \"remote_url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/mcp-server-instances/with-spec")
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 \"instance\": {\n \"name\": \"<string>\",\n \"auth_config_id\": \"<string>\",\n \"description\": \"<string>\",\n \"json_spec\": {}\n },\n \"server\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"cmd\": [\n \"<string>\"\n ],\n \"docker_image_url\": \"<string>\",\n \"env_schema\": [\n {}\n ],\n \"is_public\": false,\n \"json_spec\": {},\n \"registry_url\": \"<string>\",\n \"remote_url\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"1.0.0\"\n }\n}"
response = http.request(request)
puts response.read_body{
"created_at": "<string>",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"json_spec": {},
"name": "<string>",
"server_spec_id": "<string>",
"updated_at": "<string>",
"verification": {},
"auth_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_dispatch": {},
"tools": [
{}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}