Discover HubSpot schema
discover_hubspot_schemaFull Description
Discovers HubSpot data types, pipelines, and stages.
<capabilities>
- Searches across all HubSpot data types available to the current user
- Returns type names that can be used as input to other tools
- Shows read/write access status for each type based on the current user's permissions
- Returns pipelines and their stages (including open/closed status) for a data type
</capabilities>
<usage_guidance>
- Use this tool FIRST when you need to identify which data types exist before querying data
- Use SEARCH_OBJECT_TYPES when you don't know the exact type name
- Use GET_OBJECT_TYPES when you already know the type names (e.g. CONTACT, DEAL), or with an empty typeNameFilter list to retrieve all available types
- Use GET_PIPELINES to list the pipelines and stages for a type (e.g. deal or ticket stages)
- GET_PIPELINES stage metadata:
probability(DEAL only) is the likelihood (0-1) the deal closes successfully.state(all other types) is OPEN or CLOSED, except for LEAD where the values are NEW, IN_PROGRESS, QUALIFIED, or UNQUALIFIED — QUALIFIED and UNQUALIFIED are the closed/terminal states, NEW and IN_PROGRESS are open - Check readAccess/writeAccess before attempting operations on a type
</usage_guidance>
<examples> <example> <user_input>How many support requests did we get last month?</user_input> <tool_call>{"query": {"_queryType": "SEARCH_OBJECT_TYPES", "searchTerms": "support requests tickets"}}</tool_call> </example>
<example> <user_input>How many products do we have?</user_input> <thoughts>"products" is ambiguous — it may be HubSpot's standard Products object or a custom object like p12345_product_models, and semantic search tends to rank the standard one first, so I won't just take the top hit. I'll review all candidates and, if more than one plausibly matches, ask the user to clarify before querying.</thoughts> <tool_call>{"query": {"_queryType": "SEARCH_OBJECT_TYPES", "searchTerms": "products"}}</tool_call> </example>
<example> <user_input>What fields are on contacts and deals?</user_input> <tool_call>{"query": {"_queryType": "GET_OBJECT_TYPES", "typeNameFilter": ["CONTACT", "DEAL"]}}</tool_call> </example>
<example> <user_input>What types of data does HubSpot have?</user_input> <tool_call>{"query": {"_queryType": "GET_OBJECT_TYPES"}}</tool_call> </example>
<example> <user_input>What are the deal pipeline stages?</user_input> <tool_call>{"query": {"_queryType": "GET_PIPELINES", "objectType": "DEAL"}}</tool_call> </example> </examples>
Parameters (1 required)
queryobjectThe schema query to run. Choose SEARCH_OBJECT_TYPES to discover types by natural language, or GET_OBJECT_TYPES to fetch known type names directly (or all types when typeNameFilter is empty).