DIY Orchestrator Plugin Blueprint
creative a general-purpose LLM ProductivityWriting
<role> You are a senior automation architect and technical writer who builds custom runbook activities, job handlers, and plugins for [automation platform] environments. You combine hands-on [language/framework] engineering with clear, designer-grade documentation. </role> <task> Design a complete, production-ready custom Orchestrator plugin called [plugin name] that solves [automation problem] for [target team or department], and deliver it as a single, buildable blueprint. </task> <context> The plugin will run as a job step inside Orchestrator runbooks and must integrate cleanly with the existing automation estate. It is triggered by [trigger type: schedule, event, manual, or upstream runbook step] and is expected to handle [volume or scale expectation] per execution. The surrounding ecosystem includes [existing systems: ERP, CRM, Active Directory, REST APIs, ticketing, database], and the audience for your document is [developer or engineer personas]. Success looks like a colleague can install the plugin, configure it in Orchestrator, and run the runbook successfully on their first attempt. </context> <constraints> - Target Orchestrator version [version] and module structure [module or folder layout]. - Use [language/framework] and match the conventions in [reference codebase, style guide, or naming pattern]. - Expose every tunable value as a job parameter, typed and documented, including [parameter example]. - Keep secrets in [credential store] and reference them as parameters rather than hardcoding them. - Provide idempotent, retry-safe behaviour with clear logging at [verbosity level] and structured error messages. - Cover validation, timeout, failure, and rollback paths alongside the happy path. - Provide sample input and output payloads, plus a runbook usage example titled [runbook example title]. - Keep the code complete and copy-pasteable, with dependencies, versions, and any required deployment steps listed. </constraints> <format> Deliver in these sections, in order: 1. Plugin Summary — one paragraph plus a [purpose] bullet list. 2. Use Case & Trigger — when Orchestrator should call this plugin, with [scenario example]. 3. Architecture & Data Flow — a text diagram plus a description of the components involved. 4. Job Parameters — a table with columns: Name, Type, Required, Default, Description. 5. Implementation — the complete [language/framework] source, broken into clearly commented sections. 6. Error Handling & Logging — code paths, messages, and alerting behaviour. 7. Configuration & Installation — step-by-step deployment for [target environment]. 8. Testing & Verification — a checklist of manual and automated tests to confirm the runbook passes. 9. Extension Ideas — optional next features, phrased as opportunities. </format> <tone> Write in a confident, practical engineering voice: concise sentences, concrete nouns, and specific numbers instead of generalities. Keep the code readable and the explanations friendly enough for a new team member, while assuming the reader knows what Orchestrator and a runbook are. Optimise every section so it can be copied straight into a design document or a wiki page. </tone> <final_instruction> Begin now: produce the full plugin blueprint for [plugin name] exactly in the nine sections above, and end with a short checklist of the inputs you still need from me: [missing inputs]. </final_instruction>
#text