mirror of https://github.com/Significant-Gravitas/AutoGPT.git synced 2026-01-22 21:48:12 -05:00

Files

Nicholas Tindle c1a1767034 feat(docs): Add block documentation auto-generation system (#11707 )

- 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>

2026-01-19 07:03:19 +00:00

15 KiB

Raw Blame History

Google Gmail

Blocks for reading, sending, and managing emails in Gmail.

Gmail Add Label

What it is

A block that adds a label to a specific email message in Gmail, creating the label if it doesn't exist.

How it works

The block first checks if the specified label exists in the user's Gmail account. If it doesn't, it creates the label. Then, it adds the label to the specified email message using the message ID.

Inputs

Input	Description	Type	Required
message_id	Message ID to add label to	str	Yes
label_name	Label name to add	str	Yes

Outputs

Output	Description	Type
error	Error message if any	str
result	Label addition result	GmailLabelResult

Possible use case

Automatically categorizing incoming customer emails based on their content, adding labels like "Urgent," "Feedback," or "Invoice" for easier processing.

Gmail Create Draft

What it is

Create draft emails in Gmail with automatic HTML detection and proper text formatting. Plain text drafts preserve natural paragraph flow without 78-character line wrapping. HTML content is automatically detected and formatted correctly.

How it works

This block creates a draft email in Gmail without sending it. The draft is saved to your Drafts folder where you can review and send it manually. The block automatically detects HTML content or you can explicitly set the content type.

Plain text emails preserve natural formatting without forced line breaks. HTML emails support rich formatting. File attachments are supported by providing file paths.

Inputs

Input	Description	Type	Required
to	Recipient email addresses	List[str]	Yes
subject	Email subject	str	Yes
body	Email body (plain text or HTML)	str	Yes
cc	CC recipients	List[str]	No
bcc	BCC recipients	List[str]	No
content_type	Content type: 'auto' (default - detects HTML), 'plain', or 'html'	"auto" \| "plain" \| "html"	No
attachments	Files to attach	List[str (file)]	No

Outputs

Output	Description	Type
error	Error message if any	str
result	Draft creation result	GmailDraftResult

Possible use case

Email Review Workflow: Create draft emails for human review before sending important communications.

Newsletter Preparation: Build email drafts with dynamic content that can be finalized before distribution.

Template Saving: Save email templates as drafts for quick access and reuse.

Gmail Draft Reply

What it is

Create draft replies to Gmail threads with automatic HTML detection and proper text formatting. Plain text draft replies maintain natural paragraph flow without 78-character line wrapping. HTML content is automatically detected and formatted correctly.

How it works

This block creates a draft reply within an existing email thread. The draft maintains proper threading so your reply appears in the conversation. Use replyAll to respond to all original recipients, or specify custom recipients.

The block preserves the thread context and adds proper email headers for threading. Draft replies can be reviewed in Gmail before sending.

Inputs

Input	Description	Type	Required
threadId	Thread ID to reply in	str	Yes
parentMessageId	ID of the message being replied to	str	Yes
to	To recipients	List[str]	No
cc	CC recipients	List[str]	No
bcc	BCC recipients	List[str]	No
replyAll	Reply to all original recipients	bool	No
subject	Email subject	str	No
body	Email body (plain text or HTML)	str	Yes
content_type	Content type: 'auto' (default - detects HTML), 'plain', or 'html'	"auto" \| "plain" \| "html"	No
attachments	Files to attach	List[str (file)]	No

Outputs

Output	Description	Type
error	Error message if the operation failed	str
draftId	Created draft ID	str
messageId	Draft message ID	str
threadId	Thread ID	str
status	Draft creation status	str

Possible use case

Support Response Preparation: Draft replies to customer inquiries for review before sending.

Approval Workflows: Create reply drafts that require manager approval before being sent.

Scheduled Responses: Prepare replies to be reviewed and sent at appropriate times.

Gmail Forward

What it is

Forward Gmail messages to other recipients with automatic HTML detection and proper formatting. Preserves original message threading and attachments.

How it works

This block forwards an existing Gmail message to new recipients. The original message content is preserved and can include attachments from the original email. You can add your own message before the forwarded content.

The block handles proper email threading and formatting, prepending "Fwd:" to the subject unless you specify a custom subject.

Inputs

Input	Description	Type	Required
messageId	ID of the message to forward	str	Yes
to	Recipients to forward the message to	List[str]	Yes
cc	CC recipients	List[str]	No
bcc	BCC recipients	List[str]	No
subject	Optional custom subject (defaults to 'Fwd: [original subject]')	str	No
forwardMessage	Optional message to include before the forwarded content	str	No
includeAttachments	Include attachments from the original message	bool	No
content_type	Content type: 'auto' (default - detects HTML), 'plain', or 'html'	"auto" \| "plain" \| "html"	No
additionalAttachments	Additional files to attach	List[str (file)]	No

Outputs

Output	Description	Type
error	Error message if the operation failed	str
messageId	Forwarded message ID	str
threadId	Thread ID	str
status	Forward status	str

Possible use case

Email Escalation: Automatically forward emails matching certain criteria to managers or specialists.

Team Distribution: Forward important updates to relevant team members based on content.

Record Keeping: Forward copies of important communications to an archive address.

Gmail Get Profile

What it is

Get the authenticated user's Gmail profile details including email address and message statistics.

How it works

This block retrieves profile information for the authenticated Gmail user via the Gmail API. It returns the email address, total message count, thread count, and storage usage statistics.

This is useful for verifying which account is connected and gathering basic mailbox statistics.

Outputs

Output	Description	Type
error	Error message if the operation failed	str
profile	Gmail user profile information	Profile

Possible use case

Account Verification: Confirm which Gmail account is connected before performing operations.

Usage Monitoring: Check storage usage and message counts for mailbox management.

Multi-Account Workflows: Get the current user's email address to route workflows appropriately.

Gmail Get Thread

What it is

A block that retrieves an entire Gmail thread (email conversation) by ID, returning all messages with decoded bodies for reading complete conversations.

How it works

This block retrieves a complete Gmail thread (email conversation) by its thread ID. It returns all messages in the thread with decoded bodies, allowing you to read the full conversation history.

The thread includes all messages, their senders, timestamps, and content, making it easy to analyze entire email conversations.

Inputs

Input	Description	Type	Required
threadId	Gmail thread ID	str	Yes

Outputs

Output	Description	Type
error	Error message if the operation failed	str
thread	Gmail thread with decoded message bodies	Thread

Possible use case

Conversation Analysis: Read an entire email thread to understand the full context of a discussion.

Reply Detection: Check if a recipient has responded within a conversation thread.

Thread Summarization: Gather all messages in a thread for AI-powered summarization.

Gmail List Labels

What it is

A block that retrieves all labels (categories) from a Gmail account for organizing and categorizing emails.

How it works

The block connects to the user's Gmail account and requests a list of all labels. It then processes this information and returns a simplified list of label names and their corresponding IDs.

Outputs

Output	Description	Type
error	Error message if any	str
result	List of labels	List[Dict[str, Any]]

Possible use case

Creating a dashboard that shows an overview of how many emails are in each category or label in a business email account.

Gmail Read

What it is

A block that retrieves and reads emails from a Gmail account based on search criteria, returning detailed message information including subject, sender, body, and attachments.

How it works

The block connects to the user's Gmail account using their credentials, performs a search based on the provided query, and retrieves the specified number of email messages. It then processes each email to extract relevant information and returns the results.

Inputs

Input	Description	Type	Required
query	Search query for reading emails	str	No
max_results	Maximum number of emails to retrieve	int	No

Outputs

Output	Description	Type
error	Error message if any	str
email	Email data	Email
emails	List of email data	List[Email]

Possible use case

Automatically checking for new customer inquiries in a support email inbox and organizing them for quick response.

Gmail Remove Label

What it is

A block that removes a label from a specific email message in a Gmail account.

How it works

The block first finds the ID of the specified label in the user's Gmail account. If the label exists, it removes it from the specified email message using the message ID.

Inputs

Input	Description	Type	Required
message_id	Message ID to remove label from	str	Yes
label_name	Label name to remove	str	Yes

Outputs

Output	Description	Type
error	Error message if any	str
result	Label removal result	GmailLabelResult

Possible use case

Automatically removing the "Unread" label from emails after they have been processed by a customer service representative.

Gmail Reply

What it is

Reply to Gmail threads with automatic HTML detection and proper text formatting. Plain text replies maintain natural paragraph flow without 78-character line wrapping. HTML content is automatically detected and sent with correct MIME type.

How it works

This block sends a reply directly within an existing Gmail thread. Unlike the draft reply block, this immediately sends the message. The reply maintains proper threading and appears in the conversation.

Use replyAll to respond to all recipients, or specify custom recipients. The block handles email headers and threading automatically.

Inputs

Input	Description	Type	Required
threadId	Thread ID to reply in	str	Yes
parentMessageId	ID of the message being replied to	str	Yes
to	To recipients	List[str]	No
cc	CC recipients	List[str]	No
bcc	BCC recipients	List[str]	No
replyAll	Reply to all original recipients	bool	No
subject	Email subject	str	No
body	Email body (plain text or HTML)	str	Yes
content_type	Content type: 'auto' (default - detects HTML), 'plain', or 'html'	"auto" \| "plain" \| "html"	No
attachments	Files to attach	List[str (file)]	No

Outputs

Output	Description	Type
error	Error message if the operation failed	str
messageId	Sent message ID	str
threadId	Thread ID	str
message	Raw Gmail message object	Dict[str, Any]
email	Parsed email object with decoded body and attachments	Email

Possible use case

Auto-Acknowledgments: Automatically send acknowledgment replies to incoming support requests.

Scheduled Follow-ups: Reply to threads with follow-up messages at appropriate times.

Conversation Continuity: Respond to ongoing threads while keeping all messages organized.

Gmail Send

What it is

Send emails via Gmail with automatic HTML detection and proper text formatting. Plain text emails are sent without 78-character line wrapping, preserving natural paragraph flow. HTML emails are automatically detected and sent with correct MIME type.

How it works

The block authenticates with the user's Gmail account, creates an email message with the provided details (recipient, subject, and body), and then sends the email using Gmail's API.

Inputs

Input	Description	Type	Required
to	Recipient email addresses	List[str]	Yes
subject	Email subject	str	Yes
body	Email body (plain text or HTML)	str	Yes
cc	CC recipients	List[str]	No
bcc	BCC recipients	List[str]	No
content_type	Content type: 'auto' (default - detects HTML), 'plain', or 'html'	"auto" \| "plain" \| "html"	No
attachments	Files to attach	List[str (file)]	No

Outputs

Output	Description	Type
error	Error message if any	str
result	Send confirmation	GmailSendResult

Possible use case

Automatically sending confirmation emails to customers after they make a purchase on an e-commerce website.

15 KiB Raw Blame History

Google Gmail

Gmail Add Label

What it is

How it works

Inputs

Outputs

Possible use case

Gmail Create Draft

What it is

How it works

Inputs

Outputs

Possible use case

Gmail Draft Reply

What it is

How it works

Inputs

Outputs

Possible use case

Gmail Forward

What it is

How it works

Inputs

Outputs

Possible use case

Gmail Get Profile

What it is

How it works

Outputs

Possible use case

Gmail Get Thread

What it is

How it works

Inputs

Outputs

Possible use case

Gmail List Labels

What it is

How it works

Outputs

Possible use case

Gmail Read

What it is

How it works

Inputs

Outputs

Possible use case

Gmail Remove Label

What it is

How it works

Inputs

Outputs

Possible use case

Gmail Reply

What it is

How it works

Inputs

Outputs

Possible use case

Gmail Send

What it is

How it works

Inputs

Outputs

Possible use case

15 KiB

Raw Blame History