MCP Server
Manage MCP Servers
Retrieves MCP servers based on the provided query.
- : Needed to read AI agents.
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
A standard query parameter is used to search for specific values.
The number of documents to be retrieved per page.
The page number to be retrieved. The size of the pages should be specified by the pageSize parameter.
List of properties used to sort the results, separated by colons.
Fields to be returned in the response.
Fields to be expanded in the response. It means that instead of the object IDs, the whole objects are returned in the response.
Flag indicating whether the total number of retrieved results should be returned.
List of MCP servers.
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
GET /ai-service/{tenant}/agentic/mcp-servers HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "mcp-custom",
"name": "Custom MCP Server",
"type": "custom",
"enabled": true,
"transport": "streamable_http",
"config": {
"url": "http://localhost:7900/mcp",
"authorizationHeaderName": "Authorization",
"authorizationHeaderToken": {
"id": "token-id"
}
}
},
{
"id": "mcp-dynamic",
"name": "Dynamic MCP Server",
"type": "dynamic",
"enabled": true,
"transport": "streamable_http",
"tools": [
{
"name": "get_order",
"description": "Retrieves an order by ID.",
"prompt": "Use this tool when the user asks for order details.",
"enabled": true,
"config": {
"requiredScopes": [
"order.order_read"
],
"inputSchema": "{\"type\":\"object\",\"properties\":{\"orderId\":{\"type\":\"string\"}},\"required\":[\"orderId\"]}",
"invocation": {
"functionId": "fn-get-order",
"method": "GET",
"argsLocation": "query"
}
}
}
]
}
]Searches for MCP servers based on the provided query.
- : Needed to read AI agents.
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
The number of documents to be retrieved per page.
The page number to be retrieved. The size of the pages should be specified by the pageSize parameter.
List of properties used to sort the results, separated by colons.
Fields to be returned in the response.
Fields to be expanded in the response. It means that instead of the object IDs, the whole objects are returned in the response.
Flag indicating whether the total number of retrieved results should be returned.
A standard query parameter is used to search for specific values.
List of MCP servers.
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
POST /ai-service/{tenant}/agentic/mcp-servers/search HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"q": "name:~Complaint"
}[
{
"id": "mcp-custom",
"name": "Custom MCP Server",
"type": "custom",
"enabled": true,
"transport": "streamable_http",
"config": {
"url": "http://localhost:7900/mcp",
"authorizationHeaderName": "Authorization",
"authorizationHeaderToken": {
"id": "token-id"
}
}
},
{
"id": "mcp-dynamic",
"name": "Dynamic MCP Server",
"type": "dynamic",
"enabled": true,
"transport": "streamable_http",
"tools": [
{
"name": "get_order",
"description": "Retrieves an order by ID.",
"prompt": "Use this tool when the user asks for order details.",
"enabled": true,
"config": {
"requiredScopes": [
"order.order_read"
],
"inputSchema": "{\"type\":\"object\",\"properties\":{\"orderId\":{\"type\":\"string\"}},\"required\":[\"orderId\"]}",
"invocation": {
"functionId": "fn-get-order",
"method": "GET",
"argsLocation": "query"
}
}
}
]
}
]Retrieves the MCP server by a given ID.
- : Needed to read AI agents.
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
Fields to be returned in the response.
Fields to be expanded in the response. It means that instead of the object IDs, the whole objects are returned in the response.
A single mcp server.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
Example response
GET /ai-service/{tenant}/agentic/mcp-servers/{mcpServerId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "mcp-custom",
"name": "Custom MCP Server",
"type": "custom",
"enabled": true,
"transport": "streamable_http",
"config": {
"url": "http://localhost:7900/mcp",
"authorizationHeaderName": "Authorization",
"authorizationHeaderToken": {
"id": "token-id"
}
}
}Updates or creates a specified MCP server by replacing all of its existing data with data from the request body. If the metadata.version is provided, then optimistic locking is enabled and version must match the version in the database.
Important: If MCP server is being used by an enabled agent then disabling MCP is not possible without force flag set to true. Only then the agent and MCP server are disabled.
The type: dynamic value and its tools definitions are in preview. When upserting an enabled dynamic MCP server, each tool's config.invocation.functionId is validated against the Automation service. The request returns 400 when a referenced function does not exist on the tenant.
Hosting of cloud functions and use of dynamic MCP servers is not included in standard billing plans and is billed separately on a pay-as-you-go basis. If you're interested in getting access to these features, contact the Sales Team.
- : Needed to manage AI agents.
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
Allows you to disable a given entity even if it is used as a dependency in other entries. In that case, cascade disable is performed.
falseID of created MCP server.
The resource has been successfully updated.
No content
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
Example response
There are three possible reasons:
- Resource with given code already exists, please choose unique code for your resource
- Optimistic locking failed. If user sends metadata/version attribute which is outdated (someone else updated resource in the time user was performing his changes). User should retrieve the latest product data and retry the request.
- Optimistic locking failed. User did not provide metadata/version attribute in update request, but someone else updated product while it was internally handled by product service. Resending the same request can result in successful update, but the update can override recently persisted changes.
PUT /ai-service/{tenant}/agentic/mcp-servers/{mcpServerId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 221
{
"name": "Custom MCP Server",
"type": "custom",
"transport": "streamable_http",
"enabled": true,
"config": {
"url": "http://localhost:7900/mcp",
"authorizationHeaderName": "Authorization",
"authorizationHeaderToken": {
"id": "token-id"
}
}
}No content
Deletes MCP server by given ID.
Important: If MCP server is being used by an agent then delete operation is not possible without force flag set to true.
- : Needed to manage AI agents.
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
Allows you to remove a given entity even if it is used as a dependency in other entries. In that case, the removed entity is unassigned from other entries.
falseGiven mcp server has been deleted.
No content
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
Example response
DELETE /ai-service/{tenant}/agentic/mcp-servers/{mcpServerId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Partially updates a single mcp server document with given information. Single update may contain multiple partial updates in the form of an array. It contains the allowed operations list:
add(adding an item to the items list)remove(removing an item from the items list)replace(replacing an item with given ID with new definition)
Important: If an MCP server is being used by an enabled agent then disabling MCP is not possible without force flag set to true. Only then the agent and MCP server are disabled.
- : Needed to manage AI agents.
Your Emporix tenant name.
Note: The tenant name should always be provided in lowercase.
Allows you to remove a given entity even if it is used as a dependency in other entries. In that case, the removed entity is unassigned from other entries.
falsePartial update operation list.
/nameValue of the string type.
Any part of the details object.
No Content
No content
The request was syntactically incorrect.
The authorization token is invalid or has expired.
Authorization scopes of the access token are not sufficient and do not match the scopes required by the endpoint.
Example response
PATCH /ai-service/{tenant}/agentic/mcp-servers/{mcpServerId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65
[
{
"op": "REPLACE",
"path": "/name",
"value": "New Custom MCP Server"
}
]No content
Last updated
Was this helpful?