Skip to content

darinkelkhoff/flowrBoxrMCP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

flowrBoxr

An MCP (Model Context Protocol) server that generates flower box comments — decorative box comments made of repeated comment characters surrounding text.

Ported from the algorithm in Kingsrook's IntelliJ Commentator Plugin.

Examples

Single-line:

//////////
// Test //
//////////

Multi-line with indentation:

   /////////////
   // Test    //
   // In Here //
   /////////////

Shell-style:

##########
## Test ##
##########

Tool: create_flower_box_comment

Parameters

Parameter Type Required Description
text string yes The text to put inside the flower box. Can be multi-line.
filename string no Filename or extension (e.g., foo.py) to auto-detect the comment character.
comment_char string no Explicit comment character (/, #, -, etc.). Overrides filename detection.
indent number no Number of spaces to indent the entire box.

Comment character auto-detection

Character Extensions
/ js, ts, jsx, tsx, java, c, cpp, h, hpp, cs, go, rs, swift, kt, scala, groovy, gradle, json, css, scss, less, php
# sh, bash, zsh, py, rb, pl, yaml, yml, toml, tf, r, coffee, makefile, dockerfile, vtl, vm, conf, env, gitignore
- sql, lua, hs, elm, ada
; clj, cljs, el, lisp, scm, asm
% tex, erl, m

Defaults to / if the extension is not recognized.

Setup

npm install

Register with Claude Code

claude mcp add --scope user flowrBoxr -- node /path/to/flowrBoxr/index.js

Then add this to ~/.claude/CLAUDE.md so Claude always uses the tool:

## Flower Box Comments
When writing or editing code in a codebase that uses flower box comments, **always use the
`mcp__flowrBoxr__create_flower_box_comment` tool** to generate them. Do not hand-write flower
box comments. Pass the filename so it auto-detects the comment character, and use the `indent`
parameter to match surrounding indentation.

**Java/Javadoc exception:** In Java (and similar languages), do NOT use flower box comments for
element-level documentation (classes, methods, fields, interfaces, enums). Use full-width Javadoc
headers instead:
    /***********************************************************************
     * Description of the element
     ***********************************************************************/
Flower box comments are only for inline section dividers and block comments within method bodies
or between logical sections — not for element headers.

And to make it always be allowed without prompting, you can add to ~/.claude/settings.json:

  "permissions": {
    "allow": [
      "mcp__flowrBoxr__create_flower_box_comment"

Running tests

node test.js

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors