updateConnection
Modify a data source connection to change sources, update redirect URLs, or select different documents for ingestion in SourceSync.ai's knowledge management platform.
Instructions
Updates a connection to a specific source. The connector parameter should be a valid SourceSync connector enum value. The clientRedirectUrl parameter is optional and can be used to specify a custom redirect URL for the connection. This will give you a authorization url which you can redirect the user to. The user will then be asked to pick the documents they want to ingest. This is useful if you want to update the connection to a different source or if you want to update the clientRedirectUrl or if you want to pick a different or new set of documents.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| namespaceId | No | ||
| connectionId | Yes | ||
| name | No | ||
| clientRedirectUrl | No | ||
| tenantId | No |
Implementation Reference
- src/index.ts:699-713 (handler)MCP tool handler function for 'updateConnection': extracts parameters, creates SourceSyncApiClient instance, and invokes its updateConnection method wrapped in safeApiCall.async (params) => { return safeApiCall(async () => { const { namespaceId, tenantId, connectionId, name, clientRedirectUrl } = params // Create a client with the provided API key const client = createClient({ namespaceId, tenantId }) return await client.updateConnection({ connectionId, name, clientRedirectUrl, }) }) },
- src/index.ts:695-714 (registration)Registration of the 'updateConnection' MCP tool using server.tool(), including name, description, input schema, and handler function.server.tool( 'updateConnection', 'Updates a connection to a specific source. The connector parameter should be a valid SourceSync connector enum value. The clientRedirectUrl parameter is optional and can be used to specify a custom redirect URL for the connection. This will give you a authorization url which you can redirect the user to. The user will then be asked to pick the documents they want to ingest. This is useful if you want to update the connection to a different source or if you want to update the clientRedirectUrl or if you want to pick a different or new set of documents.', UpdateConnectionSchema.shape, async (params) => { return safeApiCall(async () => { const { namespaceId, tenantId, connectionId, name, clientRedirectUrl } = params // Create a client with the provided API key const client = createClient({ namespaceId, tenantId }) return await client.updateConnection({ connectionId, name, clientRedirectUrl, }) }) }, )
- src/schemas.ts:487-493 (schema)Zod schema (UpdateConnectionSchema) for input validation of the updateConnection tool parameters.export const UpdateConnectionSchema = z.object({ namespaceId: namespaceIdSchema.optional(), connectionId: z.string(), name: z.string().optional(), clientRedirectUrl: z.string().optional(), tenantId: tenantIdSchema, })
- src/sourcesync.ts:286-302 (helper)Core helper method in SourceSyncApiClient that performs the HTTP PATCH request to the SourceSync API endpoint /v1/connections/{connectionId} to update the connection details.public async updateConnection({ connectionId, name, clientRedirectUrl, }: Omit<SourceSyncUpdateConnectionRequest, 'namespaceId'> & { connectionId: string }): Promise<SourceSyncUpdateConnectionResponse> { return this.client .url(`/v1/connections/${connectionId}`) .json({ namespaceId: this.namespaceId, name, clientRedirectUrl, } satisfies SourceSyncUpdateConnectionRequest) .patch() .json<SourceSyncUpdateConnectionResponse>() }