You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Update README with accurate READ-ONLY documentation and new badges
- Add PyPI downloads and GitHub Actions workflow badges
- Correct documentation to reflect READ-ONLY nature of the tool
- Remove misleading CRUD operation references
- Add comprehensive safety explanations and use cases
- Update examples to show only supported read-only operations
HubSpot CRM tool for [Strands Agents SDK](https://github.com/strands-agents/strands). Enables powerful CRM operations for AI agents with read-only access for safety.
9
+
**READ-ONLY**HubSpot CRM tool for [Strands Agents SDK](https://github.com/strands-agents/strands). Enables safe CRM data access for AI agents with **zero risk** of data modification.
8
10
9
11
## Features
10
12
11
-
-**Universal CRM Access**: Works with ANY HubSpot object type
12
-
-**Smart Search**: Advanced filtering with property-based queries
13
-
-**CRUD Operations**: Create, read, update, and delete records
14
-
-**Property Discovery**: Automatic field detection and validation
15
-
-**Association Management**: Link related objects (contacts, deals, companies)
16
-
-**Rich Console Output**: Beautiful table displays with Rich library
17
-
-**Type Safe**: Full type hints and validation
18
-
-**Easy Integration**: Drop-in tool for Strands agents
13
+
- 🔍 **Universal READ-ONLY Access**: Safely search ANY HubSpot object type (contacts, deals, companies, tickets, etc.)
14
+
- 🔎 **Smart Search**: Advanced filtering with property-based queries and sorting
15
+
- 📄 **Object Retrieval**: Get detailed information for specific CRM objects by ID
16
+
- 🏷️ **Property Discovery**: List and explore all available properties for any object type
17
+
- 👤 **User Management**: Get HubSpot user/owner details and assignments
Get your API key at: [app.hubspot.com/private-apps](https://app.hubspot.com/private-apps)
61
67
62
-
## Supported Actions
68
+
## Supported READ-ONLY Actions
69
+
70
+
> ⚠️ **Important**: This tool is designed for READ-ONLY operations only. It **CANNOT** create, update, or delete any HubSpot data, ensuring complete safety for your CRM.
63
71
64
72
### Search (`search`)
65
73
@@ -71,8 +79,8 @@ agent("search for contacts with email containing '@example.com'")
71
79
72
80
- Search any HubSpot object type (contacts, deals, companies, tickets, etc.)
73
81
- Advanced filtering by property values
74
-
- Sorting and pagination
75
-
- Property selection
82
+
- Sorting and pagination support
83
+
- Property selection and customization
76
84
77
85
### Get (`get`)
78
86
@@ -82,45 +90,34 @@ agent("get contact with ID 12345")
82
90
83
91
**Features:**
84
92
85
-
- Retrieve full object details
93
+
- Retrieve full object details by ID
86
94
- Specify which properties to return
87
95
- Works with any object type
96
+
- Comprehensive error handling
88
97
89
-
### Create (`create`)
90
-
91
-
```python
92
-
agent("create a contact with email [email protected] and name John Doe")
93
-
```
94
-
95
-
**Features:**
96
-
97
-
- Create any HubSpot object
98
-
- Set initial properties
99
-
- Handle associations
100
-
101
-
### Update (`update`)
98
+
### List Properties (`list_properties`)
102
99
103
100
```python
104
-
agent("update contact 12345 with lifecycle stage 'customer'")
101
+
agent("show me all available contact properties")
105
102
```
106
103
107
104
**Features:**
108
105
109
-
-Update any property
110
-
-Partial updates supported
111
-
-Property validation
106
+
-Discover available fields for any object type
107
+
-Property metadata and type information
108
+
-Field types and available options
112
109
113
-
### List Properties (`list_properties`)
110
+
### Get Property Details (`get_property`)
114
111
115
112
```python
116
-
agent("show me all available contact properties")
113
+
agent("get details about the 'email' property for contacts")
117
114
```
118
115
119
116
**Features:**
120
117
121
-
-Discover available fields
122
-
- Property metadata
123
-
-Field types and options
118
+
-Detailed property metadata
119
+
- Property type, options, and validation rules
120
+
-Useful for understanding data structure
124
121
125
122
### Get User Details (`get_user_details`)
126
123
@@ -132,6 +129,26 @@ agent("get details for user ID 123")
132
129
133
130
- User profile information
134
131
- Owner assignment data
132
+
- Permission and role details
133
+
134
+
## Why READ-ONLY?
135
+
136
+
🛡️ **Safety First**: This tool is intentionally designed as READ-only to:
137
+
138
+
-**Prevent accidental data loss** or corruption in your HubSpot CRM
139
+
-**Enable safe AI exploration** of your customer data
140
+
-**Allow analytics and reporting** without modification risks
141
+
-**Perfect for research and insights** without affecting production data
142
+
-**Ideal for AI agents** that need CRM access but shouldn't modify records
143
+
144
+
## Use Cases
145
+
146
+
- 📊 **Analytics & Reporting**: Generate insights from CRM data
147
+
- 🔍 **Customer Research**: Search and analyze customer information
148
+
- 📋 **Data Discovery**: Explore available properties and data structure
149
+
- 🤖 **AI-Powered Insights**: Let agents analyze CRM data safely
150
+
- 📈 **Sales Intelligence**: Extract trends and patterns from deals/contacts
151
+
- 🎯 **Lead Analysis**: Research prospects and opportunities
0 commit comments