1
0
mirror of synced 2025-12-19 18:14:56 -05:00

37 Commits

Author SHA1 Message Date
octavia-bot[bot]
14d4ce4f4f docs: sync agent connector docs from airbyte-agent-connectors repo (#70976)
Co-authored-by: ian-at-airbyte <187576150+ian-at-airbyte@users.noreply.github.com>
2025-12-18 11:14:19 -08:00
octavia-bot[bot]
0b81771b92 docs: sync agent connector docs from airbyte-agent-connectors repo (#70973)
Co-authored-by: ian-at-airbyte <187576150+ian-at-airbyte@users.noreply.github.com>
2025-12-17 10:14:06 -08:00
devin-ai-integration[bot]
8e0d5c9dda docs(ai-agents): remove &nbsp; from Python SDK tutorial title (#70962)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
2025-12-16 23:57:41 +00:00
devin-ai-integration[bot]
196c7ca920 docs: fix 'try the tutorial' link on AI agents page (#70961)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
2025-12-16 15:55:00 -08:00
octavia-bot[bot]
499a92d065 docs: sync agent connector docs from airbyte-agent-connectors repo (#70933)
Co-authored-by: ian-at-airbyte <187576150+ian-at-airbyte@users.noreply.github.com>
2025-12-16 02:44:31 +00:00
devin-ai-integration[bot]
baae39e359 docs(ai-agents): Update package names and Python version requirements (#70931)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
2025-12-16 02:11:05 +00:00
octavia-bot[bot]
7c3d297243 docs: sync agent connector docs from airbyte-agent-connectors repo (#70928)
Co-authored-by: ian-at-airbyte <187576150+ian-at-airbyte@users.noreply.github.com>
2025-12-15 18:02:43 -08:00
devin-ai-integration[bot]
b2afd6e91e docs: update terminology - Platform and AI agents (#70910)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
Co-authored-by: octavia-bot[bot] <108746235+octavia-bot[bot]@users.noreply.github.com>
2025-12-13 22:26:24 +00:00
Ian Alton
e57ab8cb0c docs(ai-agents): Add AI connector tutorials and Agent engine positioning (#70461)
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Alexandre Girard <alexandre@airbyte.io>
2025-12-12 16:24:55 -08:00
devin-ai-integration[bot]
cdd58ead27 docs(ai-agents): Move Sonar API docs from embedded-api to ai-agents instance (#70235)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
Co-authored-by: letiescanciano <leticia.escanciano@gmail.com>
2025-12-05 09:34:56 -08:00
Johnny Schmidt
2313c76a01 Remove documentation for deprecated remote MCP server (#70239) 2025-11-26 17:43:58 -08:00
Aaron ("AJ") Steers
d8682c8a5d docs: Remove deprecated PyAirbyte Fast-Coder MCP and deprioritize embedded/sonar links (#69743)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2025-11-19 08:44:45 -08:00
Aaron ("AJ") Steers
bece287f6d docs: Link to PyAirbyte MCP docs instead of duplicating content (#69186)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2025-11-04 16:41:28 -08:00
Ian Alton
9989bf208f docs: fix a Docusaurus warning (#68586) 2025-10-21 17:18:48 -07:00
Teo
98880b167a Fix widget token request URL in quickstart guide (#68210) 2025-10-21 09:59:21 -04:00
Aaron ("AJ") Steers
3b879abd1f docs: Reorganize MCP server documentation (#68205)
## What

Reorganizes the MCP (Model Context Protocol) server documentation to
clearly distinguish between multiple Airbyte MCP servers and makes all
MCP documentation discoverable through the sidebar.

Requested by AJ Steers (@aaronsteers) in [this Devin
session](https://app.devin.ai/sessions/7f61ccb7731f4009b19076fa2b5df36d).

**Problem**: The existing MCP documentation only covered one remote MCP
server (the Heroku-hosted "fast-coder" server), but there are actually
four MCP servers:
1. The new PyAirbyte MCP (local STDIO server) - the recommended option
2. The PyAirbyte Fast-Coder MCP (remote Heroku server) - for rapid code
generation
3. The Connector Builder MCP (in development)
4. The Embedded Operator MCP (existed but wasn't in the sidebar)

## How

- **Renamed** `docs/ai-agents/pyairbyte-mcp/` →
`docs/ai-agents/pyairbyte-fast-coder-mcp/` (the old remote server)
- **Created** new `docs/ai-agents/pyairbyte-mcp/README.md` with
documentation for the new local STDIO MCP server (copied from the
docstring in `airbyte/mcp/__init__.py` in the PyAirbyte repo)
- **Created** `docs/ai-agents/connector-builder-mcp/README.md` as a
stub/"coming soon" page
- **Updated** `docusaurus/sidebar-ai-agents.js` to:
  - Group all four MCP servers under a "MCP Servers" category
  - Add the previously hidden Embedded Operator MCP to the sidebar
- **Updated** `docs/ai-agents/README.md` to describe all four MCP
servers with clear distinctions
- **Fixed** typo: "embedded source" → "embedded search" in the
Fast-Coder MCP docs

## Review guide

1. **`docs/ai-agents/README.md`** - Verify the high-level descriptions
of each MCP server are clear and accurate
2. **`docs/ai-agents/pyairbyte-mcp/README.md`** - Review the setup
instructions for the new PyAirbyte MCP (local server). This content was
copied from the PyAirbyte repo docstring - please verify it's complete
and correct.
3. **`docs/ai-agents/pyairbyte-fast-coder-mcp/README.md`** - Verify the
renamed "Fast-Coder" MCP docs are still accurate
4. **`docusaurus/sidebar-ai-agents.js`** - Check that the sidebar
structure makes sense with all four MCP servers grouped together
5. **`docs/ai-agents/connector-builder-mcp/README.md`** - Confirm the
stub page is appropriate for the in-development server

**Key distinction to verify**: The new "PyAirbyte MCP" (local,
recommended) vs "PyAirbyte Fast-Coder MCP" (remote, for code generation)
are clearly differentiated in the docs.

## User Impact

**Positive:**
- Users can now discover all available Airbyte MCP servers in one place
- The new PyAirbyte MCP (local STDIO server) is documented and
positioned as the recommended option
- The Embedded Operator MCP is now visible in the documentation sidebar
- Clear guidance on which MCP server to use for different use cases

**Potential confusion:**
- Having two PyAirbyte-related MCP servers might initially confuse
users, but the docs clearly explain the differences

## Can this PR be safely reverted and rolled back?

- [x] YES 💚

This is purely documentation changes with no code or infrastructure
changes. Rolling back would just restore the previous documentation
structure.

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-10-21 03:30:24 +00:00
Teal Larson
481e6013b4 fix url in embedded quickstart (#68145)
## What
i messed up the api urls in the original docs. these are correct.
2025-10-16 15:49:00 -04:00
Teal Larson
b50994c6f3 docs: Add comprehensive Sonar Embedded API documentation (#67580)
## Overview

This PR addresses critical documentation drift between the Sonar
implementation and the Airbyte documentation repository. Based on a
comprehensive drift analysis performed on 2025-10-08, this update adds
missing API documentation for HIGH PRIORITY features that are fully
implemented in Sonar but completely undocumented.

Reference: docs-drift-analysis-2025-10-08.md (in sonar repo)

## Changes Summary

### New Documentation Files (3)

1. **workspaces.md** - Workspace Management API
   - List workspaces with cursor-based pagination
   - Get, update, and delete workspaces
   - Workspace statistics and sync operations
   - Complete pagination guide and filtering examples

2. **authentication.md** - Complete Authentication Guide
   - All three token types (Operator Bearer, Scoped, Widget)
   - Region selection (US/EU)
   - Template filtering via tags during token generation
   - Token lifecycle management and security best practices
   - 20+ code examples

3. **tags.md** - Template Tag Management
   - Tag CRUD operations
   - Tag selection modes (ANY vs ALL)
   - Tagging source and connection templates
   - Tier-based access control examples

### Updated Documentation Files (3)

4. **source-templates.md** - Enhanced with stream management, PATCH
endpoint, tag operations, source definition catalogs

5. **connection-templates.md** - Added sync_on_create,
non_breaking_changes_preference, cron validation, PATCH endpoint, tag
operations

6. **configuring-sources.md** - Added region selection, stream
management, JMESPath querying, JSON Patch operations

## Impact

- 25+ previously undocumented API endpoints now documented
- ~2,500 lines of documentation added
- 100+ code examples
- 12 HIGH PRIORITY documentation gaps addressed

## Validation

All documentation validated against:
- Sonar codebase at commit 350a75fe73
- FastAPI route definitions
- Pydantic schemas
- Existing documentation style

## Breaking Changes

None - Documentation only

---------

Co-authored-by: Alexandre Girard <alexandre@airbyte.io>
2025-10-13 12:41:54 -07:00
Teal Larson
b5d18c1c74 embedded quick start and rearranging a few things (#67613)
## What

Based on some customer feedback that our setup guides were a bit
difficult to follow and they just wanted a one page step-by-step.

- Adds a straight shooting one-page guide for folks embedding us into an
existing application
- Moves existing getting started guides that showcased demo applications
into a "Tutorials" area

This does depend on https://github.com/airbytehq/sonar/pull/1049 being
merged, which moves the Applications Token endpoint to the public Sonar
API (another request from that customer!)
2025-10-13 09:21:35 -04:00
Johnny Schmidt
26df4c1634 Docs for Airbyte Operator MCP (#67001)
Co-authored-by: Aaron ("AJ") Steers <aj@airbyte.io>
2025-10-02 08:32:42 -07:00
Ian Alton
93fb9f4567 Docs for new orgs and workspaces redesign aka Org Landing Page (#66550)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-25 13:52:43 -07:00
Teo
c49cbba5e8 Update configuring-sources.md (#66660) 2025-09-24 09:50:48 -07:00
Teo
664233f9df Update README.md (#66659) 2025-09-24 09:49:29 -07:00
Teo
929e5655d2 Create template-tags.md (#66493)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-24 09:48:23 -07:00
Teo
eeab207f98 Update connection-templates.md (#66658)
updating docs when approved.
2025-09-23 21:59:28 -07:00
Teo
27b4c66116 Update use-embedded.md (#66492) 2025-09-18 10:48:27 -04:00
Teo
270aa3ab19 Update develop-your-app.md (#66239) 2025-09-17 19:50:03 -07:00
Teo
88fb10f350 Update README.md (#65968) 2025-09-05 16:47:47 -07:00
Teo
ab5ec1d934 Update README.md (#65570) 2025-09-03 14:43:36 -07:00
Teo
983802c2d5 Update managing-embedded.md (#65892) 2025-09-03 16:47:09 +00:00
Teo
b91ae8f144 Update connection-templates.md (#65615) 2025-08-29 11:51:06 -07:00
Teo
17a3920650 Update managing-embedded.md (#65573) 2025-08-27 11:24:44 -07:00
Teo
8fc022ac49 Update connection-templates.md (#65549)
Co-authored-by: Teal Larson <teal@airbyte.io>
2025-08-27 16:52:05 +00:00
Teo
3258faf35e Update configuring-sources.md (#65551)
Updating!
2025-08-27 09:46:31 -07:00
Alexandre Girard
fee1e7a48d Update embedded docs (#65566)
Co-authored-by: Claude <noreply@anthropic.com>
2025-08-27 00:33:30 +00:00
Teo
a50a1a27eb Update source-templates.md (#65550) 2025-08-26 14:52:26 -07:00
Teo
f31a6d18b3 Update README.md (#65146)
Co-authored-by: Alexandre Girard <alexandre@airbyte.io>
2025-08-22 08:20:23 -07:00