Plandalf

Prompt

Use Prompt blocks for copyable AI instructions with concrete constraints, source files, links, and verification steps.

Prompt blocks display pre-built AI prompts with one-click copy and Cursor handoff actions. Keep them concrete: name the task, product primitive, constraints, files or routes, and the verification step.

Prompts should be executable

A good prompt is closer to a small implementation brief than a slogan. Include the expected route, component, product primitive, and how the agent should verify the change.

Basic prompt

Generate clear, concise documentation.

You are a technical writing assistant. Write documentation that is clear, accurate, and concise.

  • Use second-person voice and active verbs.
  • Start procedures with a goal-oriented heading.
  • Ask clarifying questions when the reader, goal, or implementation surface is unclear.
<Prompt description="Generate clear, concise documentation.">
You are a **technical writing assistant**. Write documentation that is clear, accurate, and concise.

- Use second-person voice and active verbs.
- Start procedures with a goal-oriented heading.
- Ask clarifying questions when the reader, goal, or implementation surface is unclear.
</Prompt>

Prompt with multiple properties

Generate clear, concise documentation.

You are a technical writing assistant. Write documentation that is clear, accurate, and concise.

  • Use second-person voice and active verbs.
  • Start procedures with a goal-oriented heading.
  • Before writing, ask clarifying questions about the end users, their goals, and their needs.
<Prompt
  description="Generate **clear**, *concise* documentation."
  icon="paperclip"
  iconType="solid"
  actions={["copy", "cursor"]}
>
You are a **technical writing assistant**. Write documentation that is clear, accurate, and concise.

- Use second-person voice and active verbs.
- Start procedures with a goal-oriented heading.
- Before writing, ask clarifying questions about the end users, their goals, and their needs.
</Prompt>

Implementation prompt

Add a Plandalf checkout button

Use this when asking an agent to implement a first checkout action.

Add a Plandalf checkout button to an existing sales page.

  • Use the browser SDK.
  • Open offer pro-plan in a modal.
  • Listen for checkout completion.
  • Do not expose private API keys in browser code.
  • Link to /docs/offers/overview when explaining Offers.
<Prompt title="Add a Plandalf checkout button" actions={["copy", "cursor"]}>
Add a Plandalf checkout button to an existing sales page.

- Use the browser SDK.
- Open offer `pro-plan` in a modal.
- Do not expose private API keys in browser code.
</Prompt>

Docs-review prompt

Use prompts at the end of docs pages when the next action is naturally agent-assisted.

Review an API integration

Review my Plandalf API integration for production readiness.

  • Confirm bearer credentials stay on the server.
  • Check that GET /api/users/me succeeds before catalog or checkout calls.
  • Verify request examples use Accept: application/json.
  • Compare my field names with /docs/api/authentication and /docs/api/catalog.
  • Return a short list of risks and the smallest fixes.

Prompt structure

  1. Name the outcome

    Start with the task the agent should complete, not background context.

  2. Add constraints

    Include secrets, supported routes, browser/server boundaries, and product vocabulary.

  3. Point at sources

    Link to the docs page, route, component, or API endpoint that should be treated as truth.

  4. Ask for verification

    Tell the agent what command, browser route, or behavior proves the task works.

Properties

descriptionstringrequired

The text displayed in the prompt card. Supports inline Markdown formatting.

childrenstringrequired

The prompt content. This is the text copied to the clipboard or opened in Cursor.

actionsarraydefault: ["copy"]

Available actions. Valid values are copy and cursor.

iconstring

Icon to display beside the prompt. Supports the shared docs icon layer.

iconTypestring

Icon style metadata for icon libraries that support variants.

Plandalf extensions

titlestring

Prompt heading. When omitted, description becomes the heading.

copyLabelstringdefault: Copy prompt

Replaces the copy button label.

cursorLabelstringdefault: Open in Cursor

Replaces the Cursor handoff button label.

class | classNamestring

Optional utility classes for local spacing or sizing.

Authoring rules

  • Use prompts only when the reader can take a concrete next action.
  • Include Plandalf terms such as Offer, Timer, checkout, webhook, or API only when the prompt also explains the implementation boundary.
  • Do not put hidden requirements only inside a prompt. Required setup belongs in visible prose or steps first.
  • Keep prompts copyable as plain text; avoid relying on layout-only context.
Visibility Separate human and agent context.
Views Switch reader context.
Prompt and disclosure guide See progressive docs patterns.

Feature detail