airbyte-agent-shopify 0.1.16__py3-none-any.whl → 0.1.17__py3-none-any.whl

airbyte_agent_shopify/__init__.py

@@ -19,8 +19,8 @@ from .models import (
     Refund,
     Order,
     OrderList,
-    ProductVariant,
     ProductImage,
+    ProductVariant,
     Product,
     ProductList,
     ProductVariantList,
@@ -192,8 +192,8 @@ __all__ = [
     "Refund",
     "Order",
     "OrderList",
-    "ProductVariant",
     "ProductImage",
+    "ProductVariant",
     "Product",
     "ProductList",
     "ProductVariantList",

airbyte_agent_shopify/_vendored/connector_sdk/introspection.py

@@ -380,7 +380,11 @@ def describe_entities(model: ConnectorModelProtocol) -> list[dict[str, Any]]:
     return entities
 
 
-def generate_tool_description(model: ConnectorModelProtocol) -> str:
+def generate_tool_description(
+    model: ConnectorModelProtocol,
+    *,
+    enable_hosted_mode_features: bool = True,
+) -> str:
     """Generate AI tool description from connector metadata.
 
     Produces a detailed description that includes:
@@ -393,6 +397,7 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
 
     Args:
         model: Object conforming to ConnectorModelProtocol (e.g., ConnectorModel)
+        enable_hosted_mode_features: When False, omit hosted-mode search guidance from the docstring.
 
     Returns:
         Formatted description string suitable for AI tool documentation
@@ -402,8 +407,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
     # at the first empty line and only keeps the initial section.
 
     # Entity/action parameter details (including pagination params like limit, starting_after)
-    search_field_paths = _collect_search_field_paths(model)
-    lines.append("ENTITIES AND PARAMETERS:")
+    search_field_paths = _collect_search_field_paths(model) if enable_hosted_mode_features else {}
+    # Avoid a "PARAMETERS:" header because some docstring parsers treat it as a params section marker.
+    lines.append("ENTITIES (ACTIONS + PARAMS):")
     for entity in model.entities:
         lines.append(f"  {entity.name}:")
         actions = getattr(entity, "actions", []) or []
@@ -427,8 +433,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
     lines.append("  To paginate: pass starting_after=<last_id> while has_more is true")
 
     lines.append("GUIDELINES:")
-    lines.append('  - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
-    lines.append("  - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
+    if enable_hosted_mode_features:
+        lines.append('  - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
+        lines.append("  - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
     lines.append("  - Keep results small: use params.fields, params.query.filter, small params.limit, and cursor pagination.")
     lines.append("  - If output is too large, refine the query with tighter filters/fields/limit.")
 

airbyte_agent_shopify/connector.py

@@ -908,6 +908,7 @@ class ShopifyConnector:
         func: _F | None = None,
         *,
         update_docstring: bool = True,
+        enable_hosted_mode_features: bool = True,
         max_output_chars: int | None = DEFAULT_MAX_OUTPUT_CHARS,
     ) -> _F | Callable[[_F], _F]:
         """
@@ -926,12 +927,16 @@ class ShopifyConnector:
 
         Args:
             update_docstring: When True, append connector capabilities to __doc__.
+            enable_hosted_mode_features: When False, omit hosted-mode search sections from docstrings.
             max_output_chars: Max serialized output size before raising. Use None to disable.
         """
 
         def decorate(inner: _F) -> _F:
             if update_docstring:
-                description = generate_tool_description(ShopifyConnectorModel)
+                description = generate_tool_description(
+                    ShopifyConnectorModel,
+                    enable_hosted_mode_features=enable_hosted_mode_features,
+                )
                 original_doc = inner.__doc__ or ""
                 if original_doc.strip():
                     full_doc = f"{original_doc.strip()}\n{description}"

airbyte_agent_shopify/models.py

@@ -329,6 +329,22 @@ class OrderList(BaseModel):
 
     orders: Union[list[Order], Any] = Field(default=None)
 
+class ProductImage(BaseModel):
+    """A product image"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[int, Any] = Field(default=None)
+    product_id: Union[int | None, Any] = Field(default=None)
+    position: Union[int | None, Any] = Field(default=None)
+    created_at: Union[str | None, Any] = Field(default=None)
+    updated_at: Union[str | None, Any] = Field(default=None)
+    alt: Union[str | None, Any] = Field(default=None)
+    width: Union[int | None, Any] = Field(default=None)
+    height: Union[int | None, Any] = Field(default=None)
+    src: Union[str | None, Any] = Field(default=None)
+    variant_ids: Union[list[int] | None, Any] = Field(default=None)
+    admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
+
 class ProductVariant(BaseModel):
     """A product variant"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -360,22 +376,6 @@ class ProductVariant(BaseModel):
     requires_shipping: Union[bool | None, Any] = Field(default=None)
     admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
 
-class ProductImage(BaseModel):
-    """A product image"""
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-    id: Union[int, Any] = Field(default=None)
-    product_id: Union[int | None, Any] = Field(default=None)
-    position: Union[int | None, Any] = Field(default=None)
-    created_at: Union[str | None, Any] = Field(default=None)
-    updated_at: Union[str | None, Any] = Field(default=None)
-    alt: Union[str | None, Any] = Field(default=None)
-    width: Union[int | None, Any] = Field(default=None)
-    height: Union[int | None, Any] = Field(default=None)
-    src: Union[str | None, Any] = Field(default=None)
-    variant_ids: Union[list[int] | None, Any] = Field(default=None)
-    admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
-
 class Product(BaseModel):
     """A Shopify product"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)

{airbyte_agent_shopify-0.1.16.dist-info → airbyte_agent_shopify-0.1.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-shopify
-Version: 0.1.16
+Version: 0.1.17
 Summary: Airbyte Shopify Connector for AI platforms
 Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
 Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
@@ -119,10 +119,11 @@ async def shopify_execute(entity: str, action: str, params: dict | None = None):
     return await connector.execute(entity, action, params or {})
 ```
 
-
 ## Full documentation
 
-This connector supports the following entities and actions.
+### Entities and actions
+
+This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
 
 | Entity | Actions |
 |--------|---------|
@@ -160,14 +161,16 @@ This connector supports the following entities and actions.
 | Fulfillment Orders | [List](./REFERENCE.md#fulfillment-orders-list), [Get](./REFERENCE.md#fulfillment-orders-get) |
 
 
-For all authentication options, see the connector's [authentication documentation](AUTH.md).
+### Authentication and configuration
+
+For all authentication and configuration options, see the connector's [authentication documentation](AUTH.md).
 
-For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
+### Shopify API docs
 
-For the service's official API docs, see the [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
+See the official [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
 
 ## Version information
 
-- **Package version:** 0.1.16
+- **Package version:** 0.1.17
 - **Connector version:** 0.1.2
-- **Generated with Connector SDK commit SHA:** 71f48c102ce98c9298e5102761e740f0d97eb71b
+- **Generated with Connector SDK commit SHA:** f6c6fca292b291b200b31e4056856465129ae703

{airbyte_agent_shopify-0.1.16.dist-info → airbyte_agent_shopify-0.1.17.dist-info}/RECORD

@@ -1,7 +1,7 @@
-airbyte_agent_shopify/__init__.py,sha256=uFn4x1bUldfWTPBITTIGYrjD5bRufgEVvKVviDOUd_0,9661
-airbyte_agent_shopify/connector.py,sha256=uDA7DNbgXNQQ94sp2Kinq2Rgu2FgBZEWzbgKTLEteZM,93793
+airbyte_agent_shopify/__init__.py,sha256=oQjq6z4WrcRTVOr6IqajzImVUCyyiPWsfWE4S2auJB8,9661
+airbyte_agent_shopify/connector.py,sha256=fnlv35f3Vg0ktwdeegm7OKldNrI7yJPPg7DC1Y0qkFU,94062
 airbyte_agent_shopify/connector_model.py,sha256=AVa7n--wns14y5tdsiKymVUMS7HboqVD8sdzvKPlBRM,691010
-airbyte_agent_shopify/models.py,sha256=hBMmLBLBlmqU8TdcJGpm3fQyyDVP3BEpDJ5C2cInBso,60917
+airbyte_agent_shopify/models.py,sha256=F5Sx9acQJqDG_p1szZMFvqhxY8ernkH8lQctxcUVckM,60917
 airbyte_agent_shopify/types.py,sha256=AwQ4PR2wZmHNuryriCFdRxf9q48J1mnPwspUB1b-L_o,10221
 airbyte_agent_shopify/_vendored/__init__.py,sha256=ILl7AHXMui__swyrjxrh9yRa4dLiwBvV6axPWFWty80,38
 airbyte_agent_shopify/_vendored/connector_sdk/__init__.py,sha256=T5o7roU6NSpH-lCAGZ338sE5dlh4ZU6i6IkeG1zpems,1949
@@ -12,7 +12,7 @@ airbyte_agent_shopify/_vendored/connector_sdk/constants.py,sha256=AtzOvhDMWbRJgp
 airbyte_agent_shopify/_vendored/connector_sdk/exceptions.py,sha256=ss5MGv9eVPmsbLcLWetuu3sDmvturwfo6Pw3M37Oq5k,481
 airbyte_agent_shopify/_vendored/connector_sdk/extensions.py,sha256=XWRRoJOOrwUHSKbuQt5DU7CCu8ePzhd_HuP7c_uD77w,21376
 airbyte_agent_shopify/_vendored/connector_sdk/http_client.py,sha256=09Fclbq4wrg38EM2Yh2kHiykQVXqdAGby024elcEz8E,28027
-airbyte_agent_shopify/_vendored/connector_sdk/introspection.py,sha256=kRVI4TDQDLdcCnTBUML8ycAtdqAQufVh-027sMkb4i8,19165
+airbyte_agent_shopify/_vendored/connector_sdk/introspection.py,sha256=e9uWn2ofpeehoBbzNgts_bjlKLn8ayA1Y3OpDC3b7ZA,19517
 airbyte_agent_shopify/_vendored/connector_sdk/secrets.py,sha256=J9ezMu4xNnLW11xY5RCre6DHP7YMKZCqwGJfk7ufHAM,6855
 airbyte_agent_shopify/_vendored/connector_sdk/types.py,sha256=in8gHsn5nsScujOfHZmkOgNmqmJKiPyNNjg59m5fGWc,8807
 airbyte_agent_shopify/_vendored/connector_sdk/utils.py,sha256=G4LUXOC2HzPoND2v4tQW68R9uuPX9NQyCjaGxb7Kpl0,1958
@@ -52,6 +52,6 @@ airbyte_agent_shopify/_vendored/connector_sdk/telemetry/__init__.py,sha256=RaLgk
 airbyte_agent_shopify/_vendored/connector_sdk/telemetry/config.py,sha256=tLmQwAFD0kP1WyBGWBS3ysaudN9H3e-3EopKZi6cGKg,885
 airbyte_agent_shopify/_vendored/connector_sdk/telemetry/events.py,sha256=8Y1NbXiwISX-V_wRofY7PqcwEXD0dLMnntKkY6XFU2s,1328
 airbyte_agent_shopify/_vendored/connector_sdk/telemetry/tracker.py,sha256=Ftrk0_ddfM7dZG8hF9xBuPwhbc9D6JZ7Q9qs5o3LEyA,5579
-airbyte_agent_shopify-0.1.16.dist-info/METADATA,sha256=vzGjdAedaMX_-w0h9_jQ-v5AUi21PZgAwyFf1OIAvYI,7842
-airbyte_agent_shopify-0.1.16.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-airbyte_agent_shopify-0.1.16.dist-info/RECORD,,
+airbyte_agent_shopify-0.1.17.dist-info/METADATA,sha256=zInAAvvpl3oA9smRK5KDj5n2nSfWxsJ30tmuBVeWQxE,7868
+airbyte_agent_shopify-0.1.17.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+airbyte_agent_shopify-0.1.17.dist-info/RECORD,,