MCP Server Content¶
Upload MCP server content¶
POST /mcp-servers/{mcpServerId}/assets
Code samples
curl -X POST https://localhost:9543/api/v0.9/mcp-servers/{mcpServerId}/assets \
-u {username}:{password} \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d @payload.json
Uploads the static content package for an MCP server. Mirrors POST /api/v0.9/apis/{apiId}/assets.
Payload
content: string
docMetadata: '[{"name":"External
guide","url":"https://example.com/docs/guide","type":"LINK"}]'
imageMetadata: '{"api-icon":"icon.png"}'
Authentication¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | API content ZIP upload. |
| » content | body | string(binary) | true | ZIP upload field named content. |
| » docMetadata | body | string | false | Optional JSON string containing API document link metadata. |
| » imageMetadata | body | string | false | Optional JSON string containing API image metadata. |
| mcpServerId | path | string | true | The MCP server's handle (unique per org). |
Detailed descriptions
body: API content ZIP upload.
Expected ZIP structure:
- web/: optional API landing-page files and images.
- docs/: optional downloadable documents.
At least one of web/ or docs/ must exist at the ZIP root.
docMetadata and imageMetadata are JSON strings because they are submitted as multipart form fields.
Example responses
201 Response
Bad request. Validation and other bad-request errors are returned as a standard error object (field-level details, when present, are carried in its
errorsarray); some legacy handlers return a message-only object.
{
"status": "error",
"code": "MISSING_REQUIRED_PARAMETER",
"message": "Missing required parameter."
}
409 Response
500 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | JSON message response. | MessageResponse |
| 400 | Bad Request | Bad request. Validation and other bad-request errors are returned as a standard error object (field-level details, when present, are carried in its errors array); some legacy handlers return a message-only object. |
Inline |
| 409 | Conflict | The request conflicts with an existing resource. | ErrorResponse |
| 500 | Internal Server Error | Internal server error. | ErrorResponse |
Response Schema
Enumerated Values
| Property | Value |
|---|---|
| status | error |
Replace MCP server content¶
PUT /mcp-servers/{mcpServerId}/assets
Code samples
curl -X PUT https://localhost:9543/api/v0.9/mcp-servers/{mcpServerId}/assets \
-u {username}:{password} \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d @payload.json
Replaces or adds static content files for an existing MCP server. Mirrors PUT /api/v0.9/apis/{apiId}/assets.
Payload
content: string
docMetadata: '[{"name":"External
guide","url":"https://example.com/docs/guide","type":"LINK"}]'
imageMetadata: '{"api-icon":"icon.png"}'
Authentication¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | object | true | API content ZIP upload. |
| » content | body | string(binary) | true | ZIP upload field named content. |
| » docMetadata | body | string | false | Optional JSON string containing API document link metadata. |
| » imageMetadata | body | string | false | Optional JSON string containing API image metadata. |
| mcpServerId | path | string | true | The MCP server's handle (unique per org). |
Detailed descriptions
body: API content ZIP upload.
Expected ZIP structure:
- web/: optional API landing-page files and images.
- docs/: optional downloadable documents.
At least one of web/ or docs/ must exist at the ZIP root.
docMetadata and imageMetadata are JSON strings because they are submitted as multipart form fields.
Example responses
201 Response
Bad request. Validation and other bad-request errors are returned as a standard error object (field-level details, when present, are carried in its
errorsarray); some legacy handlers return a message-only object.
{
"status": "error",
"code": "MISSING_REQUIRED_PARAMETER",
"message": "Missing required parameter."
}
409 Response
500 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | JSON message response. | MessageResponse |
| 400 | Bad Request | Bad request. Validation and other bad-request errors are returned as a standard error object (field-level details, when present, are carried in its errors array); some legacy handlers return a message-only object. |
Inline |
| 409 | Conflict | The request conflicts with an existing resource. | ErrorResponse |
| 500 | Internal Server Error | Internal server error. | ErrorResponse |
Response Schema
Enumerated Values
| Property | Value |
|---|---|
| status | error |
Get an MCP server content file¶
GET /mcp-servers/{mcpServerId}/assets
Code samples
curl -X GET https://localhost:9543/api/v0.9/mcp-servers/{mcpServerId}/assets?type=document&fileName=getting-started.md \
-u {username}:{password} \
-H 'Accept: text/css' \
-H 'Authorization: Bearer {access-token}'
Retrieves a single stored MCP server content file. Mirrors GET /api/v0.9/apis/{apiId}/assets.
Authentication¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| type | query | string | true | Stored API content type selector. Common values are web, document, image, and link, depending on how the uploaded ZIP content was classified. |
| fileName | query | string | true | Stored API content file name to retrieve. |
| mcpServerId | path | string | true | The MCP server's handle (unique per org). |
Example responses
200 Response
Bad request. Validation and other bad-request errors are returned as a standard error object (field-level details, when present, are carried in its
errorsarray); some legacy handlers return a message-only object.
{
"status": "error",
"code": "MISSING_REQUIRED_PARAMETER",
"message": "Missing required parameter."
}
404 Response
500 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Stored API content asset. The concrete media type depends on the stored file extension or whether the content is an external document link. | string |
| 400 | Bad Request | Bad request. Validation and other bad-request errors are returned as a standard error object (field-level details, when present, are carried in its errors array); some legacy handlers return a message-only object. |
Inline |
| 404 | Not Found | Plain text success response. | string |
| 500 | Internal Server Error | Internal server error. | ErrorResponse |
Response Schema
Enumerated Values
| Property | Value |
|---|---|
| status | error |
Delete MCP server content files¶
DELETE /mcp-servers/{mcpServerId}/assets
Code samples
curl -X DELETE https://localhost:9543/api/v0.9/mcp-servers/{mcpServerId}/assets?type=document \
-u {username}:{password} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Deletes stored MCP server content. Mirrors DELETE /api/v0.9/apis/{apiId}/assets.
Authentication¶
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| type | query | string | true | Stored API content type selector. Common values are web, document, image, and link, depending on how the uploaded ZIP content was classified. |
| fileName | query | string | false | File name selector used to delete a single stored API content file. |
| mcpServerId | path | string | true | The MCP server's handle (unique per org). |
Example responses
Bad request. Validation and other bad-request errors are returned as a standard error object (field-level details, when present, are carried in its
errorsarray); some legacy handlers return a message-only object.
{
"status": "error",
"code": "MISSING_REQUIRED_PARAMETER",
"message": "Missing required parameter."
}
404 Response
500 Response
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | MCP server content deleted successfully. | None |
| 400 | Bad Request | Bad request. Validation and other bad-request errors are returned as a standard error object (field-level details, when present, are carried in its errors array); some legacy handlers return a message-only object. |
Inline |
| 404 | Not Found | Plain text success response. | string |
| 500 | Internal Server Error | Internal server error. | ErrorResponse |
Response Schema
Enumerated Values
| Property | Value |
|---|---|
| status | error |