connector-update
Create or update connectors for REST, SOAP, and SAP RFC integrations in the Simplifier platform. Configure endpoints, SSL settings, and project assignments to establish or modify system connections.
Instructions
Create or update a Connector
This tool allows to
create new connectors
modify existing connectors
Attention: When updating a Connector, allways fetch the existing resource first to ensure operating on the latest version. Existing tags and endpoints have to be resent when doing an update - otherwise they would be cleared.
Connector Types
Common settings
For all connectors using SSL / TLS, the sslSettings option has two fields:
trustType: An integer, with the following meaning:
0: Always trust any certificate, regardless of CA signing1: Only trust the certificate specified explicitly2: Use system certificates for trust3: Combination of 1+2, trust explicitly specified certificate and any system trusted certificate.
ignoreSSLCertificates: boolean, if set to true, any TLS validation will be skipped and the target will always be trusted, even when the certificate does not match the hostname.
When no SSL is required, or no specific settings apply, use the following sslSettings:
{
"trustType": 2,
"ignoreSSLCertificates": false
}Connector type 'REST'
The object under endpointConfiguration / configuration defines properties, specific to REST Connector:
endpointURL - the actual address of the remote REST endpoint
sslSettings - SSL related options.
Complete Example:
{
"name": "TestCreate",
"description": "",
"connectorType": "REST",
"active": true,
"timeoutTime": 60,
"endpointConfiguration": {
"endpoint": "Default",
"certificates": [],
"configuration": {
"endpointURL": "http://example-api.com/bla",
"sslSettings": {
"trustType": 2,
"ignoreSSLCertificates": false
}
}
},
"tags": [],
"assignedProjects": {
"projectsAfterChange": []
}
}Connector type 'SOAP'
The object under endpointConfiguration / configuration defines properties, specific to SOAP Connector:
wsdlUrl - the address of a WSDL specification, which is used for the connector
sslSettings - SSL related options.
Complete Example:
{
"name": "TestCreate",
"description": "",
"connectorType": "SOAP",
"active": true,
"timeoutTime": 60,
"endpointConfiguration": {
"endpoint": "Default",
"certificates": [],
"configuration": {
"wsdlUrl": "http://example-soap.com/myService?wsdl",
"sslSettings": {
"trustType": 2,
"ignoreSSLCertificates": false
}
}
},
"tags": [],
"assignedProjects": {
"projectsAfterChange": []
}
}Connector type 'SAP RFC'
The object under endpointConfiguration / configuration defines the following properties specific to SAP RFC connectors, all of them are mandatory:
sapSystem - ID of the target SAP system as a string.
parallelExecutions - Boolean. If true, batch calls (i.e. multiple function modules are executed in one call) are executed in parallel.
connectionPool - object with settings related to connection pooling:
peakLimit - number, maximum number of active connections at a time.
poolCapacity - number of pooled connections.
expirationTime - time in milliseconds for which connections are kept in the pool before being closed.
expirationCheckPeriod - time in milliseconds between checks for expired pooled connections.
maxGetClientTime - maximum time in milliseconds to wait for getting a connection (i.e. connection timeout).
Complete example:
{
"name": "MyRfc",
"description": "",
"connectorType": "SAPRFC",
"active": true,
"timeoutTime": 60,
"endpointConfiguration": {
"endpoint": "Default",
"certificates": [],
"configuration": {
"sapSystem": "ID4_0_800",
"parallelExecutions": false,
"connectionPool": {
"peakLimit": 0,
"poolCapacity": 1,
"expirationTime": 60000,
"expirationCheckPeriod": 60000,
"maxGetClientTime": 30000
}
}
},
"tags": [],
"assignedProjects": {
"projectsAfterChange": []
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| description | No | ||
| connectorType | Yes | ||
| active | No | ||
| timeoutTime | No | maximum duration of a call in seconds | |
| endpointConfiguration | No | On creating a new connector, an endpoint configuration is mandatory. On updating a Connector: * endpoint configuration may be omitted if it is not intended to change. * a new endpoint configuration can be added by using a new endpoint name. * one endpoint configuration can be changed by using the name property of an existing configuration. | |
| tags | No | ||
| projectsBefore | No | Project names before the change. Use empty array [] when creating new Connectors, or provide current projects when updating. | |
| projectsAfterChange | No | Project names to assign the Connector to. Required for tracking project assignments. |
Implementation Reference
- src/tools/connector-tools.ts:98-126 (handler)The handler function that implements the core logic of the 'connector-update' tool. It determines if the connector exists, constructs the data payload, and invokes either createConnector or updateConnector on the SimplifierClient.
async ( {name, description, connectorType, active, timeoutTime, endpointConfiguration, tags, projectsBefore, projectsAfterChange}) => { return wrapToolResult( `create or update Connector ${name}`, async () => { const trackingKey = trackingToolPrefix + toolNameConnectorUpdate let oExisting: any; try { oExisting = await simplifier.getConnector(name, trackingKey) } catch {} const oConnectorData = { name: name, description: description, connectorType: connectorType, active: active, timeoutTime: timeoutTime, endpointConfiguration: endpointConfiguration, tags: tags, assignedProjects: { projectsBefore: projectsBefore, projectsAfterChange: projectsAfterChange } } as SimplifierConnectorUpdate if (oExisting?.name) { return simplifier.updateConnector(oConnectorData); } else { if (!oConnectorData.endpointConfiguration) { throw new Error('endpointConfiguration is required on creating a new connector!'); } return simplifier.createConnector(oConnectorData) } }) }); - src/tools/connector-tools.ts:56-89 (schema)Zod schema defining the input parameters and validation for the 'connector-update' tool, including connector details, endpoint configuration, tags, and project assignments.
inputSchema: { name: z.string(), description: z.string().optional().default(""), connectorType: z.string(), active: z.boolean().optional().default(true), timeoutTime: z.number().optional().default(60) .describe(`maximum duration of a call in seconds`), endpointConfiguration: z.object({ endpoint: z.string() .describe(`The name of an existing instance, defined at the Simplifier server landscape. **Use the name of the active instance, provided by simplifier://server-active-instance when creating a connector endpoint for the server, you are currently working on.** HINT: In error messages, endpoint names are often eclosed in brackets [] or quotes for readability. **When using endpoint name from error message, strip off brackets and quotes** `), certificates: z.array(z.string()), configuration: z.any().optional() .describe(`The properties, defined by this object are specific to the chosen connectorType`), loginMethodName: z.string().optional() .describe(`The name of an existing login method, available on the Simplifier server`), }).optional() .describe( `On creating a new connector, an endpoint configuration is mandatory. On updating a Connector: * endpoint configuration may be omitted if it is not intended to change. * a new endpoint configuration can be added by using a new endpoint name. * one endpoint configuration can be changed by using the name property of an existing configuration. `), tags: z.array(z.string()).optional().default([]), projectsBefore: z.array(z.string()).optional().default([]) .describe('Project names before the change. Use empty array [] when creating new Connectors, or provide current projects when updating.'), projectsAfterChange: z.array(z.string()).optional().default([]) .describe('Project names to assign the Connector to. Required for tracking project assignments.') }, - src/tools/connector-tools.ts:53-126 (registration)The server.registerTool call that registers the 'connector-update' tool with its description, input schema, annotations, and handler function.
server.registerTool(toolNameConnectorUpdate, { description: toolDescriptionConnectorUpdate, inputSchema: { name: z.string(), description: z.string().optional().default(""), connectorType: z.string(), active: z.boolean().optional().default(true), timeoutTime: z.number().optional().default(60) .describe(`maximum duration of a call in seconds`), endpointConfiguration: z.object({ endpoint: z.string() .describe(`The name of an existing instance, defined at the Simplifier server landscape. **Use the name of the active instance, provided by simplifier://server-active-instance when creating a connector endpoint for the server, you are currently working on.** HINT: In error messages, endpoint names are often eclosed in brackets [] or quotes for readability. **When using endpoint name from error message, strip off brackets and quotes** `), certificates: z.array(z.string()), configuration: z.any().optional() .describe(`The properties, defined by this object are specific to the chosen connectorType`), loginMethodName: z.string().optional() .describe(`The name of an existing login method, available on the Simplifier server`), }).optional() .describe( `On creating a new connector, an endpoint configuration is mandatory. On updating a Connector: * endpoint configuration may be omitted if it is not intended to change. * a new endpoint configuration can be added by using a new endpoint name. * one endpoint configuration can be changed by using the name property of an existing configuration. `), tags: z.array(z.string()).optional().default([]), projectsBefore: z.array(z.string()).optional().default([]) .describe('Project names before the change. Use empty array [] when creating new Connectors, or provide current projects when updating.'), projectsAfterChange: z.array(z.string()).optional().default([]) .describe('Project names to assign the Connector to. Required for tracking project assignments.') }, annotations: { title: "Create or update a Connector", readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: true }, }, async ( {name, description, connectorType, active, timeoutTime, endpointConfiguration, tags, projectsBefore, projectsAfterChange}) => { return wrapToolResult( `create or update Connector ${name}`, async () => { const trackingKey = trackingToolPrefix + toolNameConnectorUpdate let oExisting: any; try { oExisting = await simplifier.getConnector(name, trackingKey) } catch {} const oConnectorData = { name: name, description: description, connectorType: connectorType, active: active, timeoutTime: timeoutTime, endpointConfiguration: endpointConfiguration, tags: tags, assignedProjects: { projectsBefore: projectsBefore, projectsAfterChange: projectsAfterChange } } as SimplifierConnectorUpdate if (oExisting?.name) { return simplifier.updateConnector(oConnectorData); } else { if (!oConnectorData.endpointConfiguration) { throw new Error('endpointConfiguration is required on creating a new connector!'); } return simplifier.createConnector(oConnectorData) } }) }); - src/tools/index.ts:16-16 (registration)Top-level registration call in tools index that invokes connectorTools registration, which includes the 'connector-update' tool.
registerConnectorTools(server, simplifier) - src/client/types.ts:275-287 (schema)TypeScript interface defining the structure for connector update/create payload used in the handler.
export interface SimplifierConnectorUpdate { name: string; description: string; connectorType: string; endpointConfiguration?: DetailedEndpoint | undefined; active: boolean; timeoutTime: number; tags: string[]; assignedProjects: { projectsBefore: string[]; projectsAfterChange: string[]; }; }