airbyte-agent-zendesk-support 0.18.68__py3-none-any.whl → 0.18.69__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -380,7 +380,11 @@ def describe_entities(model: ConnectorModelProtocol) -> list[dict[str, Any]]:
380
380
  return entities
381
381
 
382
382
 
383
- def generate_tool_description(model: ConnectorModelProtocol) -> str:
383
+ def generate_tool_description(
384
+ model: ConnectorModelProtocol,
385
+ *,
386
+ enable_hosted_mode_features: bool = True,
387
+ ) -> str:
384
388
  """Generate AI tool description from connector metadata.
385
389
 
386
390
  Produces a detailed description that includes:
@@ -393,6 +397,7 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
393
397
 
394
398
  Args:
395
399
  model: Object conforming to ConnectorModelProtocol (e.g., ConnectorModel)
400
+ enable_hosted_mode_features: When False, omit hosted-mode search guidance from the docstring.
396
401
 
397
402
  Returns:
398
403
  Formatted description string suitable for AI tool documentation
@@ -402,8 +407,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
402
407
  # at the first empty line and only keeps the initial section.
403
408
 
404
409
  # Entity/action parameter details (including pagination params like limit, starting_after)
405
- search_field_paths = _collect_search_field_paths(model)
406
- lines.append("ENTITIES AND PARAMETERS:")
410
+ search_field_paths = _collect_search_field_paths(model) if enable_hosted_mode_features else {}
411
+ # Avoid a "PARAMETERS:" header because some docstring parsers treat it as a params section marker.
412
+ lines.append("ENTITIES (ACTIONS + PARAMS):")
407
413
  for entity in model.entities:
408
414
  lines.append(f" {entity.name}:")
409
415
  actions = getattr(entity, "actions", []) or []
@@ -427,8 +433,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
427
433
  lines.append(" To paginate: pass starting_after=<last_id> while has_more is true")
428
434
 
429
435
  lines.append("GUIDELINES:")
430
- lines.append(' - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
431
- lines.append(" - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
436
+ if enable_hosted_mode_features:
437
+ lines.append(' - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
438
+ lines.append(" - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
432
439
  lines.append(" - Keep results small: use params.fields, params.query.filter, small params.limit, and cursor pagination.")
433
440
  lines.append(" - If output is too large, refine the query with tighter filters/fields/limit.")
434
441
 
@@ -817,6 +817,7 @@ class ZendeskSupportConnector:
817
817
  func: _F | None = None,
818
818
  *,
819
819
  update_docstring: bool = True,
820
+ enable_hosted_mode_features: bool = True,
820
821
  max_output_chars: int | None = DEFAULT_MAX_OUTPUT_CHARS,
821
822
  ) -> _F | Callable[[_F], _F]:
822
823
  """
@@ -835,12 +836,16 @@ class ZendeskSupportConnector:
835
836
 
836
837
  Args:
837
838
  update_docstring: When True, append connector capabilities to __doc__.
839
+ enable_hosted_mode_features: When False, omit hosted-mode search sections from docstrings.
838
840
  max_output_chars: Max serialized output size before raising. Use None to disable.
