mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-02-12 07:45:14 -05:00
docs(blocks): complete block documentation migration cleanup
Move remaining block docs to block-integrations/ subdirectory: - Delete old docs from docs/integrations/ root - Add new docs under docs/integrations/block-integrations/ - Add guides/ directory with LLM and voice provider docs - Update SUMMARY.md with correct navigation structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,88 @@
|
||||
# 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 -->
|
||||
|
||||
---
|
||||
@@ -0,0 +1,89 @@
|
||||
# System Store Operations
|
||||
<!-- MANUAL: file_description -->
|
||||
Blocks for browsing and retrieving agent details from the AutoGPT store.
|
||||
<!-- END MANUAL -->
|
||||
|
||||
## Get Store Agent Details
|
||||
|
||||
### What it is
|
||||
Get detailed information about an agent from the store
|
||||
|
||||
### How it works
|
||||
<!-- MANUAL: how_it_works -->
|
||||
This block retrieves detailed metadata about a specific agent from the AutoGPT store using the creator's username and agent slug. It returns the agent's name, description, categories, run count, and average rating.
|
||||
|
||||
The store_listing_version_id can be used with other blocks to add the agent to your library or execute it.
|
||||
<!-- END MANUAL -->
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description | Type | Required |
|
||||
|-------|-------------|------|----------|
|
||||
| creator | The username of the agent creator | str | Yes |
|
||||
| slug | The name of the agent | str | Yes |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description | Type |
|
||||
|--------|-------------|------|
|
||||
| error | Error message if the operation failed | str |
|
||||
| found | Whether the agent was found in the store | bool |
|
||||
| store_listing_version_id | The store listing version ID | str |
|
||||
| agent_name | Name of the agent | str |
|
||||
| description | Description of the agent | str |
|
||||
| creator | Creator of the agent | str |
|
||||
| categories | Categories the agent belongs to | List[str] |
|
||||
| runs | Number of times the agent has been run | int |
|
||||
| rating | Average rating of the agent | float |
|
||||
|
||||
### Possible use case
|
||||
<!-- MANUAL: use_case -->
|
||||
**Agent Discovery**: Fetch details about a specific agent before adding it to your library.
|
||||
|
||||
**Agent Validation**: Check an agent's ratings and run count to assess quality and popularity.
|
||||
|
||||
**Dynamic Agent Selection**: Get agent metadata to decide which version or variant to use.
|
||||
<!-- END MANUAL -->
|
||||
|
||||
---
|
||||
|
||||
## Search Store Agents
|
||||
|
||||
### What it is
|
||||
Search for agents in the store
|
||||
|
||||
### How it works
|
||||
<!-- MANUAL: how_it_works -->
|
||||
This block searches the AutoGPT agent store using a query string. Filter results by category and sort by rating, runs, or name. Limit controls the maximum number of results returned.
|
||||
|
||||
Results include basic agent information and are output both as a list and individually for workflow iteration.
|
||||
<!-- END MANUAL -->
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Description | Type | Required |
|
||||
|-------|-------------|------|----------|
|
||||
| query | Search query to find agents | str | No |
|
||||
| category | Filter by category | str | No |
|
||||
| sort_by | How to sort the results | "rating" \| "runs" \| "name" \| "updated_at" | No |
|
||||
| limit | Maximum number of results to return | int | No |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description | Type |
|
||||
|--------|-------------|------|
|
||||
| error | Error message if the operation failed | str |
|
||||
| agents | List of agents matching the search criteria | List[StoreAgent] |
|
||||
| agent | Basic information of the agent | StoreAgent |
|
||||
| total_count | Total number of agents found | int |
|
||||
|
||||
### Possible use case
|
||||
<!-- MANUAL: use_case -->
|
||||
**Agent Recommendation**: Search for agents that match user needs and recommend the best options.
|
||||
|
||||
**Marketplace Browse**: Allow users to explore available agents by category or keyword.
|
||||
|
||||
**Agent Orchestration**: Find and compose multiple specialized agents for complex workflows.
|
||||
<!-- END MANUAL -->
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user