createAgentMCPServer

POST

/api/v1/agents/{agentId}/mcp-servers

A server only this agent uses (agent admin).

curl --request POST \
  --url '<base-url>/api/v1/agents/<agentId>/mcp-servers' \
  --header 'Content-Type: application/json' \
  --cookie 'agenthold_session=<agenthold_session>' \
  --data '
{
  "name": "string",
  "transport": "stdio",
  "command": "string",
  "args": [
    "string"
  ],
  "env": {
    "property1": "string",
    "property2": "string"
  },
  "url": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  }
}
'

const url = '<base-url>/api/v1/agents/<agentId>/mcp-servers';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    cookie: 'agenthold_session=<agenthold_session>'
  },
  body: JSON.stringify({
    name: 'string',
    transport: 'stdio',
    command: 'string',
    args: ['string'],
    env: {property1: 'string', property2: 'string'},
    url: 'string',
    headers: {property1: 'string', property2: 'string'}
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "<base-url>/api/v1/agents/<agentId>/mcp-servers"

payload = {
    "name": "string",
    "transport": "stdio",
    "command": "string",
    "args": ["string"],
    "env": {
        "property1": "string",
        "property2": "string"
    },
    "url": "string",
    "headers": {
        "property1": "string",
        "property2": "string"
    }
}
headers = {
    "cookie": "agenthold_session=<agenthold_session>",
    "Content-Type": "application/json"
}

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

print(response.text)

Response example

{
  "name": "string",
  "transport": "stdio",
  "command": "string",
  "args": [
    "string"
  ],
  "env": {
    "property1": "string",
    "property2": "string"
  },
  "url": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "id": "string",
  "workspaceId": "string",
  "scope": "workspace",
  "agentId": "string",
  "secretRefs": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Request body JSON required

name
string
required
Letters, digits, dashes and underscores.
transport
stdio
or
http
required
command
optional
string
stdio only; runs inside the sandbox.
args
optional
array of
string
env
optional
map of
string
stdio only. Values may reference secrets as {{secret:NAME}}.
url
optional
string
http only.
headers
optional
map of
string
http only. Values may reference secrets as {{secret:NAME}}; the sandbox sees a placeholder and the egress proxy injects the value.

Returns

201

Created.

JSON

name
string
required
Letters, digits, dashes and underscores.
transport
stdio
or
http
required
command
string
required
stdio only; runs inside the sandbox.
args
array of
string
required
env
map of
string
required
stdio only. Values may reference secrets as {{secret:NAME}}.
url
string
required
http only.
headers
map of
string
required
http only. Values may reference secrets as {{secret:NAME}}; the sandbox sees a placeholder and the egress proxy injects the value.
id
string
required
workspaceId
string
required
scope
workspace
or
agent
required
secretRefs
array of
string
required
createdAt
string
required
format: date-time
updatedAt
string
required
format: date-time
agentId
optional
string

400

Error.

JSON

error
string
required

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required

409

Error.

JSON

error
string
required