send_reminder_for_document_sign
Send reminder emails to signers for pending document signatures, allowing users to specify recipients and include custom messages to prompt completion of outstanding signature requests.
Instructions
Send reminder emails to signers for pending document signatures. This API allows users to remind signers about outstanding signature requests by specifying the document ID and recipient email addresses. Multiple signers can receive reminders at once, and custom messages can be included. If sending reminders on behalf of another sender, specify the relevant sender email addresses.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | Required. The unique identifier (ID) of the document to send a reminder email to signers for pending signatures. | |
| receiverEmails | No | Optional. One or more signer email addresses to send reminders for pending signatures. If multiple signers are required to sign the document, specify their email addresses. If there is not emails provided, it will send reminder to all pending signers. The signers of a document can be obtained from the document-properties tool, using the documentId. | |
| message | No | Optional. Message to be sent in the reminder email. If not provided, the system will use a default reminder message. | |
| onBehalfOf | No | Optional. Email address of the sender when creating a document on their behalf. This email can be retrieved from the `behalfOf` property in the get document or list documents tool. |
Implementation Reference
- The core handler function that implements the tool logic by calling the BoldSign DocumentApi.remindDocument method to send reminders to specified signers for a document.async function sendReminderForDocumentSignHandler( payload: SendReminderForDocumentSignSchemaType, ): Promise<McpResponse> { try { const documentApi = new DocumentApi(); documentApi.basePath = configuration.getBasePath(); documentApi.setApiKey(configuration.getApiKey()); const reminderMessage: ReminderMessage = new ReminderMessage(); reminderMessage.message = payload.message ?? undefined; reminderMessage.onBehalfOf = payload.onBehalfOf ?? undefined; const documentResponse: returnTypeI = await documentApi.remindDocument( payload.documentId, payload.receiverEmails ?? undefined, reminderMessage, ); return handleMcpResponse({ data: documentResponse?.response?.data ?? documentResponse, }); } catch (error: any) { return handleMcpError(error); } }
- Zod schema defining the input parameters: documentId (required), receiverEmails (optional array), message (optional), onBehalfOf (optional).const SendReminderForDocumentSignSchema = z.object({ documentId: commonSchema.InputIdSchema.describe( 'Required. The unique identifier (ID) of the document to send a reminder email to signers for pending signatures.', ), receiverEmails: z .array(commonSchema.EmailSchema.describe('Email address of the signer.')) .optional() .nullable() .describe( 'Optional. One or more signer email addresses to send reminders for pending signatures. If multiple signers are required to sign the document, specify their email addresses. If there is not emails provided, it will send reminder to all pending signers. The signers of a document can be obtained from the document-properties tool, using the documentId.', ), message: commonSchema.OptionalStringSchema.describe( 'Optional. Message to be sent in the reminder email. If not provided, the system will use a default reminder message.', ), onBehalfOf: commonSchema.EmailSchema.optional() .nullable() .describe( 'Optional. Email address of the sender when creating a document on their behalf. This email can be retrieved from the `behalfOf` property in the get document or list documents tool.', ), });
- MCP tool definition object including the tool name 'send_reminder_for_document_sign', description, input schema, and a wrapper handler that delegates to the core handler.export const sendReminderForDocumentToolDefinition: BoldSignTool = { method: ToolNames.SendReminderForDocumentSign.toString(), name: 'Send reminder for document sign', description: 'Send reminder emails to signers for pending document signatures. This API allows users to remind signers about outstanding signature requests by specifying the document ID and recipient email addresses. Multiple signers can receive reminders at once, and custom messages can be included. If sending reminders on behalf of another sender, specify the relevant sender email addresses.', inputSchema: SendReminderForDocumentSignSchema, async handler(args: unknown): Promise<McpResponse> { return await sendReminderForDocumentSignHandler(args as SendReminderForDocumentSignSchemaType); }, };
- src/tools/documentsTools/index.ts:8-14 (registration)Registers the sendReminderForDocumentToolDefinition as part of the documents API tools array for collective export and likely higher-level registration.export const documentsApiToolsDefinitions: BoldSignTool[] = [ getDocumentPropertiesToolDefinition, listDocumentsToolDefinition, listTeamDocumentsToolDefinition, sendReminderForDocumentToolDefinition, revokeDocumentToolDefinition, ];
- src/tools/toolNames.ts:68-68 (registration)Defines the canonical tool name string in the ToolNames enum.SendReminderForDocumentSign = 'send_reminder_for_document_sign',