Files
paperclip/ui/src/components/NewAgentDialog.tsx
T
Aron Prins 897cc322c7 Improve external agent invite flow (#6183)
## Thinking Path

> - Paperclip orchestrates AI agents for zero-human companies.
> - Agent creation can happen through local runtimes, managed runtimes,
and external agents that onboard through invites.
> - The old OpenClaw-oriented invite UX lived under company
settings/invites and made a gateway-specific path look like a company
access setting.
> - That hid the broader bring-your-own-agent flow and forced operators
to leave the add-agent modal when adding an external agent.
> - This pull request moves external agent invite generation into the
add-agent modal and makes the copy agent-oriented instead of
OpenClaw-only.
> - The benefit is a clearer agent-first onboarding path while company
invites stay focused on human access.

## What Changed

- Added an external-agent invite branch to the add-agent modal,
including a dedicated prompt result view with Back navigation.
- Added a shared agent onboarding prompt builder and focused modal
coverage for prompt replacement/back navigation.
- Removed the agent invite prompt UI from Company Settings and Company
Invites, leaving Company Invites focused on human access links and
invite history.
- Updated the hidden OpenClaw Gateway runtime hint to direct operators
to the add-agent invite flow instead of presenting it as a blocked
runtime card.
- Updated invite/onboarding docs, storybook coverage, and server-side
onboarding copy toward generic agent language while preserving existing
gateway compatibility.

## Verification

- `pnpm -r typecheck`
- `pnpm build`
- `FAKE_BIN="$(mktemp -d)/bin"; mkdir -p "$FAKE_BIN"; printf
'#!/bin/sh\nexit 1\n' > "$FAKE_BIN/tailscale"; chmod +x
"$FAKE_BIN/tailscale"; PATH="$FAKE_BIN:$PATH" pnpm test:run`
- `pnpm test:run` without the fake `tailscale` shim was also attempted;
it failed only in two pre-existing CLI tailnet fallback tests because
this host has a real Tailscale address (`100.125.202.3`) where those
tests expect no Tailscale.
- Focused confirmation for that host-env issue: `FAKE_BIN=...
PATH="$FAKE_BIN:$PATH" pnpm exec vitest run --project paperclipai
cli/src/__tests__/network-bind.test.ts
cli/src/__tests__/onboard.test.ts`
- Manual UI verification: served UI locally in light mode, opened
add-agent modal, generated external agent prompt, verified the generated
prompt replaces the form and Back returns to the form.

### Screenshots

![Add agent
modal](https://raw.githubusercontent.com/aronprins/paperclip/pr-assets/6183-agent-invites/.github/pr-screenshots/6183/add-agent-modal-light.png)

![External agent invite
form](https://raw.githubusercontent.com/aronprins/paperclip/pr-assets/6183-agent-invites/.github/pr-screenshots/6183/external-agent-invite-form-light.png)

![Generated onboarding prompt replacement
view](https://raw.githubusercontent.com/aronprins/paperclip/pr-assets/6183-agent-invites/.github/pr-screenshots/6183/onboarding-prompt-result-light.png)

## Risks

- Existing OpenClaw gateway compatibility remains, but operators now
discover external agent onboarding from the add-agent modal instead of
company settings.
- Agent invites still appear in the invite history table, so that page
may show agent-scoped invite rows even though it no longer creates agent
onboarding prompts.
- Low migration risk: no schema changes.

> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.

## Model Used

- OpenAI Codex, GPT-5 coding agent in Codex desktop; tool-enabled
repository, shell, browser, and GitHub workflow. Context window size was
not exposed by the runtime.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge
2026-05-23 09:09:40 -05:00

419 lines
15 KiB
TypeScript

import { useEffect, useMemo, useState } from "react";
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
import { useNavigate } from "@/lib/router";
import { useDialog } from "../context/DialogContext";
import { useCompany } from "../context/CompanyContext";
import { accessApi } from "../api/access";
import { agentsApi } from "../api/agents";
import { adaptersApi } from "../api/adapters";
import { queryKeys } from "@/lib/queryKeys";
import {
Dialog,
DialogContent,
} from "@/components/ui/dialog";
import { Button } from "@/components/ui/button";
import { Textarea } from "@/components/ui/textarea";
import {
ArrowLeft,
Bot,
Check,
MailPlus,
Settings2,
} from "lucide-react";
import { cn } from "@/lib/utils";
import { buildAgentOnboardingPrompt } from "@/lib/agent-onboarding-prompt";
import { listUIAdapters } from "../adapters";
import { isVisualAdapterChoice } from "../adapters/metadata";
import { getAdapterDisplay } from "../adapters/adapter-display-registry";
import { useDisabledAdaptersSync } from "../adapters/use-disabled-adapters";
import { useToast } from "../context/ToastContext";
/**
* Adapter types that are suitable for agent creation (excludes internal
* system adapters like "process" and "http").
*/
const SYSTEM_ADAPTER_TYPES = new Set(["process", "http"]);
type NewAgentDialogMode = "choices" | "runtime" | "invite" | "prompt";
function isAgentAdapterType(type: string): boolean {
return !SYSTEM_ADAPTER_TYPES.has(type);
}
export function NewAgentDialog() {
const { newAgentOpen, closeNewAgent, openNewIssue } = useDialog();
const { selectedCompanyId } = useCompany();
const { pushToast } = useToast();
const navigate = useNavigate();
const queryClient = useQueryClient();
const [mode, setMode] = useState<NewAgentDialogMode>("choices");
const [agentMessage, setAgentMessage] = useState("");
const [latestAgentPrompt, setLatestAgentPrompt] = useState<string | null>(null);
const [latestAgentPromptCopied, setLatestAgentPromptCopied] = useState(false);
const disabledTypes = useDisabledAdaptersSync();
function resetDialogState() {
setMode("choices");
setAgentMessage("");
setLatestAgentPrompt(null);
setLatestAgentPromptCopied(false);
}
useEffect(() => {
if (!latestAgentPromptCopied) return;
const timeout = window.setTimeout(() => {
setLatestAgentPromptCopied(false);
}, 1600);
return () => window.clearTimeout(timeout);
}, [latestAgentPromptCopied]);
// Fetch registered adapters from server (syncs disabled store + provides data)
const { data: serverAdapters } = useQuery({
queryKey: queryKeys.adapters.all,
queryFn: () => adaptersApi.list(),
staleTime: 5 * 60 * 1000,
});
// Fetch existing agents for the "Ask CEO" flow
const { data: agents } = useQuery({
queryKey: queryKeys.agents.list(selectedCompanyId!),
queryFn: () => agentsApi.list(selectedCompanyId!),
enabled: !!selectedCompanyId && newAgentOpen,
});
const ceoAgent = (agents ?? []).find((a) => a.role === "ceo");
const inviteHistoryQueryKey = queryKeys.access.invites(selectedCompanyId ?? "", "all", 5);
// Build the adapter grid from the UI registry merged with display metadata.
// This automatically includes external/plugin adapters.
const adapterGrid = useMemo(() => {
const registered = listUIAdapters()
.filter((a) =>
isAgentAdapterType(a.type) &&
!disabledTypes.has(a.type) &&
isVisualAdapterChoice(a.type)
);
// Sort: recommended first, then alphabetical
return registered
.map((a) => {
const display = getAdapterDisplay(a.type);
return {
value: a.type,
label: display.label,
desc: display.description,
icon: display.icon,
recommended: display.recommended,
comingSoon: display.comingSoon,
disabledLabel: display.disabledLabel,
};
})
.sort((a, b) => {
if (a.recommended && !b.recommended) return -1;
if (!a.recommended && b.recommended) return 1;
return a.label.localeCompare(b.label);
});
}, [disabledTypes, serverAdapters]);
function handleAskCeo() {
closeNewAgent();
openNewIssue({
assigneeAgentId: ceoAgent?.id,
title: "Create a new agent",
description: "(type in what kind of agent you want here)",
});
}
function handleAdvancedConfig() {
setMode("runtime");
}
function handleInviteExternalAgent() {
setMode("invite");
}
function handleAdvancedAdapterPick(adapterType: string) {
closeNewAgent();
resetDialogState();
navigate(`/agents/new?adapterType=${encodeURIComponent(adapterType)}`);
}
async function copyText(text: string, unavailableBody: string) {
try {
if (typeof navigator !== "undefined" && navigator.clipboard?.writeText) {
await navigator.clipboard.writeText(text);
return true;
}
} catch {
// Fall through to the unavailable message below.
}
pushToast({
title: "Clipboard unavailable",
body: unavailableBody,
tone: "warn",
});
return false;
}
const createAgentInviteMutation = useMutation({
mutationFn: () =>
accessApi.createCompanyInvite(selectedCompanyId!, {
allowedJoinTypes: "agent",
humanRole: null,
agentMessage: agentMessage.trim() || null,
}),
onSuccess: async (invite) => {
const base = window.location.origin.replace(/\/+$/, "");
const onboardingTextLink =
invite.onboardingTextUrl ??
invite.onboardingTextPath ??
`/api/invites/${invite.token}/onboarding.txt`;
const onboardingTextUrl = onboardingTextLink.startsWith("http")
? onboardingTextLink
: `${base}${onboardingTextLink}`;
let prompt: string;
try {
const manifest = await accessApi.getInviteOnboarding(invite.token);
prompt = buildAgentOnboardingPrompt({
onboardingTextUrl,
connectionCandidates:
manifest.onboarding.connectivity?.connectionCandidates ?? null,
testResolutionUrl:
manifest.onboarding.connectivity?.testResolutionEndpoint?.url ??
null,
});
} catch {
prompt = buildAgentOnboardingPrompt({
onboardingTextUrl,
connectionCandidates: null,
testResolutionUrl: null,
});
}
setLatestAgentPrompt(prompt);
setLatestAgentPromptCopied(false);
setMode("prompt");
const copied = await copyText(prompt, "Copy the agent onboarding prompt manually from the field below.");
await queryClient.invalidateQueries({ queryKey: inviteHistoryQueryKey });
pushToast({
title: "Agent invite created",
body: copied ? "Agent onboarding prompt ready below and copied to clipboard." : "Agent onboarding prompt ready below.",
tone: "success",
});
},
onError: (error) => {
pushToast({
title: "Failed to create agent invite",
body: error instanceof Error ? error.message : "Unknown error",
tone: "error",
});
},
});
return (
<Dialog
open={newAgentOpen}
onOpenChange={(open) => {
if (!open) {
resetDialogState();
closeNewAgent();
}
}}
>
<DialogContent
showCloseButton={false}
className={cn(
"max-h-[min(calc(100dvh-2rem),46rem)] p-0 gap-0 overflow-hidden flex flex-col",
mode === "invite" || mode === "prompt" ? "sm:max-w-2xl" : "sm:max-w-md",
)}
>
{/* Header */}
<div className="flex items-center justify-between px-4 py-2.5 border-b border-border">
<span className="text-sm text-muted-foreground">Add a new agent</span>
<Button
variant="ghost"
size="icon-xs"
className="text-muted-foreground"
onClick={() => {
resetDialogState();
closeNewAgent();
}}
>
<span className="text-lg leading-none">&times;</span>
</Button>
</div>
<div className="min-h-0 overflow-y-auto p-6 space-y-6">
{mode === "choices" ? (
<>
{/* Recommendation */}
<div className="text-center space-y-3">
<div className="mx-auto flex h-12 w-12 items-center justify-center rounded-full bg-accent">
<Bot className="h-6 w-6 text-foreground" />
</div>
<p className="text-sm text-muted-foreground">
Ask a leader to propose the hire, configure a runtime yourself,
or send an onboarding prompt to an external agent.
</p>
</div>
<Button className="w-full" size="lg" onClick={handleAskCeo}>
<Bot className="h-4 w-4 mr-2" />
Ask the CEO to create a new agent
</Button>
<div className="grid gap-2">
<Button variant="outline" className="w-full" onClick={handleAdvancedConfig}>
<Settings2 className="h-4 w-4 mr-2" />
Configure a runtime manually
</Button>
<div className="space-y-1">
<Button variant="outline" className="w-full" onClick={handleInviteExternalAgent}>
<MailPlus className="h-4 w-4 mr-2" />
Invite an external agent
</Button>
<p className="text-xs text-muted-foreground text-center">
(OpenClaw, Hermes, or any agent that can call the invite API.)
</p>
</div>
</div>
</>
) : mode === "runtime" ? (
<>
<div className="space-y-2">
<button
className="inline-flex items-center gap-1 text-xs text-muted-foreground hover:text-foreground transition-colors"
onClick={() => setMode("choices")}
>
<ArrowLeft className="h-3.5 w-3.5" />
Back
</button>
<p className="text-sm text-muted-foreground">
Choose the runtime Paperclip should start or resume directly.
</p>
</div>
<div className="grid grid-cols-2 gap-2">
{adapterGrid.map((opt) => (
<button
key={opt.value}
className={cn(
"flex flex-col items-center gap-1.5 rounded-md border border-border p-3 text-xs transition-colors hover:bg-accent/50 relative",
opt.comingSoon && "opacity-40 cursor-not-allowed",
)}
disabled={!!opt.comingSoon}
title={opt.comingSoon ? opt.disabledLabel : undefined}
onClick={() => {
if (!opt.comingSoon) handleAdvancedAdapterPick(opt.value);
}}
>
{opt.recommended && (
<span className="absolute -top-1.5 right-1.5 bg-green-500 text-white text-[9px] font-semibold px-1.5 py-0.5 rounded-full leading-none">
Recommended
</span>
)}
<opt.icon className="h-4 w-4" />
<span className="font-medium">{opt.label}</span>
<span className="text-muted-foreground text-[10px]">
{opt.desc}
</span>
</button>
))}
</div>
</>
) : mode === "invite" ? (
<div className="space-y-5">
<div className="space-y-2">
<button
className="inline-flex items-center gap-1 text-xs text-muted-foreground hover:text-foreground transition-colors"
onClick={() => setMode("choices")}
>
<ArrowLeft className="h-3.5 w-3.5" />
Back
</button>
<div className="space-y-1">
<h2 className="text-sm font-semibold">Invite an external agent</h2>
<p className="text-sm text-muted-foreground">
Generate a one-time onboarding prompt that any compatible agent can use to request access, wait for approval, and claim its Paperclip API key.
</p>
</div>
</div>
<label className="block space-y-2">
<span className="text-sm font-medium">Optional message for the agent</span>
<Textarea
value={agentMessage}
onChange={(event) => setAgentMessage(event.target.value)}
className="min-h-24 resize-y"
placeholder="Add onboarding context, expected role, or first instructions."
maxLength={4000}
/>
</label>
<div className="rounded-lg border border-border px-4 py-3 text-sm text-muted-foreground">
Agent invites create a join request first. A company admin still approves the request before the agent can claim its API key.
</div>
<div>
<Button
onClick={() => createAgentInviteMutation.mutate()}
disabled={!selectedCompanyId || createAgentInviteMutation.isPending}
>
{createAgentInviteMutation.isPending ? "Generating…" : "Generate onboarding prompt"}
</Button>
</div>
</div>
) : (
<div className="space-y-5">
<div className="space-y-2">
<button
className="inline-flex items-center gap-1 text-xs text-muted-foreground hover:text-foreground transition-colors"
onClick={() => setMode("invite")}
>
<ArrowLeft className="h-3.5 w-3.5" />
Back
</button>
<div className="space-y-1">
<div className="flex items-center justify-between gap-3">
<h2 className="text-sm font-semibold">Agent onboarding prompt</h2>
{latestAgentPromptCopied ? (
<div className="inline-flex items-center gap-1 text-xs font-medium text-foreground">
<Check className="h-3.5 w-3.5" />
Copied
</div>
) : null}
</div>
<p className="text-sm text-muted-foreground">
Send this prompt to the external agent that should join this company.
</p>
</div>
</div>
<Textarea
readOnly
value={latestAgentPrompt ?? ""}
className="h-[24rem] resize-y font-mono text-xs"
/>
<Button
size="sm"
variant="outline"
disabled={!latestAgentPrompt}
onClick={async () => {
if (!latestAgentPrompt) return;
const copied = await copyText(latestAgentPrompt, "Copy the agent onboarding prompt manually from the field above.");
setLatestAgentPromptCopied(copied);
}}
>
{latestAgentPromptCopied ? "Copied prompt" : "Copy prompt"}
</Button>
</div>
)}
</div>
</DialogContent>
</Dialog>
);
}