Files
AutoGPT/docs/integrations/block-integrations/system/library_operations.md
Nicholas Tindle 90466908a8 refactor(docs): restructure platform docs for GitBook and remove MkDo… (#11825)
<!-- Clearly explain the need for these changes: -->
we met some reality when merging into the docs site but this fixes it
### Changes 🏗️
updates paths, adds some guides
<!-- Concisely describe all of the changes made in this pull request:
-->
update to match reality
### Checklist 📋

#### For code changes:
- [x] I have clearly listed my changes in the PR description
- [x] I have made a test plan
- [x] I have tested my changes according to the test plan:
  <!-- Put your test plan here: -->
  - [x] deploy it and validate

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Aligns block integrations documentation with GitBook.
> 
> - Changes generator default output to
`docs/integrations/block-integrations` and writes overview `README.md`
and `SUMMARY.md` at `docs/integrations/`
> - Adds GitBook frontmatter and hint syntax to overview; prefixes block
links with `block-integrations/`
> - Introduces `generate_summary_md` to build GitBook navigation
(including optional `guides/`)
> - Preserves per-block manual sections and adds optional `extras` +
file-level `additional_content`
> - Updates sync checker to validate parent `README.md` and `SUMMARY.md`
> - Rewrites `docs/integrations/README.md` with GitBook frontmatter and
updated links; adds `docs/integrations/SUMMARY.md`
> - Adds new guides: `guides/llm-providers.md`,
`guides/voice-providers.md`
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
fdb7ff8111. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: bobby.gaffin <bobby.gaffin@agpt.co>
2026-01-23 06:18:16 +00:00

89 lines
3.1 KiB
Markdown

# System Library Operations
<!-- MANUAL: file_description -->
Blocks for managing agents in your personal AutoGPT library.
<!-- END MANUAL -->
## Add To Library From Store
### What it is
Add an agent from the store to your personal library
### How it works
<!-- MANUAL: how_it_works -->
This block copies an agent from the public store into your personal library using its store_listing_version_id. Optionally provide a custom agent_name to rename it in your library.
The block returns the library entry ID and agent graph ID, which can be used to execute the agent or manage your library.
<!-- END MANUAL -->
### Inputs
| Input | Description | Type | Required |
|-------|-------------|------|----------|
| store_listing_version_id | The ID of the store listing version to add to library | str | Yes |
| agent_name | Optional custom name for the agent in your library | str | No |
### Outputs
| Output | Description | Type |
|--------|-------------|------|
| error | Error message if the operation failed | str |
| success | Whether the agent was successfully added to library | bool |
| library_agent_id | The ID of the library agent entry | str |
| agent_id | The ID of the agent graph | str |
| agent_version | The version number of the agent graph | int |
| agent_name | The name of the agent | str |
| message | Success or error message | str |
### Possible use case
<!-- MANUAL: use_case -->
**Agent Provisioning**: Automatically add recommended agents to a user's library.
**Onboarding Flows**: Set up a user's library with starter agents during onboarding.
**Dynamic Agent Access**: Add agents on-demand when users request specific capabilities.
<!-- END MANUAL -->
---
## List Library Agents
### What it is
List all agents in your personal library
### How it works
<!-- MANUAL: how_it_works -->
This block retrieves all agents stored in your personal library. Use search_query to filter by name, and limit/page for pagination through large libraries.
Results include each agent's metadata and are output both as a complete list and individually for iteration.
<!-- END MANUAL -->
### Inputs
| Input | Description | Type | Required |
|-------|-------------|------|----------|
| search_query | Optional search query to filter agents | str | No |
| limit | Maximum number of agents to return | int | No |
| page | Page number for pagination | int | No |
### Outputs
| Output | Description | Type |
|--------|-------------|------|
| error | Error message if the operation failed | str |
| agents | List of agents in the library | List[LibraryAgent] |
| agent | Individual library agent (yielded for each agent) | LibraryAgent |
| total_count | Total number of agents in library | int |
| page | Current page number | int |
| total_pages | Total number of pages | int |
### Possible use case
<!-- MANUAL: use_case -->
**Agent Selection**: Display available agents for users to choose from in a workflow.
**Library Management**: Build interfaces for users to manage and organize their agent library.
**Agent Inventory**: Check what agents are available before deciding which to execute.
<!-- END MANUAL -->
---