plugin.yaml 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. name: chatto-platform
  2. label: Chatto
  3. kind: platform
  4. version: 1.0.1
  5. description: >
  6. Chatto gateway adapter for Hermes Agent.
  7. Connects to a Chatto server (cloud-hosted or self-hosted team chat) and relays messages
  8. between rooms/DMs and the Hermes agent. Uses the Chatto ConnectRPC API
  9. (JSON over HTTP) for outbound messages and the Chatto realtime WebSocket
  10. protocol (binary protobuf) for inbound events. Nothing to install:
  11. chattolib[realtime] and its dependencies are vendored into the plugin.
  12. author: Paul Klumpp
  13. provides_tools:
  14. - chatto_send_dm
  15. - chatto_send_room
  16. - chatto_list_rooms
  17. - chatto_get_message
  18. - chatto_get_history
  19. - chatto_list_room_attachments
  20. - chatto_list_pinned_messages
  21. - chatto_pin_message
  22. - chatto_set_custom_status
  23. - chatto_delete_custom_status
  24. requires_env:
  25. - name: CHATTO_BASE_URL
  26. description: "Base URL of the Chatto server (e.g. https://chat.example.com) leave blank for ChattoHQ (https://chat.chatto.run)"
  27. prompt: "Chatto server Base URL"
  28. password: false
  29. - name: CHATTO_TOKEN
  30. description: "Bot API key (e.g. cht_BK_...) — generate one in Chatto under Settings → Bot Accounts"
  31. prompt: "Chatto bot token"
  32. password: true
  33. optional_env:
  34. - name: CHATTO_HOME_CHANNEL
  35. description: "Room ID for cron / notification delivery (default: none — context-less deliveries are not sent without it)"
  36. prompt: "Home room ID (or empty)"
  37. password: false
  38. # Asked before CHATTO_ALLOWED_USERS: a "yes" here makes the user list moot,
  39. # and the two are mutually exclusive (hermes_validate_config rejects both).
  40. - name: CHATTO_ALLOW_ALL_USERS
  41. description: "Allow any Chatto user to talk to the agent (default: false)"
  42. prompt: "Allow all users? (true/false)"
  43. password: false
  44. - name: CHATTO_ALLOWED_USERS
  45. description: "Comma-separated Chatto logins or user IDs allowed to talk to the agent (default: none — denies everyone unless CHATTO_ALLOW_ALL_USERS=true)"
  46. prompt: "Allowed users (comma-separated)"
  47. password: false
  48. - name: CHATTO_REQUIRE_MENTION_ROOMS
  49. description: "Comma-separated room IDs where the bot answers only when addressed (@name, @all or @here); rooms on neither this nor CHATTO_OPTIONAL_MENTION_ROOMS stay silent — read-only, never seeded into context, never answered. DMs always get a response. (default: none — the listed rooms answer only mentions)"
  50. prompt: "Mention-required room IDs (comma-separated)"
  51. password: false
  52. - name: CHATTO_AUTO_THREAD
  53. description: "Auto-create threads for replies in rooms (default: true). Set false to reply in the room timeline."
  54. prompt: "Auto-thread replies? (true/false)"
  55. password: false
  56. - name: CHATTO_OPTIONAL_MENTION_ROOMS
  57. description: "Comma-separated room IDs where the bot answers every message, addressed or not; rooms on neither this nor CHATTO_REQUIRE_MENTION_ROOMS stay silent — read-only, never seeded into context, never answered. (default: none — the listed rooms answer everything)"
  58. prompt: "Free-response room IDs (comma-separated)"
  59. password: false
  60. - name: CHATTO_REACTIONS
  61. description: "Add 👀/✅/❌/🚫 reactions to messages during processing (default: true)"
  62. prompt: "Enable message reactions? (true/false)"
  63. password: false
  64. - name: CHATTO_EDIT_DISPATCH
  65. description: "Treat edits of chat messages as corrections: a message being processed is restarted with the edited text, a message the bot ignored (e.g. missing @mention) is re-checked against its new text. Already-answered messages stay answered, and edits older than CHATTO_EDIT_WINDOW are ignored. (default: true)"
  66. prompt: "Process message edits as corrections? (true/false)"
  67. password: false
  68. - name: CHATTO_EDIT_WINDOW
  69. description: "How long after posting an edit may still land, in seconds; older edits are ignored (default: 300)"
  70. prompt: "Edit window in seconds (or empty for 300)"
  71. password: false