curl --request POST \
--url 'https://my.orq.ai/v2/mcp-servers/mcp_server_01JQ0K5R8N2ZC7X4M9T3V6HWBD:sync' \
--header "Authorization: Bearer $ORQ_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
{
"mcp_server": {
"id": "<string>",
"key": "<string>",
"display_name": "<string>",
"description": "<string>",
"connection": {
"type": "MCP_CONNECTION_TYPE_HTTP",
"url": "<string>"
},
"auth": {
"type": "MCP_AUTH_TYPE_NONE",
"static_headers": [
{
"key": "<string>",
"masked_value": "<string>"
}
],
"oauth": {
"client_id": "<string>",
"token_url": "<string>",
"scopes": [
"<string>"
],
"masked_value": "<string>",
"issuer": "<string>",
"resource": "<string>"
},
"enterprise": {
"resource": "<string>",
"client_id": "<string>",
"masked_value": "<string>",
"scopes": [
"<string>"
]
}
},
"default_tool_exposure": {
"mode": "MCP_TOOL_EXPOSURE_MODE_ALL",
"read_only": true,
"tool_ids": [
"<string>"
],
"excluded_tool_ids": [
"<string>"
]
},
"sync_state": {
"status": "SYNC_STATUS_SYNCED",
"tools_total": 123,
"tools_added": 123,
"tools_removed": 123,
"last_synced_at": "<string>",
"errors": [
"<string>"
],
"skills_total": 123
},
"tools": [
{
"name": "<string>",
"description": "<string>",
"input_schema": {},
"status": "<string>",
"id": "<string>",
"title": "<string>",
"annotations": {
"read_only": true,
"destructive": true,
"idempotent": true,
"open_world": true,
"title": "<string>"
},
"http_operation": {
"method": "<string>",
"path": "<string>"
},
"icons": [
{
"src": "<string>",
"mime_type": "<string>",
"sizes": [
"<string>"
],
"theme": "<string>"
}
],
"output_schema": {},
"meta": {}
}
],
"created": "<string>",
"updated": "<string>",
"sharing": {
"all_projects": {},
"selected": {
"project_ids": [
"<string>"
]
},
"allow_version_pin": true,
"allow_fork": true,
"auto_grant_new_projects": true
},
"template_variables": [
"<string>"
],
"created_by_id": "<string>",
"skills": [
{
"uri": "<string>",
"name": "<string>",
"description": "<string>",
"frontmatter": {},
"files": [
{
"uri": "<string>",
"digest": "<string>",
"size": "<string>"
}
],
"dynamic": true
}
],
"openapi": {
"document_url": "<string>",
"operations": [
"<string>"
],
"title": "<string>",
"version": "<string>"
},
"icons": [
{
"src": "<string>",
"mime_type": "<string>",
"sizes": [
"<string>"
],
"theme": "<string>"
}
],
"website_url": "<string>",
"capabilities": {
"tools": true,
"resources": true,
"prompts": true,
"completions": true
},
"resource_catalog": {
"resources": [
{
"uri": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"mime_type": "<string>",
"size": "<string>",
"annotations": {
"audience": [
"<string>"
],
"last_modified": "<string>",
"priority": 123
},
"icons": [
{
"src": "<string>",
"mime_type": "<string>",
"sizes": [
"<string>"
],
"theme": "<string>"
}
],
"meta": {},
"selection_id": "<string>"
}
],
"resource_templates": [
{
"uri_template": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"mime_type": "<string>",
"annotations": {
"audience": [
"<string>"
],
"last_modified": "<string>",
"priority": 123
},
"icons": [
{
"src": "<string>",
"mime_type": "<string>",
"sizes": [
"<string>"
],
"theme": "<string>"
}
],
"meta": {},
"selection_id": "<string>"
}
],
"resources_status": "MCP_DISCOVERY_STATUS_SYNCED",
"resource_templates_status": "MCP_DISCOVERY_STATUS_SYNCED"
},
"prompt_catalog": {
"prompts": [
{
"name": "<string>",
"title": "<string>",
"description": "<string>",
"arguments": [
{
"name": "<string>",
"description": "<string>",
"required": true
}
],
"icons": [
{
"src": "<string>",
"mime_type": "<string>",
"sizes": [
"<string>"
],
"theme": "<string>"
}
],
"meta": {},
"selection_id": "<string>"
}
],
"status": "MCP_DISCOVERY_STATUS_SYNCED"
},
"health": {
"status": "MCP_HEALTH_STATUS_HEALTHY",
"coverage": "MCP_HEALTH_COVERAGE_FULL",
"last_checked_at": "<string>",
"last_healthy_at": "<string>",
"latency_ms": 123,
"consecutive_failures": 123,
"error_message": "<string>",
"recent_checks": [
{
"checked_at": "<string>",
"ok": true,
"latency_ms": 123
}
]
},
"health_check": {
"enabled": true,
"interval": "<string>",
"min_interval": "<string>",
"default_interval": "<string>",
"notifier_ids": [
"<string>"
],
"recovery_period": "<string>"
}
}
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}MCP Servers
Sync an MCP server
Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller. A discovery failure that comes from the upstream server, such as a refused connection or rejected credentials, does not fail the request: the call answers 200 with sync_state.status SYNC_STATUS_FAILED and the reason in sync_state.errors, and the server’s tools stay out of every gateway until a sync succeeds.
POST
/
v2
/
mcp-servers
/
{id}
:sync
curl --request POST \
--url 'https://my.orq.ai/v2/mcp-servers/mcp_server_01JQ0K5R8N2ZC7X4M9T3V6HWBD:sync' \
--header "Authorization: Bearer $ORQ_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
{
"mcp_server": {
"id": "<string>",
"key": "<string>",
"display_name": "<string>",
"description": "<string>",
"connection": {
"type": "MCP_CONNECTION_TYPE_HTTP",
"url": "<string>"
},
"auth": {
"type": "MCP_AUTH_TYPE_NONE",
"static_headers": [
{
"key": "<string>",
"masked_value": "<string>"
}
],
"oauth": {
"client_id": "<string>",
"token_url": "<string>",
"scopes": [
"<string>"
],
"masked_value": "<string>",
"issuer": "<string>",
"resource": "<string>"
},
"enterprise": {
"resource": "<string>",
"client_id": "<string>",
"masked_value": "<string>",
"scopes": [
"<string>"
]
}
},
"default_tool_exposure": {
"mode": "MCP_TOOL_EXPOSURE_MODE_ALL",
"read_only": true,
"tool_ids": [
"<string>"
],
"excluded_tool_ids": [
"<string>"
]
},
"sync_state": {
"status": "SYNC_STATUS_SYNCED",
"tools_total": 123,
"tools_added": 123,
"tools_removed": 123,
"last_synced_at": "<string>",
"errors": [
"<string>"
],
"skills_total": 123
},
"tools": [
{
"name": "<string>",
"description": "<string>",
"input_schema": {},
"status": "<string>",
"id": "<string>",
"title": "<string>",
"annotations": {
"read_only": true,
"destructive": true,
"idempotent": true,
"open_world": true,
"title": "<string>"
},
"http_operation": {
"method": "<string>",
"path": "<string>"
},
"icons": [
{
"src": "<string>",
"mime_type": "<string>",
"sizes": [
"<string>"
],
"theme": "<string>"
}
],
"output_schema": {},
"meta": {}
}
],
"created": "<string>",
"updated": "<string>",
"sharing": {
"all_projects": {},
"selected": {
"project_ids": [
"<string>"
]
},
"allow_version_pin": true,
"allow_fork": true,
"auto_grant_new_projects": true
},
"template_variables": [
"<string>"
],
"created_by_id": "<string>",
"skills": [
{
"uri": "<string>",
"name": "<string>",
"description": "<string>",
"frontmatter": {},
"files": [
{
"uri": "<string>",
"digest": "<string>",
"size": "<string>"
}
],
"dynamic": true
}
],
"openapi": {
"document_url": "<string>",
"operations": [
"<string>"
],
"title": "<string>",
"version": "<string>"
},
"icons": [
{
"src": "<string>",
"mime_type": "<string>",
"sizes": [
"<string>"
],
"theme": "<string>"
}
],
"website_url": "<string>",
"capabilities": {
"tools": true,
"resources": true,
"prompts": true,
"completions": true
},
"resource_catalog": {
"resources": [
{
"uri": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"mime_type": "<string>",
"size": "<string>",
"annotations": {
"audience": [
"<string>"
],
"last_modified": "<string>",
"priority": 123
},
"icons": [
{
"src": "<string>",
"mime_type": "<string>",
"sizes": [
"<string>"
],
"theme": "<string>"
}
],
"meta": {},
"selection_id": "<string>"
}
],
"resource_templates": [
{
"uri_template": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"mime_type": "<string>",
"annotations": {
"audience": [
"<string>"
],
"last_modified": "<string>",
"priority": 123
},
"icons": [
{
"src": "<string>",
"mime_type": "<string>",
"sizes": [
"<string>"
],
"theme": "<string>"
}
],
"meta": {},
"selection_id": "<string>"
}
],
"resources_status": "MCP_DISCOVERY_STATUS_SYNCED",
"resource_templates_status": "MCP_DISCOVERY_STATUS_SYNCED"
},
"prompt_catalog": {
"prompts": [
{
"name": "<string>",
"title": "<string>",
"description": "<string>",
"arguments": [
{
"name": "<string>",
"description": "<string>",
"required": true
}
],
"icons": [
{
"src": "<string>",
"mime_type": "<string>",
"sizes": [
"<string>"
],
"theme": "<string>"
}
],
"meta": {},
"selection_id": "<string>"
}
],
"status": "MCP_DISCOVERY_STATUS_SYNCED"
},
"health": {
"status": "MCP_HEALTH_STATUS_HEALTHY",
"coverage": "MCP_HEALTH_COVERAGE_FULL",
"last_checked_at": "<string>",
"last_healthy_at": "<string>",
"latency_ms": 123,
"consecutive_failures": 123,
"error_message": "<string>",
"recent_checks": [
{
"checked_at": "<string>",
"ok": true,
"latency_ms": 123
}
]
},
"health_check": {
"enabled": true,
"interval": "<string>",
"min_interval": "<string>",
"default_interval": "<string>",
"notifier_ids": [
"<string>"
],
"recovery_period": "<string>"
}
}
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}Related guide: MCP gateways guide. See the MCP gateways guide for a walkthrough with examples.
Authorizations
Body
application/json
Was this page helpful?