Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Reorganize custom agent guide: move connectors section, add export/import#997

Merged
kovtcharov-amd merged 2 commits into
mainfrom
claude/remove-yaml-migration-section-gtSKE
May 11, 2026
Merged

Reorganize custom agent guide: move connectors section, add export/import#997
kovtcharov-amd merged 2 commits into
mainfrom
claude/remove-yaml-migration-section-gtSKE

Conversation

@itomek

@itomek itomek commented May 8, 2026

Copy link
Copy Markdown
Collaborator

Summary

Reorganizes the custom agent documentation to improve information architecture and adds comprehensive coverage of agent export/import functionality. Moves the GAIA connectors section after the Quick Start guide, removes the legacy YAML manifest migration section, and adds a new "Export and import agents" section with UI and CLI instructions.

Why

The original guide structure buried the connectors section early, before users had context about building agents. The migration section for YAML manifests (deprecated in v0.17.5) is no longer relevant and clutters the guide. The export/import feature lacked documentation entirely. This reorganization:

  1. Improves flow: Quick Start → Python Agent → Tools → Connectors → Export/Import follows a natural progression from building to integrating to sharing.
  2. Removes obsolete content: YAML manifest migration is no longer needed since manifests are no longer loaded.
  3. Documents export/import: Adds complete UI and CLI instructions, bundle structure, security considerations, and troubleshooting.
  4. Adds visual context: Includes Frame captions and images for Quick Start steps and connector features.
  5. Adds helpful tips: Cross-references connectors from the tools section and Quick Start to guide users toward secure credential handling.

Changes

  • Moved "Using GAIA connectors" section from early in the guide (after intro) to after "Python Agent" and "Tools" sections
  • Removed "Migrating from a YAML Manifest" section entirely (deprecated feature)
  • Added new "Export and import agents" section with:
    • UI instructions (Settings → Custom Agents, Export All, Import buttons)
    • CLI commands (gaia agent export, gaia agent import)
    • Bundle structure and format documentation
    • Security warnings about embedded secrets and third-party code execution
    • Validation and size limits
  • Added Frame captions and image references to Quick Start steps
  • Added Tip callouts linking to connectors from Quick Start and Tools sections
  • Simplified agent.yaml sidecar documentation (removed legacy format warnings)
  • Added FAQ entry for imported agent troubleshooting

