Skip to main content
POST
/
api
/
mcp
/
client
Add a new MCP client
curl --request POST \
  --url http://localhost:8080/api/mcp/client \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "filesystem",
  "connection_type": "stdio",
  "connection_string": "https://api.example.com/mcp",
  "stdio_config": {
    "command": "npx",
    "args": [
      "-y",
      "@modelcontextprotocol/server-filesystem"
    ],
    "envs": [
      "HOME",
      "USER"
    ]
  },
  "tools_to_execute": [
    "read_file",
    "list_directory"
  ]
}
'
{
  "status": "success",
  "message": "MCP client added successfully"
}

Body

application/json
​
name
string
required

Client name

Example:

"filesystem"

​
connection_type
enum<string>
required

Communication protocol for MCP connections

Available options:
http,
stdio,
sse,
inprocess
Example:

"stdio"

​
connection_string
string

HTTP or SSE URL (required for HTTP or SSE connections)

Example:

"https://api.example.com/mcp"

​
stdio_config
object
​
tools_to_execute
string[]

Tools to include from this client (if specified, only these are used)

Example:
["read_file", "list_directory"]

Response

Client added successfully

​
status
string
Example:

"success"

​
message
string
Example:

"MCP client added successfully"