Skip to content

docs(mcp): point deploy_connector_to_cloud and publish_custom_source_definition at each other #1371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Aaron ("AJ") Steers (aaronsteers) wants to merge 1 commit into from
Closed

docs(mcp): point deploy_connector_to_cloud and publish_custom_source_definition at each other #1371

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions airbyte/mcp/cloud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,8 +603,9 @@ def deploy_connector_to_cloud( # noqa: PLR0913 # Mirrors the API surface.
str,
Field(
description=(
"The canonical name of the connector (e.g., 'source-faker' or "
"'destination-postgres')."
"The canonical registry name of the connector (e.g., 'source-faker' or "
"'destination-postgres'). Not a custom definition name or ID; see "
"`publish_custom_source_definition` for custom connectors."
),
),
TraceArg.FINGERPRINT,
Expand Down Expand Up @@ -661,6 +662,10 @@ def deploy_connector_to_cloud( # noqa: PLR0913 # Mirrors the API surface.
) -> str:
"""Deploy a source or destination connector to Airbyte Cloud.

Only for connectors in the Airbyte registry. For custom (e.g. YAML manifest) source
connectors, use `publish_custom_source_definition`, or `list_custom_source_definitions` and
`update_custom_source_definition` for one that already exists.

With `defer_credentials=True`, returns a JSON `DeferredDeployResult` whose `settings_url`
is where a person completes the credentials.
"""
Expand Down Expand Up @@ -3041,6 +3046,8 @@ def publish_custom_source_definition(
) -> str:
"""Publish a custom YAML source connector definition to Airbyte Cloud.

For connectors already in the Airbyte registry, use `deploy_connector_to_cloud` instead.

Note: Only YAML (declarative) connectors are currently supported.
Docker-based custom sources are not yet available.
"""
Expand Down
Loading