Create or update an MCP server
curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/mcp \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"type": "mcp-server/remote",
"name": "<string>",
"description": "<string>",
"url": "<string>",
"display_name": "<string>",
"tool_settings": [
{
"name": "<string>",
"description": "<string>",
"disabled": true,
"annotations": {
"readOnlyHint": true,
"destructiveHint": true
}
}
],
"tool_metadata": {},
"auth_data": {
"type": "header",
"headers": {},
"auth_level": "global"
},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"additional_headers": {},
"forwarded_headers": [
"<string>"
],
"tags": {}
},
"dryRun": false,
"force": false
}
'import requests
url = "https://{controlPlaneURL}/api/svc/v1/mcp"
payload = {
"manifest": {
"type": "mcp-server/remote",
"name": "<string>",
"description": "<string>",
"url": "<string>",
"display_name": "<string>",
"tool_settings": [
{
"name": "<string>",
"description": "<string>",
"disabled": True,
"annotations": {
"readOnlyHint": True,
"destructiveHint": True
}
}
],
"tool_metadata": {},
"auth_data": {
"type": "header",
"headers": {},
"auth_level": "global"
},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"additional_headers": {},
"forwarded_headers": ["<string>"],
"tags": {}
},
"dryRun": False,
"force": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
manifest: {
type: 'mcp-server/remote',
name: '<string>',
description: '<string>',
url: '<string>',
display_name: '<string>',
tool_settings: [
{
name: '<string>',
description: '<string>',
disabled: true,
annotations: {readOnlyHint: true, destructiveHint: true}
}
],
tool_metadata: {},
auth_data: {type: 'header', headers: {}, auth_level: 'global'},
collaborators: [{subject: '<string>', role_id: '<string>'}],
additional_headers: {},
forwarded_headers: ['<string>'],
tags: {}
},
dryRun: false,
force: false
})
};
fetch('https://{controlPlaneURL}/api/svc/v1/mcp', 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://{controlPlaneURL}/api/svc/v1/mcp",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => [
'type' => 'mcp-server/remote',
'name' => '<string>',
'description' => '<string>',
'url' => '<string>',
'display_name' => '<string>',
'tool_settings' => [
[
'name' => '<string>',
'description' => '<string>',
'disabled' => true,
'annotations' => [
'readOnlyHint' => true,
'destructiveHint' => true
]
]
],
'tool_metadata' => [
],
'auth_data' => [
'type' => 'header',
'headers' => [
],
'auth_level' => 'global'
],
'collaborators' => [
[
'subject' => '<string>',
'role_id' => '<string>'
]
],
'additional_headers' => [
],
'forwarded_headers' => [
'<string>'
],
'tags' => [
]
],
'dryRun' => false,
'force' => false
]),
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://{controlPlaneURL}/api/svc/v1/mcp"
payload := strings.NewReader("{\n \"manifest\": {\n \"type\": \"mcp-server/remote\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tool_settings\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"annotations\": {\n \"readOnlyHint\": true,\n \"destructiveHint\": true\n }\n }\n ],\n \"tool_metadata\": {},\n \"auth_data\": {\n \"type\": \"header\",\n \"headers\": {},\n \"auth_level\": \"global\"\n },\n \"collaborators\": [\n {\n \"subject\": \"<string>\",\n \"role_id\": \"<string>\"\n }\n ],\n \"additional_headers\": {},\n \"forwarded_headers\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"dryRun\": false,\n \"force\": false\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{controlPlaneURL}/api/svc/v1/mcp")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": {\n \"type\": \"mcp-server/remote\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tool_settings\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"annotations\": {\n \"readOnlyHint\": true,\n \"destructiveHint\": true\n }\n }\n ],\n \"tool_metadata\": {},\n \"auth_data\": {\n \"type\": \"header\",\n \"headers\": {},\n \"auth_level\": \"global\"\n },\n \"collaborators\": [\n {\n \"subject\": \"<string>\",\n \"role_id\": \"<string>\"\n }\n ],\n \"additional_headers\": {},\n \"forwarded_headers\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"dryRun\": false,\n \"force\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{controlPlaneURL}/api/svc/v1/mcp")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": {\n \"type\": \"mcp-server/remote\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tool_settings\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"annotations\": {\n \"readOnlyHint\": true,\n \"destructiveHint\": true\n }\n }\n ],\n \"tool_metadata\": {},\n \"auth_data\": {\n \"type\": \"header\",\n \"headers\": {},\n \"auth_level\": \"global\"\n },\n \"collaborators\": [\n {\n \"subject\": \"<string>\",\n \"role_id\": \"<string>\"\n }\n ],\n \"additional_headers\": {},\n \"forwarded_headers\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"dryRun\": false,\n \"force\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"fqn": "my-tenant:mcp-server:filesystem-tools",
"tenantName": "<string>",
"manifest": {
"type": "mcp-server/remote",
"name": "<string>",
"description": "<string>",
"url": "<string>",
"display_name": "<string>",
"tls_settings": {
"reject_unauthorized": true,
"ca_cert": "<string>"
},
"tool_settings": [
{
"name": "<string>",
"description": "<string>",
"disabled": true,
"annotations": {
"readOnlyHint": true,
"destructiveHint": true
}
}
],
"tool_policy": {
"enable_tools_by_default": true,
"disabled_tools": [
"<string>"
],
"enabled_tools": [
"<string>"
]
},
"tool_metadata": {},
"auth_data": {
"type": "header",
"headers": {},
"auth_level": "global"
},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"ownedBy": {
"account": "<string>"
},
"additional_headers": {},
"forwarded_headers": [
"<string>"
],
"tags": {}
},
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>",
"subjectPatName": "<string>",
"subjectControllerName": "<string>",
"subjectExternalIdentitySlug": "<string>"
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"proxyUrl": "<string>",
"isAuthOverrideSupported": true,
"authStatus": {
"status": "authenticated",
"method": "oauth",
"expiresAt": "2026-10-01T12:40:00.000Z",
"isRefreshable": true,
"lastUpdatedAt": "2026-10-01T11:40:00.000Z",
"refreshFailureCount": 0,
"refreshFailureMessage": "invalid_grant: refresh token expired"
}
}
}MCP Servers V2
Create or update an MCP server
Creates a new MCP server (when no server with manifest.name exists in the tenant) or updates the existing one.
PUT
/
api
/
svc
/
v1
/
mcp
Create or update an MCP server
curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/mcp \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"type": "mcp-server/remote",
"name": "<string>",
"description": "<string>",
"url": "<string>",
"display_name": "<string>",
"tool_settings": [
{
"name": "<string>",
"description": "<string>",
"disabled": true,
"annotations": {
"readOnlyHint": true,
"destructiveHint": true
}
}
],
"tool_metadata": {},
"auth_data": {
"type": "header",
"headers": {},
"auth_level": "global"
},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"additional_headers": {},
"forwarded_headers": [
"<string>"
],
"tags": {}
},
"dryRun": false,
"force": false
}
'import requests
url = "https://{controlPlaneURL}/api/svc/v1/mcp"
payload = {
"manifest": {
"type": "mcp-server/remote",
"name": "<string>",
"description": "<string>",
"url": "<string>",
"display_name": "<string>",
"tool_settings": [
{
"name": "<string>",
"description": "<string>",
"disabled": True,
"annotations": {
"readOnlyHint": True,
"destructiveHint": True
}
}
],
"tool_metadata": {},
"auth_data": {
"type": "header",
"headers": {},
"auth_level": "global"
},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"additional_headers": {},
"forwarded_headers": ["<string>"],
"tags": {}
},
"dryRun": False,
"force": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
manifest: {
type: 'mcp-server/remote',
name: '<string>',
description: '<string>',
url: '<string>',
display_name: '<string>',
tool_settings: [
{
name: '<string>',
description: '<string>',
disabled: true,
annotations: {readOnlyHint: true, destructiveHint: true}
}
],
tool_metadata: {},
auth_data: {type: 'header', headers: {}, auth_level: 'global'},
collaborators: [{subject: '<string>', role_id: '<string>'}],
additional_headers: {},
forwarded_headers: ['<string>'],
tags: {}
},
dryRun: false,
force: false
})
};
fetch('https://{controlPlaneURL}/api/svc/v1/mcp', 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://{controlPlaneURL}/api/svc/v1/mcp",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => [
'type' => 'mcp-server/remote',
'name' => '<string>',
'description' => '<string>',
'url' => '<string>',
'display_name' => '<string>',
'tool_settings' => [
[
'name' => '<string>',
'description' => '<string>',
'disabled' => true,
'annotations' => [
'readOnlyHint' => true,
'destructiveHint' => true
]
]
],
'tool_metadata' => [
],
'auth_data' => [
'type' => 'header',
'headers' => [
],
'auth_level' => 'global'
],
'collaborators' => [
[
'subject' => '<string>',
'role_id' => '<string>'
]
],
'additional_headers' => [
],
'forwarded_headers' => [
'<string>'
],
'tags' => [
]
],
'dryRun' => false,
'force' => false
]),
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://{controlPlaneURL}/api/svc/v1/mcp"
payload := strings.NewReader("{\n \"manifest\": {\n \"type\": \"mcp-server/remote\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tool_settings\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"annotations\": {\n \"readOnlyHint\": true,\n \"destructiveHint\": true\n }\n }\n ],\n \"tool_metadata\": {},\n \"auth_data\": {\n \"type\": \"header\",\n \"headers\": {},\n \"auth_level\": \"global\"\n },\n \"collaborators\": [\n {\n \"subject\": \"<string>\",\n \"role_id\": \"<string>\"\n }\n ],\n \"additional_headers\": {},\n \"forwarded_headers\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"dryRun\": false,\n \"force\": false\n}")
req, _ := http.NewRequest("PUT", 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.put("https://{controlPlaneURL}/api/svc/v1/mcp")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": {\n \"type\": \"mcp-server/remote\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tool_settings\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"annotations\": {\n \"readOnlyHint\": true,\n \"destructiveHint\": true\n }\n }\n ],\n \"tool_metadata\": {},\n \"auth_data\": {\n \"type\": \"header\",\n \"headers\": {},\n \"auth_level\": \"global\"\n },\n \"collaborators\": [\n {\n \"subject\": \"<string>\",\n \"role_id\": \"<string>\"\n }\n ],\n \"additional_headers\": {},\n \"forwarded_headers\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"dryRun\": false,\n \"force\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{controlPlaneURL}/api/svc/v1/mcp")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": {\n \"type\": \"mcp-server/remote\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"url\": \"<string>\",\n \"display_name\": \"<string>\",\n \"tool_settings\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": true,\n \"annotations\": {\n \"readOnlyHint\": true,\n \"destructiveHint\": true\n }\n }\n ],\n \"tool_metadata\": {},\n \"auth_data\": {\n \"type\": \"header\",\n \"headers\": {},\n \"auth_level\": \"global\"\n },\n \"collaborators\": [\n {\n \"subject\": \"<string>\",\n \"role_id\": \"<string>\"\n }\n ],\n \"additional_headers\": {},\n \"forwarded_headers\": [\n \"<string>\"\n ],\n \"tags\": {}\n },\n \"dryRun\": false,\n \"force\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"fqn": "my-tenant:mcp-server:filesystem-tools",
"tenantName": "<string>",
"manifest": {
"type": "mcp-server/remote",
"name": "<string>",
"description": "<string>",
"url": "<string>",
"display_name": "<string>",
"tls_settings": {
"reject_unauthorized": true,
"ca_cert": "<string>"
},
"tool_settings": [
{
"name": "<string>",
"description": "<string>",
"disabled": true,
"annotations": {
"readOnlyHint": true,
"destructiveHint": true
}
}
],
"tool_policy": {
"enable_tools_by_default": true,
"disabled_tools": [
"<string>"
],
"enabled_tools": [
"<string>"
]
},
"tool_metadata": {},
"auth_data": {
"type": "header",
"headers": {},
"auth_level": "global"
},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"ownedBy": {
"account": "<string>"
},
"additional_headers": {},
"forwarded_headers": [
"<string>"
],
"tags": {}
},
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>",
"subjectPatName": "<string>",
"subjectControllerName": "<string>",
"subjectExternalIdentitySlug": "<string>"
},
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"proxyUrl": "<string>",
"isAuthOverrideSupported": true,
"authStatus": {
"status": "authenticated",
"method": "oauth",
"expiresAt": "2026-10-01T12:40:00.000Z",
"isRefreshable": true,
"lastUpdatedAt": "2026-10-01T11:40:00.000Z",
"refreshFailureCount": 0,
"refreshFailureMessage": "invalid_grant: refresh token expired"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The MCP server manifest describing the server type, name, auth configuration, and other settings.
- RemoteMCPServerManifest
- VirtualMCPServerManifest
- OpenAPIMCPServerManifest
- StdioMCPServerManifest
- TfyManagedMCPServerManifest
Show child attributes
Show child attributes
When true, validates and resolves the manifest without persisting or syncing to the gateway store.
When true, acknowledges that updating this manifest will delete existing per-subject auth records.
Response
The created or updated MCP server.
The MCP server data.
Show child attributes
Show child attributes
Was this page helpful?