Skip to content

docs(mcp): clarify that get_agent_skill_docs is for a deployed connector's direct-access docs #1389

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

Merged
Aaron ("AJ") Steers (aaronsteers) merged 1 commit into from
Oct 16, 2026
Merged

docs(mcp): clarify that get_agent_skill_docs is for a deployed connector's direct-access docs #1389

Show file tree
Hide file tree
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
10 changes: 5 additions & 5 deletions airbyte/mcp/cloud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@ def _manifest_yaml_source_hint() -> str | None:
SKILL_DOCS_SECTION_HINT = """\
Skill doc sections for direct API queries and actions are named with the pattern
`actions.<entity_type>.<action>`, matching the `entity_type` and `action` arguments of the
`execute_external_api_query` tool. Call `get_agent_skill_docs` with no `section` input to list all
available sections, and/or retrieve the relevant section(s) with `get_agent_skill_docs` before
calling an action. E.g. for GitHub `entity_type='issues'`, `action='list'`, the
`'actions.issues.list'` section will teach that its expected `api_args` keys are `owner`,
`repo`, `states`, etc.\
`execute_external_api_query` tool. Call `get_agent_skill_docs` with the deployed `connector_id`
(or a `docs_skill_id`) and no `section` to get the overview and list of available sections, then
retrieve the relevant section(s) before calling an action. E.g. for GitHub `entity_type='issues'`,
`action='list'`, the `'actions.issues.list'` section will teach that its expected
`api_args` keys are `owner`, `repo`, `states`, etc.\
"""
CONNECTOR_CHECK_FAILURE_FALLBACK = "Connector check failed without a failure message."
DEFER_CREDENTIALS_TIP_TEXT = (
Expand Down
16 changes: 12 additions & 4 deletions airbyte/mcp/guidance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,8 @@ def get_agent_skill_docs(
str | None,
Field(
description=(
"Deployed source or destination ID; resolves that connector's skill docs. "
"ID of a source or destination deployed in the workspace (not a connector "
"definition ID); resolves that connector's skill docs. "
"Provide this or `docs_skill_id`."
),
default=None,
Expand All @@ -219,10 +220,17 @@ def get_agent_skill_docs(
TraceArg.OMIT,
],
) -> AgentSkillDocsResult:
"""Returns the requested skill document by ID for an AI agent.
"""Read a deployed connector's direct-access docs (agent skill docs).

Pass either a fully-qualified `docs_skill_id` or a `connector_id` (source or
destination); exactly one is required.
These docs describe the entity types, actions, and arguments that
`execute_external_api_query` accepts for one deployed source or SQL passthrough
destination. They are not general Airbyte guidance; for questions about Airbyte
itself (setting up connections, sync modes, connector setup), use
`search_airbyte_knowledge_sources` instead.

Exactly one of `connector_id` or `docs_skill_id` is required. `connector_id` must be
the ID of a source or destination deployed in the workspace (for example from
`list_cloud_connectors`), not a connector definition ID from the registry.
"""
workspace: CloudWorkspace = _get_cloud_workspace(ctx, workspace_id)
return render_agent_skill_docs_result(
Expand Down
Loading