🎩 You're Invited:Meet the Socket team at Black Hat in Las Vegas, August 3-6.RSVP
Sign In

openclaw-discourse

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

openclaw-discourse

OpenClaw plugin for Discourse forum integration — read, search, filter, and write topics/posts via agent tools

latest
Source
npmnpm
Version
0.2.3
Version published
Weekly downloads
1
-92.86%
Maintainers
1
Weekly downloads
 
Created
Source

discourse-openclaw

npm version CI License: MIT

OpenClaw plugin for Discourse forum integration. Read, search, and filter topics and posts. Optionally create and update content with an API key.

Install

openclaw plugins install openclaw-discourse

Or install from GitHub:

openclaw plugins install github:pranciskus/discourse-openclaw

Update

openclaw plugins update openclaw-discourse

Configuration

After installing, configure the plugin with your forum URL:

openclaw config set plugins.entries.openclaw-discourse.config.siteUrl "https://meta.discourse.org"

For authenticated access (private categories, write tools):

openclaw config set plugins.entries.openclaw-discourse.config.apiKey "your-discourse-api-key"
openclaw config set plugins.entries.openclaw-discourse.config.allowWrites true

Or edit openclaw.json directly:

Minimal (read-only, public forum)

{
  "plugins": {
    "entries": {
      "openclaw-discourse": {
        "config": {
          "siteUrl": "https://meta.discourse.org"
        }
      }
    }
  }
}

Full (authenticated, write-enabled)

{
  "plugins": {
    "entries": {
      "openclaw-discourse": {
        "config": {
          "siteUrl": "https://community.example.com",
          "apiKey": "your-discourse-api-key",
          "apiUsername": "system",
          "staffUsernames": ["admin", "moderator1"],
          "categories": ["support", "general"],
          "allowWrites": true,
          "signature": "*This content was written by AI.*",
          "requestTimeoutMs": 15000
        }
      }
    }
  }
}

Config Reference

OptionTypeRequiredDefaultDescription
siteUrlstringYesDiscourse forum base URL
apiKeystringNoAPI key for auth. Required for write tools and private categories
apiUsernamestringNo"system"Discourse user to act as when using a global API key. Posts and actions will appear under this username.
staffUsernamesstring[]No[]Usernames treated as staff in discourse_unanswered
categoriesstring[]No[]Category slugs to scope monitoring (empty = all)
allowWritesbooleanNofalseEnable write tools. Requires apiKey
signaturestringNo*This content was written by AI.*Appended to all AI-generated posts and topics
requestTimeoutMsnumberNo15000HTTP request timeout in ms

Tools

Read Tools (always available)

ToolDescriptionKey Parameters
discourse_read_topicRead a topic by ID with poststopic_id, post_limit
discourse_read_postRead a single post by IDpost_id
discourse_searchFull-text search across topics and postsquery, max_results
discourse_filter_topicsList/filter recent topics by categorycategory_slug, order, page
discourse_unansweredFind recent topics with no staff replieshours, category_slug
discourse_get_userGet a user's profileusername
discourse_list_user_postsList a user's recent postsusername, offset, limit
discourse_get_categoriesList all forum categories
discourse_get_tagsList all tags with counts
discourse_site_rulesFetch the site's AI usage policy (/llms.txt)

Write Tools (require apiKey + allowWrites: true)

ToolDescriptionKey Parameters
discourse_create_postReply to an existing topictopic_id, raw
discourse_create_topicCreate a new topictitle, raw, category_id, tags
discourse_update_topicUpdate topic title/category/tagstopic_id, title, category_id, tags

Write tools are rate-limited to ~1 request/second.

llms.txt Policy Support

The plugin respects the llms.txt convention. The discourse_site_rules tool fetches /llms.txt from the forum on demand and returns the site's AI usage policy. All write tool descriptions instruct the LLM to call discourse_site_rules first and follow the rules before posting.

The result is cached for 24 hours. If the fetch fails due to a network error, the LLM is told to proceed with caution rather than assuming no restrictions.

AI Content Signature

All AI-generated posts and topics automatically include a signature separated by a horizontal rule (---). This applies to create_post and create_topic only — update_topic changes metadata (title/category/tags), not body content. The signature text is configurable via the signature config field and is appended programmatically — the LLM cannot skip it.

Getting a Discourse API Key

  • Go to your Discourse admin panel: https://your-forum.com/admin/api/keys
  • Click New API Key
  • Set a description (e.g., "OpenClaw Bot")
  • Choose User Level: Single User or All Users
  • Choose scope: for read-only, select "Read" scopes. For write, add "Write" scopes
  • Copy the generated key and add it to your OpenClaw config

vs discourse-mcp

Featurediscourse-openclawdiscourse-mcp
PlatformOpenClaw nativeMCP (Claude Desktop, etc.)
Read tools1010
Write tools3 (focused)9 (full admin)
Unique toolsdiscourse_unansweredChat, drafts, admin tools
Installopenclaw plugins installStandalone CLI
Best forOpenClaw agents, community support workflowsGeneral MCP clients

This plugin is designed for agent-driven community support. The discourse_unanswered tool is specifically built for finding topics that need attention, which is not available in discourse-mcp.

Development

git clone https://github.com/pranciskus/discourse-openclaw
cd discourse-openclaw
npm install
npm test
npm run typecheck

License

MIT

Keywords

openclaw-plugin

FAQs

Package last updated on 02 Mar 2026

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts