plugin.yaml 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. name: yuanbao-platform
  2. label: Yuanbao
  3. kind: platform
  4. version: 1.0.0
  5. description: >
  6. Tencent Yuanbao gateway adapter for Hermes Agent.
  7. Connects to Yuanbao IM Bot over a persistent WebSocket (HMAC-signed sign token)
  8. and relays DMs and group messages between Yuanbao and the Hermes agent.
  9. Supports native media/stickers, DM/group access policies, and home-channel cron delivery.
  10. author: NousResearch
  11. requires_env:
  12. - name: YUANBAO_APP_ID
  13. description: "The App ID from your Yuanbao IM Bot credentials (legacy alias: YUANBAO_APP_KEY)"
  14. prompt: "App ID"
  15. password: false
  16. - name: YUANBAO_APP_SECRET
  17. description: "The App Secret (used for HMAC signing) from your Yuanbao IM Bot"
  18. prompt: "App Secret"
  19. password: true
  20. optional_env:
  21. - name: YUANBAO_BOT_ID
  22. description: "Bot account ID (auto-detected from the sign token when unset)"
  23. prompt: "Bot ID"
  24. password: false
  25. - name: YUANBAO_WS_URL
  26. description: "Override the Yuanbao WebSocket gateway URL"
  27. prompt: "WebSocket URL"
  28. password: false
  29. - name: YUANBAO_API_DOMAIN
  30. description: "Override the Yuanbao API domain (sign-token endpoint)"
  31. prompt: "API domain"
  32. password: false
  33. - name: YUANBAO_ROUTE_ENV
  34. description: "Routing environment header for non-production Yuanbao backends"
  35. prompt: "Route env"
  36. password: false
  37. - name: YUANBAO_DM_POLICY
  38. description: "DM access policy: open, allowlist or disabled"
  39. prompt: "DM policy (open|allowlist|disabled)"
  40. password: false
  41. - name: YUANBAO_DM_ALLOW_FROM
  42. description: "Comma-separated user IDs allowed to DM the bot (allowlist policy)"
  43. prompt: "DM allowlist (comma-separated)"
  44. password: false
  45. - name: YUANBAO_GROUP_POLICY
  46. description: "Group access policy: open, allowlist or disabled"
  47. prompt: "Group policy (open|allowlist|disabled)"
  48. password: false
  49. - name: YUANBAO_GROUP_ALLOW_FROM
  50. description: "Comma-separated group IDs allowed (allowlist policy)"
  51. prompt: "Group allowlist (comma-separated)"
  52. password: false
  53. - name: YUANBAO_ALLOWED_USERS
  54. description: "Comma-separated Yuanbao user IDs allowed to talk to the bot"
  55. prompt: "Allowed users (comma-separated)"
  56. password: false
  57. - name: YUANBAO_ALLOW_ALL_USERS
  58. description: "Allow any Yuanbao user to trigger the bot (dev only)"
  59. prompt: "Allow all users? (true/false)"
  60. password: false
  61. - name: YUANBAO_HOME_CHANNEL
  62. description: "Default chat ID for cron / notification delivery"
  63. prompt: "Home channel ID"
  64. password: false
  65. - name: YUANBAO_HOME_CHANNEL_NAME
  66. description: "Display name for the home channel"
  67. prompt: "Home channel name"
  68. password: false