mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-02-10 06:45:28 -05:00
c1a1767034
- Add generate_block_docs.py script that introspects block code to
generate markdown
- Support manual content preservation via <!-- MANUAL: --> markers
- Add migrate_block_docs.py to preserve existing manual content from git
HEAD
- Add CI workflow (docs-block-sync.yml) to fail if docs drift from code
- Add Claude PR review workflow (docs-claude-review.yml) for doc changes
- Add manual LLM enhancement workflow (docs-enhance.yml)
- Add GitBook configuration (.gitbook.yaml, SUMMARY.md)
- Fix non-deterministic category ordering (categories is a set)
- Add comprehensive test suite (32 tests)
- Generate docs for 444 blocks with 66 preserved manual sections
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
<!-- Clearly explain the need for these changes: -->
### Changes 🏗️
<!-- Concisely describe all of the changes made in this pull request:
-->
### 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] Extensively test code generation for the docs pages
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> Introduces an automated documentation pipeline for blocks and
integrates it into CI.
>
> - Adds `scripts/generate_block_docs.py` (+ tests) to introspect blocks
and generate `docs/integrations/**`, preserving `<!-- MANUAL: -->`
sections
> - New CI workflows: **docs-block-sync** (fails if docs drift),
**docs-claude-review** (AI review for block/docs PRs), and
**docs-enhance** (optional LLM improvements)
> - Updates existing Claude workflows to use `CLAUDE_CODE_OAUTH_TOKEN`
instead of `ANTHROPIC_API_KEY`
> - Improves numerous block descriptions/typos and links across backend
blocks to standardize docs output
> - Commits initial generated docs including
`docs/integrations/README.md` and many provider/category pages
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
631e53e0f6. 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>
89 lines
3.1 KiB
Markdown
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 -->
|
|
|
|
---
|