Test plan

  • Verify documentation renders correctly in the docs site (no broken links, images load)
  • Confirm cross-references between sections work (e.g., #using-gaia-connectors anchor links)
  • Manual review of reorganized flow: Quick Start → Python Agent → Tools → Connectors → Export/Import reads naturally

Checklist

  • I have linked a GitHub issue above (Closes #N / Fixes #N / Refs #N).
  • I have described why this change is being made, not just what changed.
  • I have run linting and tests locally (python util/lint.py --all, pytest tests/unit/).
  • I have updated documentation if user-visible behavior changed (see CONTRIBUTING.md).

https://claude.ai/code/session_01QrSJkzYevv4NktxmanRiFT

Closes #1048

…ML migration

Reorganize the Custom Agents guide so the Quick Start is the first thing readers
hit, with the Python agent path next and the heavier Connectors section moved
below both. The previous layout buried the fastest path behind a connector
explanation most readers don't need yet, and showed a "Migrating from a YAML
Manifest" section for a manifest format that never shipped.

Add a new Export and Import Agents section covering both the Agent UI flow
(Settings -> Custom Agents) and the existing `gaia agent export/import` CLI,
including the bundle layout, size limits, and the credential / third-party-code
warnings the implementation already enforces. Add a matching troubleshooting
entry for import failures and screenshot placeholders for the Builder flow,
connectors UI, and export/import panels.
@github-actions github-actions Bot added the documentation Documentation changes label May 8, 2026
The link checker walks the filesystem for every src=... it finds, including
inside MDX comments, so the seven screenshot placeholders pointed at PNGs that
don't exist yet broke the "Verify internal cross-references" CI check. Drop the
Frame/img markup and leave plain-prose TODO comments naming the file path each
screenshot should land at — keeps the breadcrumb for whoever captures the
images without tripping CI.
@itomek itomek self-assigned this May 8, 2026
itomek added a commit that referenced this pull request May 8, 2026
…1000

The fence-injection commit (f0212e2) referenced ``#997`` for the
multi-model follow-up. The actual issue landed as #1000. Update all
docstrings, comments, and the canary test to point at the right number.

No behavioral change.
@itomek itomek marked this pull request as ready for review May 8, 2026 20:43
@itomek itomek requested a review from kovtcharov-amd as a code owner May 8, 2026 20:43
@kovtcharov-amd kovtcharov-amd added this pull request to the merge queue May 11, 2026
Merged via the queue into main with commit 60ee037 May 11, 2026
31 checks passed
@kovtcharov-amd kovtcharov-amd deleted the claude/remove-yaml-migration-section-gtSKE branch May 11, 2026 20:05
itomek added a commit that referenced this pull request May 11, 2026
…1000

The fence-injection commit (f0212e2) referenced ``#997`` for the
multi-model follow-up. The actual issue landed as #1000. Update all
docstrings, comments, and the canary test to point at the right number.

No behavioral change.
@itomek itomek mentioned this pull request May 14, 2026
6 tasks
pull Bot pushed a commit to bhardwajRahul/gaia that referenced this pull request May 15, 2026
## Why this matters

v0.18.0 ships agent memory v2 (hybrid-search second brain with LLM
extraction and observability dashboard), ChatAgent split into three
composable agents (Chat/FileIO/DocumentQA), parallel tool calls, and a
Telegram adapter scaffold — plus fixes the RAG-on-PDF timeout with Gemma
4 that broke document Q&A since v0.17.6 and adds CI gates that enforce
RAG quality baselines on every future PR.

Full notes: `docs/releases/v0.18.0.mdx`.

## What's New

- **Agent memory v2** ([amd#606](amd#606)) —
Hybrid semantic + keyword search, LLM extraction, observability
dashboard via SSE streaming
([amd#1032](amd#1032)). Per-user isolation
enforced; extraction runs async so it doesn't add latency.
- **ChatAgent split** ([amd#979](amd#979)) —
`ChatAgent`, `FileIOAgent`, and `DocumentQAAgent` replace the monolithic
class; each composable via `tools=`. Backward-compatible shim preserved.
- **Parallel tool calls** ([amd#946](amd#946))
— Multiple `tool_calls` from a single LLM turn are executed
concurrently, cutting round-trips for multi-tool workflows.
- **Telegram adapter scaffold, Phase 0**
([amd#951](amd#951)) — `gaia telegram
start|stop|status`, per-user session isolation, `[telegram]` extras.
Phase 1 (message handling + allowed-users gate) tracked in
[amd#889](amd#889).
- **Connectors: per-MCP toggle + single-writer enforcement**
([amd#1018](amd#1018),
[amd#998](amd#998)) — Disable individual MCP
servers without removing them; concurrent writes serialised with
actionable errors on contention.
- **File navigation, web browsing, and write security**
([amd#495](amd#495)) — `FileSearchToolsMixin`,
web browsing tool, and scratchpad mixin in `KNOWN_TOOLS`; write tools
check `allowed_paths` before dispatch.
- **Email UI and policy alerts**
([amd#995](amd#995),
[amd#1039](amd#1039),
[amd#952](amd#952)) — Pre-scan triage card,
in-chat Connect, policy alert cards, and durable receipts for
confirmation-gated actions.

## Bug Fixes

- **RAG-on-PDF timeouts on Gemma 4**
([amd#1034](amd#1034), closes
[amd#1030](amd#1030)) — Prompt-size budget
check added at composition time; CI gates enforce it on every PR
([amd#1040](amd#1040)).
- **Envelope-level parse failure crashed SD recovery**
([amd#1047](amd#1047), closes
[amd#1023](amd#1023)) — Falls through to a
clean recovery path with step-1 context preserved.
- **Windows-path tool args corrupted**
([amd#1027](amd#1027)) — Backslash
normalisation now happens after argument parsing.
- **Blender `send_command` hung**
([amd#1026](amd#1026), closes
[amd#1022](amd#1022)) — Read timeout applied
to persistent-connection servers.
- **`gaia chat init` in post-install banner**
([amd#1029](amd#1029), closes
[amd#1024](amd#1024)) — Replaced with the
correct `gaia init`.
- **Keyring treated as required**
([amd#1028](amd#1028)) — Import guarded;
optional on systems without `keyring`.
- **electron-builder URLs stale**
([amd#953](amd#953)) — Three doc/installer
files updated to current download paths.

## Tooling & Docs

- **RAG eval CI gates** ([amd#1040](amd#1040),
closes [amd#1033](amd#1033)) — RAG quality
baselines + prompt-size budget enforced on every PR.
- **Fork-PR authors now receive Claude review**
([amd#932](amd#932)) —
`allowed_non_write_users: "*"` with prompt-injection mitigations
documented.
- **Eval runs mandated before merging**
([amd#1036](amd#1036)) — `CLAUDE.md` requires
`gaia eval agent` for LLM-affecting changes.
- **GAIA website** ([amd#369](amd#369)) —
[amd-gaia.ai](https://amd-gaia.ai) live.
- **Custom agent guide reorganised**
([amd#997](amd#997)), Lemonade PPA docs
([amd#801](amd#801)), broken Lemonade CLI URL
fixed ([amd#996](amd#996)), WhatsApp adapter
evaluation spec ([amd#950](amd#950)).

## Release checklist

- [x] `util/validate_release_notes.py docs/releases/v0.18.0.mdx --tag
v0.18.0` passes
- [x] `src/gaia/version.py` → `0.18.0`
- [x] `src/gaia/apps/webui/package.json` → `0.18.0`
- [x] Navbar label in `docs/docs.json` → `v0.18.0 · Lemonade 10.2.0`
- [x] All 28 commits in range (v0.17.6..HEAD) are represented in the
notes
- [ ] Review from @kovtcharov-amd addressed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reorganize custom agent guide: information architecture + export/import docs

4 participants