Plugin Code Review

A review checklist for Open WebUI plugin code. It checks translation handling, user and chat context access, logging, event safety, and compatibility with streaming responses.

In plain words
What is it for?
Use it during code review to inspect internationalized text, context handling, logging, event emitters, safety rules, and streaming behavior.
Why use it?
It catches common reliability, safety, and language-support problems before plugin code is accepted. The checklist also enforces the project’s required single-file structure and helper patterns.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/fu-jie/openwebui-extensions/code-review
Clone the repo
git clone --depth 1 https://github.com/Fu-Jie/openwebui-extensions

Made for: GitHub Copilot.

Per session 899 This file is loaded in full into every session.
When invoked 899 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00899 $0.00899
Opus 5 $0.00449 $0.00449
Sonnet 5 $0.00180 $0.00180
Haiku 4.5 $0.00090 $0.00090

Measured 2d ago against content hash 1b01c9e2ab07, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Plugin Code Review scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/code-review.instructions.md · 55 lines

How it starts

The opening of the file, as written. The whole thing — 55 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Code Review Instructions — OpenWebUI Plugins

You are an expert Senior Software Engineer reviewing OpenWebUI plugins for the openwebui-extensions repository. When reviewing plugin code, you MUST verify each point below to ensure the code meets the strict repository standards.

1. Single-file i18n Pattern (CRITICAL)

  • One File Rule: One .py file per plugin. No _cn.py or language-split files.
  • Translations: All user-visible strings (status, notification, UI text) MUST go through a TRANSLATIONS dictionary and a FALLBACK_MAP.
  • Safety: format(**kwargs) calls on translated strings MUST be wrapped in try/except KeyError to prevent crashes if a translation is missing a placeholder.

2. Context Helpers (CRITICAL)

  • User Context: MUST use _get_user_context(__user__) instead of direct __user__["name"] access. __user__ can be a list, dict, or None.
  • Chat Context: MUST use _get_chat_context(body, __metadata__) instead of ad-hoc body.get("chat_id") calls.

3. Event & Logging

  • No Print: No bare print() in production code. Use logging.getLogger(__name__).
  • Emitter Safety: Every await emitter(...) call MUST be guarded by if emitter: (or equivalent).
  • Status Lifecycle:
    • _emit_status(done=False) at task start.
    • _emit_status(done=True) on completion.
    • _emit_notification("error") on failure.

4. Antigravity Safety (CRITICAL)

  • Timeout Guards: All __event_call__ JS executions MUST be wrapped with asyncio.wait_for(..., timeout=2.0). Failure to do this can hang the entire backend.
  • JS Fallbacks: JS code executed via __event_call__ MUST have an internal try { ... } catch (e) { return fallback; } block.
  • Path Sandboxing: File path operations MUST be validated against the workspace root (no directory traversal vulnerabilities).
  • Upload Fallbacks: Upload paths MUST have a dual-channel fallback (API → local/DB).

5. Filter Singleton Safety

  • No Mutable State: Filter plugins are singletons. There MUST be NO request-scoped mutable state stored on self (e.g., self.current_user = ...).
  • Statelessness: Per-request values MUST be computed from body and context helpers on each call.

Read the full file on GitHub · 55 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 55 lines · 899 tokens per session scan A 1b01c9e2ab07

Subscribe to this mod's changes

Plugin Code Review is an instructions file published in the GitHub repository Fu-Jie/openwebui-extensions (302 stars, last pushed 1mo ago), licensed MIT. It adds 899 tokens to every session, about $0.0045 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.