hubspot-get-property
Retrieve detailed metadata for a specific HubSpot object property, including its type, options, and configuration details.
Instructions
🎯 Purpose:
1. This tool retrieves detailed information about a specific property for a HubSpot object type.
2. You can use this to get all metadata related to a property, including its type, options,
and other configuration details.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| objectType | Yes | The type of HubSpot object the property belongs to. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType. | |
| propertyName | Yes | The name of the property to retrieve |
Implementation Reference
- The main handler function that fetches property details from the HubSpot CRM API endpoint /crm/v3/properties/{objectType}/{propertyName} and returns the JSON response or error.async process(args) { try { const response = await this.client.get(`/crm/v3/properties/${args.objectType}/${args.propertyName}`); return { content: [ { type: 'text', text: JSON.stringify(response, null, 2), }, ], }; } catch (error) { return { content: [ { type: 'text', text: `Error retrieving HubSpot property ${args.propertyName} for ${args.objectType}: ${error instanceof Error ? error.message : String(error)}`, }, ], isError: true, }; } }
- Zod schema defining the input parameters: objectType (string) and propertyName (string) with descriptions.const GetPropertySchema = z.object({ objectType: z .string() .describe(`The type of HubSpot object the property belongs to. Valid values include: ${HUBSPOT_OBJECT_TYPES.join(', ')}. For custom objects, use the hubspot-get-schemas tool to get the objectType.`), propertyName: z.string().describe('The name of the property to retrieve'), });
- dist/tools/toolsRegistry.js:37-37 (registration)Registers an instance of the GetPropertyTool in the tools registry.registerTool(new GetPropertyTool());
- dist/tools/toolsRegistry.js:14-14 (registration)Imports the GetPropertyTool class for registration.import { GetPropertyTool } from './properties/getPropertyTool.js';
- Tool definition object including name, description, input schema (converted to JSON schema), and annotations for MCP compliance.const ToolDefinition = { name: 'hubspot-get-property', description: ` 🎯 Purpose: 1. This tool retrieves detailed information about a specific property for a HubSpot object type. 2. You can use this to get all metadata related to a property, including its type, options, and other configuration details. `, inputSchema: zodToJsonSchema(GetPropertySchema), annotations: { title: 'Get CRM Property Details', readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true, }, };