/iblai-vibe-agent-lti

Mirrored from iblai/vibe · skills/agents/iblai-vibe-agent-lti/SKILL.md. This page is generated — edit it in the repository, not here.

Add the agent LTI tab -- let an LMS (Canvas, Brightspace, Blackboard, Moodle) launch the agent inside a course with LTI 1.3. Scope: mixed. The switch and the Links sub-tab belong to this agent; Keys and Tools are shared by the whole organization; Tool Endpoints are fixed for the organization. This is one tab in the agent-settings family indexed by /iblai-vibe-agent; it shares the AgentSettingsProvider wrapper with every other tab.

Links -- the switch (the agent's is_lti_accessible setting; while off, the sub-tabs stay visible but grayed out) and the agent's LTI link: Name, Target Link URI (with copy), Status and an edit action. An agent has one link: Create LTI Link shows only while there is none. A new link builds in the background -- Pending or Building with a spinner and a Refresh button, then Ready or Failed (with Retry).

Edit LTI Link -- one field, the name shown when a teacher picks this agent during deep linking. Only Ready links can be edited.

Keys -- the organization's RSA signing keys (name and public key), with Create LTI Key (name only; the key pair is generated) and an Edit / Delete menu per row.

LTI Key -- rename the key and copy its Public Key (PEM) or Public JWK. A key still used by a tool cannot be deleted.

Tools -- the organization's LMS registrations (Name, Issuer, Client ID) with Create LTI Tool and an edit action.

Create LTI Tool -- the values the LMS gives you: Name, Issuer, Client ID, Auth Login URL, Auth Token URL, Auth Audience (optional), the LMS public keys (a JWKS URL, recommended, or Raw JWKS JSON), a Signing Key from the Keys sub-tab, and Deployment IDs (one per line or comma-separated).

Tool Endpoints -- the four URLs to paste into the LMS, each with copy: Redirect URI, Login Initiations Endpoint, Deep Linking Endpoint and JWKS Endpoint. They are built from lmsDomain (Step 2).

Common setup (brand, conventions, env files, verification): see docs/skill-setup.md.

Prerequisites

• Auth set up (/iblai-vibe-auth, or vibe-starter).
• AgentSettingsProvider wraps the route (/iblai-vibe-agent §1).
• @iblai/iblai-js@^2.62.1 (resolves @iblai/web-containers 1.62.1). Check with pnpm why @iblai/web-containers.
• A real agent UUID. Ask the user; never invent one.
• An organization admin signed in: Links, Keys and Tools are admin-only, so an agent's owners and editors get 403 here.
• The organization's edX LMS host for lmsDomain. vibe-starter has it as config.legacyLmsUrl(); elsewhere ask the user, never invent one.

Step 1: Check Environment

Look for iblai.env in the project root with PLATFORM, DOMAIN, and TOKEN. If it is missing, tell the user: "You need an iblai.env with your platform configuration. Download the template and fill in your values: curl -o iblai.env https://raw.githubusercontent.com/iblai/vibe/refs/heads/main/iblai.env"

Step 2: Mount AgentLtiTab

// app/(app)/agents/[mentorId]/lti/page.tsx
"use client";

import { AgentLtiTab } from "@iblai/iblai-js/web-containers/next";
import config from "@/lib/iblai/config";

export default function AgentLtiPage() {
  return (
    <div className="flex h-full flex-col bg-white">
      <AgentLtiTab lmsDomain={config.legacyLmsUrl()} />
    </div>
  );
}

The tab reads tenantKey, mentorId and username from AgentSettingsProvider (each can be passed as a prop instead) and does its own fetching and saving. Pass lmsDomain -- the edX LMS host (learn.*), not the API base: without it the Tool Endpoints are bare paths. The JWKS endpoint uses the organization's code from the platform info; pass orgShortName to override it.

Step 3: Customize Labels (Optional)

The tab renders with the default agent-facing copy (AGENT_LTI_TAB_LABELS, localized through the SDK's i18n). Pass a partial labels object to change any string:

import { AgentLtiTab } from "@iblai/iblai-js/web-containers/next";
import config from "@/lib/iblai/config";

<AgentLtiTab
  lmsDomain={config.legacyLmsUrl()}
  labels={{
    header: { title: "LMS integration" },
    subTabs: { agentLinks: "Launch link" },
  }}
/>;

Label groups (LtiTabLabels): header (title, description), capability (the switch and its toasts), subTabs (agentLinks, keys, tools, toolEndpoints), common (shared buttons, column headings and form copy), links (the links table, status badges, refresh and retry, the link dialog), keys (the keys table, create, detail and delete dialogs), tools (the tools table and the tool dialog fields), endpoints (the four endpoint names and descriptions), and toasts.

Step 4: Use MCP Tools for Customization

get_component_info("AgentLtiTab")
get_component_info("AgentSettingsProvider")

<AgentLtiTab> Props

Import from @iblai/iblai-js/web-containers/next.

Related Exports

From @iblai/iblai-js/web-containers/next:

• AGENT_LTI_TAB_LABELS -- the default label bundle.
• AgentLtiTabProps, LtiTabLabels -- types.

How it saves

Single-item GET, PUT and DELETE exist only on the {id}/ routes. Every call needs platform_key: in the query on GET and DELETE, in the body on POST and PUT. Tools also require launch_gate. The tab asks for page_size=10, but the API forwards only the organization and the agent to the LMS, so pages follow the LMS's own defaults.

Platform data

All from @iblai/iblai-js/data-layer, with the LtiAgentLink and LtiAgentLinkStatus types. There is no iblai-api-* REST twin for LTI yet; the endpoints above are in the live schema.

Step 5: Verify

Run /iblai-vibe-ops-test before telling the user the work is ready, and give every page, control and state this skill added its own checkpoint — one Playwright test titled <ID> · … in e2e/journeys/, listed in e2e/coverage.json; pnpm e2e:coverage must pass:

1. pnpm build -- must pass with zero errors.
2. pnpm test -- vitest must pass.
3. Touch test /agents/<uuid>/lti in the browser as /iblai-vibe-ops-test says, signed in as an org admin: the switch and four sub-tabs render, and Tool Endpoints shows full https:// URLs on your LMS host; read the console; check the phone width.

Important Notes

• Keys and Tools are organization-wide: changing them here changes them for every agent. Only the link is per agent.
• Link creation is slow: it builds an LMS course in the background; wait for Ready before sharing the Target Link URI.
• Delete order: remove or re-key a tool before deleting its key.
• Shared provider: mount AgentSettingsProvider once at the layout level (/iblai-vibe-agent §1); do not wrap each tab.
• Peer deps: sonner and @iblai/iblai-web-mentor (pnpm add sonner @iblai/iblai-web-mentor).
• Brand guidelines: BRAND.md