Skip to content

Create an MCP server

POST
/api/workspaces/{workspaceId}/mcp-servers
curl --request POST \
--url http://localhost:8080/api/workspaces/example/mcp-servers \
--header 'Content-Type: application/json' \
--cookie auth_session=<auth_session> \
--data '{ "name": "example", "description": "example", "connectorType": "example", "url": "https://example.com", "authType": "none", "writeScope": "read" }'
workspaceId
required
string
Media typeapplication/json
object
name
required
string
>= 1 characters <= 100 characters
description
string
<= 500 characters
connectorType
required
string
>= 1 characters <= 50 characters
url
string format: uri
authType
string
Allowed values: none api_key oauth
writeScope
string
Allowed values: read write_safe write_destructive

Successful response

Media typeapplication/json
object
success

Whether the request succeeded.

boolean
data

Endpoint-specific response payload.

message
string
error
string

Example

{
"message": "Operation completed",
"error": "Error message"
}

Invalid request

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}

Internal server error

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}