839
841
  """
840
842
 
841
843
  def decorate(inner: _F) -> _F:
842
844
  if update_docstring:
843
- description = generate_tool_description(ZendeskSupportConnectorModel)
845
+ description = generate_tool_description(
846
+ ZendeskSupportConnectorModel,
847
+ enable_hosted_mode_features=enable_hosted_mode_features,
848
+ )
844
849
  original_doc = inner.__doc__ or ""
845
850
  if original_doc.strip():
846
851
  full_doc = f"{original_doc.strip()}\n{description}"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: airbyte-agent-zendesk-support
3
- Version: 0.18.68
3
+ Version: 0.18.69
4
4
  Summary: Airbyte Zendesk-Support Connector for AI platforms
5
5
  Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
6
6
  Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
@@ -115,10 +115,11 @@ async def zendesk-support_execute(entity: str, action: str, params: dict | None
115
115
  return await connector.execute(entity, action, params or {})
116
116
  ```
117
117
 
118
-
119
118
  ## Full documentation
120
119
 
121
- This connector supports the following entities and actions.
120
+ ### Entities and actions
121
+
122
+ This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
122
123
 
123
124
  | Entity | Actions |
124
125
  |--------|---------|
@@ -146,14 +147,16 @@ This connector supports the following entities and actions.
146
147
  | Article Attachments | [List](./REFERENCE.md#article-attachments-list), [Get](./REFERENCE.md#article-attachments-get), [Download](./REFERENCE.md#article-attachments-download) |
147
148
 
148
149
 
149
- For all authentication options, see the connector's [authentication documentation](AUTH.md).
150
+ ### Authentication and configuration
151
+
152
+ For all authentication and configuration options, see the connector's [authentication documentation](AUTH.md).
150
153
 
151
- For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
154
+ ### Zendesk-Support API docs
152
155
 
153
- For the service's official API docs, see the [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
156
+ See the official [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
154
157
 
155
158
  ## Version information
156
159
 
157
- - **Package version:** 0.18.68
160
+ - **Package version:** 0.18.69
158
161
  - **Connector version:** 0.1.9
159
- - **Generated with Connector SDK commit SHA:** 71f48c102ce98c9298e5102761e740f0d97eb71b
162
+ - **Generated with Connector SDK commit SHA:** f6c6fca292b291b200b31e4056856465129ae703
@@ -1,5 +1,5 @@
1
1
  airbyte_agent_zendesk_support/__init__.py,sha256=RRAGu8AUU7OjMyGJvktoZvll1v7qxgw25mzqjBdODy4,9451
2
- airbyte_agent_zendesk_support/connector.py,sha256=rJyvogiWMjTF24BEdflNy467H7xzN3xzY97Uh0h0vhA,112326
2
+ airbyte_agent_zendesk_support/connector.py,sha256=SUHbKrQDtPMKninrNViyZPo2ilrFbefQCFPJBu4CDjE,112595
3
3
  airbyte_agent_zendesk_support/connector_model.py,sha256=XfzcAOuvFimu2t_502eRWeymlCd3z6Ts6oA4xr_WVos,248665
4
4
  airbyte_agent_zendesk_support/models.py,sha256=mUZBBOkxmXJWHc-AGTJheWfDQ_I7RiJSddyXp4Di8tI,63349
5
5
  airbyte_agent_zendesk_support/types.py,sha256=ZNi-YzBv9K0Tmkm5xfEomuWyG59VG4zxTsxh9q9zcHw,162971
@@ -12,7 +12,7 @@ airbyte_agent_zendesk_support/_vendored/connector_sdk/constants.py,sha256=AtzOvh
12
12
  airbyte_agent_zendesk_support/_vendored/connector_sdk/exceptions.py,sha256=ss5MGv9eVPmsbLcLWetuu3sDmvturwfo6Pw3M37Oq5k,481
13
13
  airbyte_agent_zendesk_support/_vendored/connector_sdk/extensions.py,sha256=XWRRoJOOrwUHSKbuQt5DU7CCu8ePzhd_HuP7c_uD77w,21376
14
14
  airbyte_agent_zendesk_support/_vendored/connector_sdk/http_client.py,sha256=09Fclbq4wrg38EM2Yh2kHiykQVXqdAGby024elcEz8E,28027
15
- airbyte_agent_zendesk_support/_vendored/connector_sdk/introspection.py,sha256=kRVI4TDQDLdcCnTBUML8ycAtdqAQufVh-027sMkb4i8,19165
15
+ airbyte_agent_zendesk_support/_vendored/connector_sdk/introspection.py,sha256=e9uWn2ofpeehoBbzNgts_bjlKLn8ayA1Y3OpDC3b7ZA,19517
16
16
  airbyte_agent_zendesk_support/_vendored/connector_sdk/secrets.py,sha256=J9ezMu4xNnLW11xY5RCre6DHP7YMKZCqwGJfk7ufHAM,6855
17
17
  airbyte_agent_zendesk_support/_vendored/connector_sdk/types.py,sha256=in8gHsn5nsScujOfHZmkOgNmqmJKiPyNNjg59m5fGWc,8807
18
18
  airbyte_agent_zendesk_support/_vendored/connector_sdk/utils.py,sha256=G4LUXOC2HzPoND2v4tQW68R9uuPX9NQyCjaGxb7Kpl0,1958
@@ -52,6 +52,6 @@ airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/__init__.py,sha2
52
52
  airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/config.py,sha256=tLmQwAFD0kP1WyBGWBS3ysaudN9H3e-3EopKZi6cGKg,885
53
53
  airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/events.py,sha256=8Y1NbXiwISX-V_wRofY7PqcwEXD0dLMnntKkY6XFU2s,1328
54
54
  airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/tracker.py,sha256=Ftrk0_ddfM7dZG8hF9xBuPwhbc9D6JZ7Q9qs5o3LEyA,5579
55
- airbyte_agent_zendesk_support-0.18.68.dist-info/METADATA,sha256=HUpiu9q3ZFUETYplURi8QgWv4hU_9QTXoKCTC0mA_6Q,7259
56
- airbyte_agent_zendesk_support-0.18.68.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
57
- airbyte_agent_zendesk_support-0.18.68.dist-info/RECORD,,
55
+ airbyte_agent_zendesk_support-0.18.69.dist-info/METADATA,sha256=Yf7VXfCebYPeuVQ5twugdvozWT1uCiG1dfWBAp97MEY,7293
56
+ airbyte_agent_zendesk_support-0.18.69.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
57
+ airbyte_agent_zendesk_support-0.18.69.dist-info/RECORD,,