reachai-onboarding

name

reachai-onboarding

description

Integrate Java business systems with ReachAI SDK registration, SDK instance heartbeat, gateway/embed access, and optional API Management handoff. Use when asked to connect a Spring Boot service to ReachAI, add reachai-capability-sdk or reachai-spring-boot2-starter, configure reachai.registry/reachai.project/reachai.capability, prepare @ReachCapability metadata for later manual SDK sync, or verify SDK onboarding from a ReachAI manifest.

ReachAI Onboarding

Operating Rules

Treat the current business repository as the source of truth. Inspect its Maven modules, Java version, Spring Boot version, configuration files, existing controller/service boundaries, and test commands before editing.

Never paste, print, or commit the registry app secret. Use the environment variable named by the manifest, normally REACHAI_REGISTRY_APP_SECRET.

Platform AI Coding project APIs under /api/ai-coding/projects/** use the project aiCodingKey, not platform Bearer login. Send it as X-ReachAI-AiCoding-Key; do not add aiCodingKey to URLs generated from the platform prompt. Manifests do not echo the raw key in returned URLs; call returned platform URLs with the same header.

Prefer minimal, reviewable changes:

• Add ReachAI dependencies only to the modules that need them.
• Put reachai-spring-boot2-starter in the runnable Spring Boot application module.
• Put reachai-capability-sdk in modules that declare @ReachCapability methods or DTO field metadata.
• @ReachCapability is method-level, @ReachParam is parameter/field-level, and @ReachOutput is field-only on response DTO fields. Do not put @ReachOutput on methods.
• Do not use the ReachAI platform base URL as a Maven repository, npm registry, or SDK file server. The platform onboarding URLs are only for the manifest, skill package, access-session reporting, and self-check APIs.
• Do not invent dependency download paths such as /repository/**, /maven/**, /repository/maven/**, /api/embed/sdk, or /npm/**. If Java or front-end artifacts cannot be resolved from the business repo's existing repositories, a corporate artifact repository, or the user's local Maven/npm cache, stop and report the missing artifact source.
• Avoid changing unrelated business logic, package structure, formatting, or dependency versions.
• SDK onboarding must not scan or sync business APIs automatically. SDK interface scan/sync is manually triggered from ReachAI API Management（API 管理）after onboarding；中文产品口径是“API 管理手动触发 SDK 同步”。 If you prepare scan boundaries for that later manual sync, restrict ReachAI to business-owned packages and never include framework, platform, third-party, starter, or shared infrastructure controllers as business APIs.

Workflow

1. Read the ReachAI onboarding manifest URL from the user prompt.
2. Download this skill package if it is not already installed, then read the reference files only as needed.
3. Detect the project layout:
   • Maven root and child modules.
   • Java source level.
   • Spring Boot version.
   • Runnable application module.
   • Business-owned Java base packages from application classes, controllers, services, and module names, only as the future API Management manual SDK sync boundary.
   • Framework/platform packages that should be excluded if API Management manual SDK sync is later used.
   • Existing application.yml, bootstrap.yml, profile-specific config, or config-center conventions.
4. Add dependencies using references/java-sdk-access.md and templates/pom-dependencies.xml.
5. Add configuration using templates/application-reachai.yml. Do not add any capability startup-sync setting. Replace package placeholders only when preparing the later API Management manual SDK sync boundary.
6. Do not scan or sync APIs during SDK onboarding. Only when the user explicitly asks to prepare API metadata, select one or two low-risk query-style business methods and annotate them with @ReachCapability / @ReachParam. Use templates/reach-capability-example.java only as a style example.
7. Inspect the business gateway boundary before declaring onboarding complete:
   • Spring Cloud Gateway, Nginx, backend-for-frontend, or front-end dev proxy configuration.
   • Existing authentication headers and current-user extraction.
   • Whether a server-side token broker already exists.
8. Add or update the gateway route/token broker:
   • Route ReachAI capability traffic to the business service and preserve X-ReachAI-Invocation-Token, X-ReachAI-Trace-Id, X-ReachAI-Run-Id, and the business identity headers required by the service.
   • Expose a front-end token endpoint such as /api/reachai/embed-token.
   • Implement the token endpoint server-side so it maps the current business user to principal.externalUserId, signs the platform call with the project appKey/appSecret, and calls ReachAI POST /api/embed/token/exchange.
   • Keep /api/reachai/embed-token on the normal business login token path. It reads the current business user and exchanges that identity for a ReachAI embed token.
   • Add the gateway authentication whitelist or dedicated security chain for /api/reachai/embed/**. This path carries ReachAI embed tokens, so business OAuth/JWT filters must not validate it as a business login token; forward Authorization: Bearer <embedToken> unchanged to ReachAI.
   • In Spring Security WebFlux / OAuth2 Resource Server, permitAll() on /api/reachai/embed/** is not enough by itself: the resource server can still try to authenticate the Bearer <embedToken> before routing and return 401. Add a higher-priority SecurityWebFilterChain with securityMatcher(ServerWebExchangeMatchers.pathMatchers("/api/reachai/embed/**")) that permits all and does not enable oauth2ResourceServer() for that matcher.
   • Inspect whitelist/anonymous filters that remove or rewrite JWT headers, such as IgnoreUrlsRemoveJwtFilter, RemoveJwtFilter, RemoveRequestHeader=Authorization, or security filters that call mutate().header("Authorization", ""). Do not apply that header-clearing behavior to /api/reachai/embed/**; skipping business authentication must still preserve the embed token Authorization header.
   • If Spring Cloud Gateway proxies /api/reachai/embed/**, dedupe duplicate CORS response headers when both the gateway and ReachAI write them. A typical route filter is DedupeResponseHeader=Access-Control-Allow-Origin Access-Control-Allow-Credentials, RETAIN_FIRST.
   • Before front-end embed work, call manifest.agentProvisioning.provisionAgentUrl from the AI coding tool, local shell, or server-side integration step when present. Send X-ReachAI-AiCoding-Key with the same project key used to fetch the manifest. It is idempotent and creates or reuses the project PAGE_COPILOT Agent plus its default Workflow binding.
   • Use the provisioning response agent.keySlug as the front-end agentId; write only that key slug into browser configuration. Fall back to manifest.agentProvisioning.defaultKeySlug, manifest.agentWorkflow.globalAgentKeySlug, or manifest.embed.defaultAgentKeySlug only when the provisioning API is unavailable.
   • If provisioning returns defaultWorkflow.id or the manifest exposes agentWorkflow.workflowAiCoding, draw and save the default Workflow through Workflow AI Coding, validate it, then call POST /api/workflows/{workflowId}/ai-coding/publish once to create the initial ACTIVE version. Do not leave the default Workflow only as an unpublished draft.
   • Do not call provisioning from browser runtime code, and do not expose aiCodingKey to the business front end.
   • Do not ask the business user to manually create, choose, or configure the page copilot Agent during SDK onboarding.
   • Treat that Agent as the single embedded page copilot entry. Page-specific behavior is selected later by pageKey through Agent/Workflow bindings, not by rendering one button per workflow.
   • Never move appSecret into browser code.
9. Add or update the business front-end integration:
   • Add the ReachAI chat/embed entry in a real business page or shared shell, not only in documentation.
   • Do not call manifest.agentProvisioning.provisionAgentUrl from browser runtime code. Use the already provisioned bare JSON agent.keySlug as agentId (not data.agent.keySlug).
   • Use @reachai/embed-chat for browser embedding when available. Configure apiBase as the ReachAI platform origin by default; if the browser uses a gateway prefix, set embedPathPrefix such as /api/reachai/embed, or set apiBase directly to a recognized embed root such as /api/reachai/embed.
   • Configure projectCode, agentId, and a tokenProvider that calls the business gateway token broker. Use the already provisioned page copilot Agent keySlug for agentId.
   • Pass the same stable pageKey, pageInstanceId, route, and origin through token broker, createEafChat({ page }), and page actions.
   • Do not reuse the business login token for ReachAI chat session or message calls. Use the broker-returned short-lived embed token for /api/reachai/embed/**, /api/embed/chat/sessions, and message APIs.
   • Chat message calls must use POST /api/embed/chat/sessions/{sessionId}/messages or the /messages/stream variant with body { "message": "..." }.
   • Do not send ReachAI chat requests as { "content": "..." }, { "text": "..." }, or { "question": "..." }; map any business UI field to message at the ReachAI API boundary.
   • Chat responses are wrapped ApiResult objects. Top-level code/message describe transport status only; never render top-level message: "success" as the assistant reply. Render data.answer first, with old-shape fallback only under data.reply, data.message, or data.content.
   • Embed SSE ends with message.completed; there is no done event.
   • See references/platform-apis.md for ApiResult vs bare JSON response shapes and apiBase rules.
   • Treat data.metadata.pageActionQueue as the preferred UI/Page Action queue. Treat data.uiRequest and data.uiRequest.extension.pageActionRequest as compatible single-action instructions. Execute them through the page bridge and report each request id back to /api/embed/chat/sessions/{sessionId}/page-actions/{requestId}/result; do not only render data.answer.
   • Cache embed tokens only until before their expiresIn boundary. If a session or message request returns embed token is expired, clear the cached embed token, call the broker again, and retry once.
10. Run the smallest meaningful verification commands for the touched backend, gateway, and front-end modules.
11. Call the manifest's sdkAccessCheckUrl only after local compile/config succeeds, including gatewayBaseUrl and embedTokenPath, or explain why a live check cannot run.

• Interpret CODE_READY, RUNTIME_READY, and E2E_READY separately when they are returned. CODE_READY can pass while RUNTIME_READY or E2E_READY remains WARN because the business service is not running with REACHAI_REGISTRY_APP_SECRET, SDK heartbeat has not arrived, optional API Management manual sync has not run, or no real embed/API invocation was selected.

12. If the prompt or manifest provides an access session URL under /api/ai-coding/projects/{projectId}/access-sessions/..., report progress after each major step. Use step keys such as project-manifest, backend-sdk, reachai-config, api-management-handoff, gateway-route, embed-token-broker, gateway-whitelist, frontend-embed, connectivity-check, and handoff-summary.
13. Report changed files, commands run, results, API Management handoff status, optional scan package choices, gateway route/token broker status, front-end integration status, and manual secrets still required.

References

• For dependency and Java/Spring guidance, read references/java-sdk-access.md.
• For platform API contracts, read references/platform-apis.md.
• For credential handling and prompt safety, read references/security.md.
• For ready-to-copy snippets, use files under templates/.
• For an optional local verification helper, run scripts/verify-reachai-access.py.

Output Contract

End with:

• Files changed.
• Dependency/configuration summary.
• Gateway route and embed token broker summary.
• Front-end embed/chat integration summary.
• API Management handoff status and any optional capability annotations prepared.
• Verification commands and results.
• Whether REACHAI_REGISTRY_APP_SECRET still needs to be configured outside the repository.
• Whether access session progress was reported to /api/ai-coding/.../access-sessions/....