get_document_properties
Retrieve document details including status, metadata, signer information, form fields, and history from your BoldSign organization using the document ID.
Instructions
Retrieve comprehensive details of a document in your BoldSign organization. This API allows authorized users, including senders, signers, team admins, and account admins, to access document properties by specifying the unique document ID. The response includes information such as status, metadata, sender and signer details, form fields, and document history. If an unauthorized user attempts to access the document, an unauthorized response will be returned.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | Required. The unique identifier (ID) of the document to retrieve. This can be obtained from the list documents tool. |
Implementation Reference
- The main handler function that executes the tool logic: initializes BoldSign DocumentApi client, calls getProperties with documentId, and returns the response or handles errors.async function getDocumentPropertiesHandler(payload: GetDocumentPropertiesSchemaType): Promise<McpResponse> { try { const documentApi = new DocumentApi(); documentApi.basePath = configuration.getBasePath(); documentApi.setApiKey(configuration.getApiKey()); const documentProperties: DocumentProperties = await documentApi.getProperties(payload.documentId); return handleMcpResponse({ data: documentProperties, }); } catch (error: any) { return handleMcpError(error); } }
- Zod schema defining the input for the tool: requires a documentId string.const GetDocumentPropertiesSchema = z.object({ documentId: commonSchema.InputIdSchema.describe( 'Required. The unique identifier (ID) of the document to retrieve. This can be obtained from the list documents tool.', ), });
- src/tools/documentsTools/getDocumentProperties.ts:17-26 (registration)Tool definition including name, description, schema, and handler wrapper, exported for registration.export const getDocumentPropertiesToolDefinition: BoldSignTool = { method: ToolNames.GetDocumentProperties.toString(), name: 'Get document properties', description: 'Retrieve comprehensive details of a document in your BoldSign organization. This API allows authorized users, including senders, signers, team admins, and account admins, to access document properties by specifying the unique document ID. The response includes information such as status, metadata, sender and signer details, form fields, and document history. If an unauthorized user attempts to access the document, an unauthorized response will be returned.', inputSchema: GetDocumentPropertiesSchema, async handler(args: unknown): Promise<McpResponse> { return await getDocumentPropertiesHandler(args as GetDocumentPropertiesSchemaType); }, };
- src/tools/documentsTools/index.ts:8-14 (registration)Registration of the tool as part of the documents API tools array, imported from individual tool files.export const documentsApiToolsDefinitions: BoldSignTool[] = [ getDocumentPropertiesToolDefinition, listDocumentsToolDefinition, listTeamDocumentsToolDefinition, sendReminderForDocumentToolDefinition, revokeDocumentToolDefinition, ];
- src/tools/toolNames.ts:48-48 (helper)Enum definition for the tool name used in the method string.GetDocumentProperties = 'get_document_properties',