AtlatestRenderedmarkdown
Readme

parlor

A Discourse forum management tool built with Sigil. Works as both a CLI for humans and an MCP server for AI agents.

CLI Usage

parlor topics latest                          # List latest topics
parlor topics top                             # List top topics
parlor topics get 42                          # Get topic
parlor topics create "Title" "Body" 5         # Create topic in category 5
parlor topics close 42                        # Close topic
parlor topics open 42                         # Reopen topic
parlor topics pin 42                          # Pin topic
parlor topics delete 42                       # Delete topic
parlor topics invite 42 "[email protected]"    # Invite user to topic
parlor posts get 123                          # Get post
parlor posts create 42 "Reply body"           # Reply to topic
parlor posts update 123 "Edited body"         # Edit post
parlor posts delete 123                       # Delete post
parlor messages send "Subject" "Body" "user"  # Send message
parlor messages list username                 # List messages
parlor search "query string"                  # Search forum
parlor categories list                        # List categories
parlor categories get 5                       # Get category
parlor categories create "Name" "0088CC"      # Create category
parlor users get username                     # Get user
parlor users list                             # List users
parlor users by-email [email protected]        # Find user by email
parlor users create "Name" "[email protected]" "pw" un  # Create user
parlor groups list                            # List groups
parlor groups get group-name                  # Get group
parlor groups create new-group                # Create group

MCP Server

Start with parlor serve. Exposes these tools:

  • parlor/topics-latest, parlor/topics-top, parlor/topics-by-category, parlor/topics-get, parlor/topics-create, parlor/topics-update, parlor/topics-close, parlor/topics-open, parlor/topics-pin, parlor/topics-delete, parlor/topics-invite
  • parlor/posts-get, parlor/posts-create, parlor/posts-update, parlor/posts-delete
  • parlor/messages-send, parlor/messages-list, parlor/messages-reply
  • parlor/search
  • parlor/categories-list, parlor/categories-get, parlor/categories-create
  • parlor/users-get, parlor/users-list, parlor/users-by-email, parlor/users-create, parlor/users-suspend, parlor/users-unsuspend
  • parlor/groups-list, parlor/groups-get, parlor/groups-create, parlor/groups-add-members, parlor/groups-remove-members
  • parlor/admin-settings, parlor/admin-update-setting, parlor/admin-invite

Configuration

parlor reads a .env-parlor file from the working directory at startup if present.

Create a .env-parlor in your project root:

DISCOURSE_URL=https://forum.example.com
DISCOURSE_API_KEY=your-api-key-here
DISCOURSE_USERNAME=system
VariableDescriptionDefault
DISCOURSE_URLInstance base URL (required)
DISCOURSE_API_KEYAPI key (required)
DISCOURSE_USERNAMEAPI username (required)

Building

sigil deps install
sigil build

The bundled binary is at build/dev/bin/parlor.

Dependencies

License

BSD-3-Clause