Mcp Server
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
GET | |
PATCH | |
POST | |
GET | |
POST | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST |
List all environments mcp server installations
Required API key scopes
project:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:environment_id /mcp_server_installationsExample response
Status 200
RESPONSE
Create environments mcp server installations
Required API key scopes
project:writeRequest parameters
- display_namestring
- urlstring
- descriptionstring
- auth_type
- is_enabledboolean
Response
Example request
POST /api /environments /:environment_id /mcp_server_installationsExample response
Status 201
RESPONSE
Retrieve environments mcp server installations
Required API key scopes
project:readPath parameters
- idstring
Response
Example request
GET /api /environments /:environment_id /mcp_server_installations /:idExample response
Status 200
RESPONSE
Update environments mcp server installations
Required API key scopes
project:readPath parameters
- idstring
Request parameters
- display_namestring
- descriptionstring
- is_enabledboolean
Response
Example request
PATCH /api /environments /:environment_id /mcp_server_installations /:idExample response
Status 200
RESPONSE
Delete environments mcp server installations
Required API key scopes
project:readPath parameters
- idstring
Example request
DELETE /api /environments /:environment_id /mcp_server_installations /:idExample response
Status 204 No response body
Create environments mcp server installations proxy
Required API key scopes
project:readPath parameters
- idstring
Request parameters
- display_namestring
- urlstring
- descriptionstring
- auth_type
- is_enabledboolean
Example request
POST /api /environments /:environment_id /mcp_server_installations /:id /proxyExample response
Status 200
Retrieve environments mcp server installations tools
Required API key scopes
project:readPath parameters
- idstring
Response
Example request
GET /api /environments /:environment_id /mcp_server_installations /:id /toolsExample response
Status 200
RESPONSE
Update environments mcp server installations tools
Required API key scopes
project:readPath parameters
- idstring
- tool_namestring
Request parameters
- approval_state
Response
Example request
PATCH /api /environments /:environment_id /mcp_server_installations /:id /tools /:tool_nameExample response
Status 200
RESPONSE
Create environments mcp server installations tools refresh
Required API key scopes
project:readPath parameters
- idstring
Request parameters
- display_namestring
- urlstring
- descriptionstring
- auth_type
- is_enabledboolean
Response
Example request
POST /api /environments /:environment_id /mcp_server_installations /:id /tools /refreshExample response
Status 200
RESPONSE
Retrieve environments mcp server installations authorize
Start (or re-start) an OAuth flow.
Pass template_id to (re)connect a catalog template, or
installation_id to reconnect an existing custom install using its
cached metadata and per-user DCR creds.
Required API key scopes
project:readQuery parameters
- install_sourcestringDefault:
posthogOne of:"posthog""posthog-code" - installation_idstring
- posthog_code_callback_urlstringDefault:
- template_idstring
Example request
GET /api /environments /:environment_id /mcp_server_installations /authorizeExample response
Status 200 No response body
Create environments mcp server installations install custom
Required API key scopes
project:readRequest parameters
- namestring
- urlstring
- auth_type
- api_keystringDefault:
- descriptionstringDefault:
- client_idstringDefault:
- client_secretstringDefault:
- install_sourceDefault:
posthog - posthog_code_callback_urlstringDefault:
Response
Example request
POST /api /environments /:environment_id /mcp_server_installations /install_customExample response
Status 200
RESPONSE
Status 201
RESPONSE
Create environments mcp server installations install template
Required API key scopes
project:readRequest parameters
- template_idstring
- api_keystringDefault:
- install_sourceDefault:
posthog - posthog_code_callback_urlstringDefault:
Response
Example request
POST /api /environments /:environment_id /mcp_server_installations /install_templateExample response
Status 200
RESPONSE
Status 201
RESPONSE
List all mcp server installations
Required API key scopes
project:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /mcp_server_installationsExample response
Status 200
RESPONSE
Create mcp server installations
Required API key scopes
project:writeRequest parameters
- display_namestring
- urlstring
- descriptionstring
- auth_type
- is_enabledboolean
Response
Example request
POST /api /projects /:project_id /mcp_server_installationsExample response
Status 201
RESPONSE
Retrieve mcp server installations
Required API key scopes
project:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /mcp_server_installations /:idExample response
Status 200
RESPONSE
Update mcp server installations
Required API key scopes
project:readPath parameters
- idstring
Request parameters
- display_namestring
- descriptionstring
- is_enabledboolean
Response
Example request
PATCH /api /projects /:project_id /mcp_server_installations /:idExample response
Status 200
RESPONSE
Delete mcp server installations
Required API key scopes
project:readPath parameters
- idstring
Example request
DELETE /api /projects /:project_id /mcp_server_installations /:idExample response
Status 204 No response body
Create mcp server installations proxy
Required API key scopes
project:readPath parameters
- idstring
Request parameters
- display_namestring
- urlstring
- descriptionstring
- auth_type
- is_enabledboolean
Example request
POST /api /projects /:project_id /mcp_server_installations /:id /proxy