Skip to content

docs: add send_message tool page (agent-facing proactive gateway delivery)#816

Merged
MervinPraison merged 1 commit into
mainfrom
claude/issue-811-20260623-1139
Jun 23, 2026
Merged

docs: add send_message tool page (agent-facing proactive gateway delivery)#816
MervinPraison merged 1 commit into
mainfrom
claude/issue-811-20260623-1139

Conversation

@MervinPraison

Copy link
Copy Markdown
Owner

Summary

Adds the documentation page for the send_message built-in tool introduced in MervinPraison/PraisonAI#2188.

File created: docs/features/send-message-tool.mdx
docs.json: Entry added under Features group next to clarify-tool

Page sections

  • Hero mermaid diagram (standard colour scheme)
  • Quick Start — 3 Steps: agent tool setup, action="list", MEDIA: attachment
  • How It Works — sequence diagram (Agent → send_message → Gateway → User)
  • Targets — 4-form table + decision mermaid graph
  • Attachments — MEDIA:<path> directive with multi-file example
  • Listing Targets — action="list" + sample JSON
  • When It's Available — gateway vs CLI table; exact no-gateway fallback string quoted
  • User Interaction Flow — Telegram push narrative
  • Configuration Reference — args table + action comparison
  • Common Patterns — 3 patterns
  • Best Practices — 4 accordions
  • Related — CardGroup: Clarify Tool, Channels Gateway, Bot Gateway, Bot Routing

All content cross-checked against SDK source:

  • src/praisonai-agents/praisonaiagents/tools/messaging_tools.py
  • src/praisonai-agents/praisonaiagents/gateway/protocols.py
  • src/praisonai-agents/praisonaiagents/session/context.py

Fixes #811

Generated with Claude Code

Add docs/features/send-message-tool.mdx documenting the agent-facing
proactive gateway delivery tool introduced in MervinPraison/PraisonAI#2188.

- Hero mermaid diagram with standard colour scheme
- Quick Start with 3 Steps: basic agent use, list targets, MEDIA: attachment
- How It Works sequence diagram (Agent → send_message → Gateway → User)
- Targets table covering all 4 forms: origin / platform / platform:chat_id[:thread_id] / alias
- Decision mermaid graph for choosing the right target form
- MEDIA: attachment documentation with multi-file example
- Listing Targets section with sample JSON output
- When It's Available table: gateway runtime vs CLI (graceful fallback string quoted)
- User Interaction Flow narrative (Telegram push after long task)
- Configuration Reference args table + action comparison table
- Common Patterns: notify on completion / cross-channel handoff / list-then-send
- Best Practices AccordionGroup (4 accordions)
- Related CardGroup: Clarify Tool, Channels Gateway, Bot Gateway, Bot Routing
- Added to docs.json under Features group next to clarify-tool

Co-authored-by: Mervin Praison <MervinPraison@users.noreply.github.com>
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@MervinPraison, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 13 minutes and 32 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b20dbde0-9c83-4ca4-92c7-a6a202a3b130

📥 Commits

Reviewing files that changed from the base of the PR and between e201d44 and a18aef1.

📒 Files selected for processing (2)
  • docs.json
  • docs/features/send-message-tool.mdx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/issue-811-20260623-1139

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces documentation for the new 'Send Message Tool', which allows agents to proactively message users mid-task via platforms like Telegram, Slack, and Discord. The changes include adding the feature to the docs.json navigation structure and creating a comprehensive send-message-tool.mdx guide with quick start examples, flow diagrams, configuration references, and best practices. There are no review comments provided, and I have no additional feedback to offer.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
praisonai 🟢 Ready View Preview Jun 23, 2026, 11:52 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@MervinPraison MervinPraison merged commit 69f49bf into main Jun 23, 2026
16 checks passed
@MervinPraison MervinPraison deleted the claude/issue-811-20260623-1139 branch June 23, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add send_message tool page (agent-facing proactive gateway delivery)

1 participant