- name
SKILL.md
技能文件保留在发布者的仓库中。
在终端中粘贴复制的命令。它会把这个 SKILL.md 安装到对应的智能体中。
npx skills add w8123/EnterpriseAgentFramework --skill reachai-onboarding -a cursor -y在终端中粘贴复制的命令。它会把这个 SKILL.md 安装到对应的智能体中。
npx skills add w8123/EnterpriseAgentFramework --skill reachai-onboarding -a claude-code -y在终端中粘贴复制的命令。它会把这个 SKILL.md 安装到对应的智能体中。
npx skills add w8123/EnterpriseAgentFramework --skill reachai-onboarding -a codex -y在终端中粘贴复制的命令。它会把这个 SKILL.md 安装到对应的智能体中。
npx skills add w8123/EnterpriseAgentFramework --skill reachai-onboarding -a grok -y在 Grok Bot 聊天中发送复制的消息。Bot 会从 GitHub 获取这个 SKILL.md,并添加到你所有 Bot 共享的技能中。
Install this skill: https://github.com/w8123/EnterpriseAgentFramework/tree/HEAD/reachai-control-service/src/main/resources/ai-assist/skills/reachai-onboarding来自发布者
Treat the current business repository as the source of truth. Inspect its language, project layout, runtime version, configuration, existing controller/service boundaries, and test commands before editing. For Java inspect Maven and Spring Boot; for C# inspect .NET/ASP.NET Core projects and their authentication setup.
For a PROJECT_ONBOARDING task, the reachai_ai_coding_task_context response contains project details, domainContext.sdkArtifacts, domainContext.gatewayChecklist, and domainContext.implementationGuidance. Use those task-scoped fields wherever the instructions below refer to the onboarding manifest. Independently authenticated project-key flows may use their supplied manifest instead.
For a C# ASP.NET Core project, use references/dotnet-sdk-access.md and identify the csharp artifact by its language/packageName. Independently authenticated project-key flows may request the manifest with ?language=csharp. Follow the C# reference for backend installation, configuration, identity and capability declaration. Steps 3–6 and Spring-specific details in steps 7–8 below apply only to Java; follow the language-neutral gateway, browser, verification and reporting requirements for both languages. Do not add Maven dependencies or Spring configuration to a C# project.
For a Python FastAPI project, read references/python-sdk-access.md and select the Python artifact from the task context. Independently authenticated project-key flows may request the manifest with ?language=python. Steps 3–6 and Spring-specific details in steps 7–8 apply only to Java; retain the shared browser, gateway, verification and reporting requirements. Do not add Maven or ASP.NET dependencies to a Python application.
For a Node.js Express project, read references/node-sdk-access.md and select the Node artifact from the task context. Independently authenticated project-key flows may request the manifest with ?language=node. Use the verified Node artifact and the business system’s authenticated session and authorization; do not add Spring or ASP.NET dependencies. Shared gateway, browser, verification and reporting requirements still apply.
For a Go application, read references/go-sdk-access.md and select the Go artifact from the task context. Independently authenticated project-key flows may request the manifest with ?language=go. Install the verified source archive by a local module replacement, not by guessing a public Go module proxy or requiring a ReachAI checkout. Use the business system's authenticated session and authorization. Shared gateway, browser, verification and reporting requirements still apply.
For a PHP application (native PHP, Laravel or ThinkPHP), read references/php-sdk-access.md and select the PHP artifact from the task context. Independently authenticated project-key flows may request the manifest with ?language=php. Install the verified zip through a Composer artifact repository, not by guessing a Packagist package. PHP-FPM has no background thread: registration and heartbeat run from the CLI (cron or a supervised loop), not inside web requests. Use the business system's authenticated session and authorization. Shared gateway, browser, verification and reporting requirements still apply.
凡是写入 ReachAI 或展示给业务用户的名称、标题、描述、说明、System Prompt、节点名称、审计原因、进度和结果,默认使用清晰的简体中文。不要仅因 API、Schema 或字段名为英文就生成英文业务文案。Token、MCP、AI、Agent、Supervisor、Workflow、Tool、API、SDK 等熟知专业术语,以及 keySlug、toolName、代码、路径、枚举值、协议字段和技术标识可保留英文;必要时使用“中文名称(英文术语)”。不要翻译或改写技术标识。
Never paste, print, or commit the registry app secret. Use the environment variable named by the manifest: normally REACHAI_REGISTRY_APP_SECRET for Java, ReachAI__AppSecret for C# ASP.NET Core, and REACHAI_APP_SECRET for Python, Node, Go or PHP when directly injecting credentials. Enrollment may instead use the relevant SDK's protected credential store.
For a PROJECT_ONBOARDING task, use the connected ReachAI platform MCP. Call reachai_project_onboarding_start for an authorized registered project, then reachai_ai_coding_task_context for the returned task. The connection and task binding stay with ReachAI; do not request, print, persist, or pass a task token or activation code.
Separate project/Workflow AI Coding APIs under /api/ai-coding/projects/** and /api/workflows/**/ai-coding/** can still use the explicit project aiCodingKey when the user independently supplies one. Send it as X-ReachAI-AiCoding-Key; never put it in a URL, browser bundle, task artifact, or progress event.
Prefer minimal, reviewable changes:
reachai-spring-boot2-starter in the runnable Spring Boot application module.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.sdkArtifacts, expand {skillExtractDir} in each installCommandTemplate, and run reachai-capability-sdk before reachai-spring-boot2-starter. The cross-platform scripts/install-java-sdk.mjs downloads the declared JAR and standalone consumer POM, verifies both declared SHA-256 values, and installs them into the business system's Maven local repository. Fail if a URL or hash is absent or mismatched; do not guess another URL and do not require access to the ReachAI repository.sdkArtifacts for @reachai/embed-chat, extract this Skill zip anywhere, then run the expanded installCommandTemplate from the business frontend directory that contains package.json. The bundled scripts/install-embed-chat.mjs verifies integritySha256, copies the tgz to the stable repo-local vendor/reachai/ directory, replaces the exact installed package directory, and records .reachai-artifact-sha256. Re-run this installer whenever a SNAPSHOT artifact checksum changes; npm install --force alone does not prove that a same-version file dependency was refreshed. reachai-doctor --mode static reports EMBED_SDK_ARTIFACT_MATCH. Never run npm install directly against a temporary Skill extract path, and never leave %TEMP%, .cursor, .trae or another machine-specific absolute path in package.json / lockfiles. Authenticated downloadUrl needs auth headers that npm cannot send, so prefer this Skill-bundled installer./repository/**, , , , or . Do not use as the business-project install path.reachai_ai_coding_task_context before scanning or editing, follow its required resources and task state, and use the connected MCP for task operations. For a standalone project-key flow, read the explicitly supplied onboarding manifest URL.application.yml, bootstrap.yml, profile-specific config, or config-center conventions.sdkArtifacts, references/java-sdk-access.md, and templates/pom-dependencies.xml. Platform artifact links are the default when no corporate Maven publication exists.templates/application-reachai.yml. Do not add any capability startup-sync setting. Replace package placeholders only when preparing the explicit SDK sync boundary. Set reachai.project.base-url to an address reachable from the ReachAI server; use localhost, 127.0.0.1, or ::1 only when ReachAI and the business service actually share the same host or network namespace.@ReachCapability / @ReachParam. Use templates/reach-capability-example.java only as a style example.POST /reachai/registry/capabilities/sync to the Starter service through the configured base-url and context-path.CODE_READY requires observed Starter registration, RUNTIME_READY requires a fresh instance heartbeat, and SDK_CALLBACK_READY requires a successful signed callback plus a received capability snapshot.CODE_READY and RUNTIME_READY are observed, call reachai_ai_coding_task_verify with the taskId and verificationKey=SDK_SYNC. It is project-scoped, requires a RUNNING task, and records a verification event.E2E_READY remains pending until ReachAI observes an authorized Embed session, user message and assistant reply created after the current task started. The session may come from the real browser SDK or from reachai-doctor --mode e2e using a business-supplied test Authorization/Cookie; doctor never mints or mocks the business identity. This proves only the authorized conversation protocol: declared Workflow capability nodes and Page Actions need their own exact-Trace / real-browser evidence in the Page Workbench. Final launcher visibility and interaction quality remain user acceptance items.protocolGuide.eventStateRules and use reachai_ai_coding_task_event for real STARTED and PROGRESS events. In WAITING_USER, PROGRESS preserves the state and open questions. Use reachai_ai_coding_task_ask for blocking ambiguities and reachai_ai_coding_task_questions to read answers; send RESUMED only after all answers. Validate against the task-context JSON Schema, then submit exactly one logical result through reachai_ai_coding_task_artifact with its declared contract, artifact key and client event ID. Do not invent success evidence.references/java-sdk-api-reference.md;
then use references/java-sdk-access.md for placement, configuration and
runtime boundaries.references/dotnet-sdk-access.md and the csharp artifact in the manifest.references/python-sdk-access.md and the python artifact in the manifest.references/node-sdk-access.md and the node artifact in the manifest.references/platform-apis.md.references/embed-chat-quick-reference.md.references/gateway-examples.md and reuse the copy-ready files under examples/gateway/.references/security.md.references/page-action-contract.md.references/angular-page-action.md.templates/.scripts/verify-reachai-access.py.node scripts/reachai-doctor.mjs --mode static --business-root <repo> and then node scripts/reachai-doctor.mjs --mode runtime --manifest-url <onboardingManifestUrl> after services are available. For /api/ai-coding/projects/**, put the project AI Coding key in the current process environment variable REACHAI_AI_CODING_KEY; never pass the key as a command-line argument. Use --ai-coding-key-env <name> only when the repository already uses another secret environment variable name.REACHAI_E2E_AUTHORIZATION or the business Cookie header in REACHAI_E2E_COOKIE, then run node scripts/reachai-doctor.mjs --mode e2e --broker-url <business-origin>/api/reachai/embed-token --embed-api-base <business-origin>/api/reachai/embed --agent-id <provisioned-key-slug> --page-key <page-key> --route <route>. Never put authorization values on the command line or into task events/artifacts. proves only the authorized broker/proxy/session/message protocol; doctor deliberately leaves and as until real intent and real browser evidence are available. It does not prove launcher visibility.End with:
REACHAI_REGISTRY_APP_SECRET still needs to be configured outside the repository.Integrate Java Spring Boot, C# ASP.NET Core, Python FastAPI, Node.js Express, Go net/http or PHP (native, Laravel, ThinkPHP) business systems with ReachAI SDK registration, instance heartbeat, gateway
---name: reachai-onboardingdescription: Integrate Java Spring Boot, C# ASP.NET Core, Python FastAPI, Node.js Express, Go net/http or PHP (native…---# reachai-control-service/src/main/resources/ai-assist/skills/reachai-onboarding/SKILL.md概览
Integrate Java Spring Boot, C# ASP.NET Core, Python FastAPI, Node.js Express, Go net/http or PHP (native, Laravel, ThinkPHP) business systems with ReachAI SDK registration, instance heartbeat, gateway/embed access, and business capability source sync. Use when asked to connect a business system to ReachAI, declare capabilities, or verify SDK onboarding from a ReachAI manifest.
常见问题
从发布者处下载 reachai-control-service/src/main/resources/ai-assist/skills/reachai-onboarding/SKILL.md,或复制路径后打开仓库。PlugMCP 只收录该技能,不托管文件。
发布者将它存放在 https://github.com/w8123/EnterpriseAgentFramework。
Claude、Cursor、Codex 和 Grok Build 可以读取你从发布者仓库添加的 SKILL.md。在聊天中发送技能的 GitHub 文件夹链接,Grok Bot 就会安装它。
/maven/**/repository/maven/**/api/embed/sdk/npm/**cd ai-admin-front && npm run build:sdkgatewayChecklist object list on the onboarding manifest (id, description, required, verificationHint, failureImpact). See references/java-sdk-access.md.PROJECT_ONBOARDING task may explicitly trigger an audited sync by calling reachai_ai_coding_task_verify with its taskId and verificationKey=SDK_SYNC. Console users trigger SDK sync from the project's 业务能力 → 接入与变更. Restrict both paths to business-owned packages and exclude framework, platform, third-party, starter, and shared infrastructure controllers.X-ReachAI-Invocation-Token, X-ReachAI-Trace-Id, X-ReachAI-Run-Id, and the business identity headers required by the service.reachai.project.base-url points to a gateway or ingress, route /reachai/registry/** to the business service that contains reachai-spring-boot2-starter. Preserve X-ReachAI-App-Key, X-ReachAI-Timestamp, X-ReachAI-Nonce, and X-ReachAI-Signature.POST /reachai/registry/capabilities/sync bypass normal business login/JWT filters and CSRF so the request reaches the Starter controller. Apply the equivalent exclusion for Spring Security, Sa-Token, Shiro, or custom interceptors. Do not remove authentication from the endpoint: the Starter must still validate the ReachAI registry signature and return 401 for invalid requests./api/reachai/embed-token.ReachAiEmbedTokenClient. Business code maps the current authenticated user to ReachAiEmbedPrincipal and forwards the SDK-owned page identity; the client owns project signing, transport, and wrapped data.token parsing./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./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.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.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./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.domainContext.implementationGuidance.projectCopilotKeySlug as the front-end agentId. Verify the project Agent is available before browser acceptance; report any missing provisioning. Do not request or embed a project-level AI Coding key.manifest.agentProvisioning.provisionAgentUrl remains available to an AI coding tool, local shell, or server-side integration. It reuses an existing ACTIVE config and initializes defaults only when no config exists. An unpublished draft without an ACTIVE config returns 409: read and review the draft through Agent AI Coding instead of overwriting or automatically publishing it. After a timeout or failed publication, read current state before any retry; identity creation, config save and publication are separate steps. It does not create a placeholder Workflow.manifest.agentSupervisor.endpoints.skillPackageUrl and follow the agent-ai-coding Skill. Use only the project-key endpoints in that manifest; never call console /api/agents/** or /api/skills/** with an AI Coding key.manifest.agentSupervisor.endpoints.workflowToolAttachUrlTemplate; the attach operation publishes the next Agent config version containing that Workflow-as-Tool.replaceWorkflowId; ReachAI removes only that entry and preserves every other Workflow. Never infer replacement from pageKey, name, or display order.PAGE_ASSISTANT for page behavior and a read-only GENERAL Workflow for the API chain. Agent risk is declared per attached Workflow, not per branch inside one mixed graph.agentId or agentKeySlug plus its baseRevision with workflowId. Do not omit the target or reuse a Workflow revision. On AGENT_DRAFT_CHANGED, re-read and review changes instead of blindly retrying; read Agent context again after success.aiCodingKey to the business front end.appSecret into browser code.manifest.agentProvisioning.provisionAgentUrl from browser runtime code. Use the already provisioned bare JSON agent.keySlug as agentId (not data.agent.keySlug).@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.projectCode, agentId, and a tokenProvider that calls the business gateway token broker. Use the already provisioned page copilot Agent keySlug for agentId.pageKey, pageInstanceId, route, and origin from the @reachai/embed-chat tokenProvider context and forward them unchanged through the business token broker. The SDK reuses the same Page Bridge identity for Chat Session creation and page actions.createEafPageBridge({ onNavigate }) adapter. Validate the requested target against the business route registry, use the normal router to navigate, then call chat.rebindPage({ bridge, page }) from the target page only after its actions are registered. Do not register or hard-code the reserved navigation action key, session id, or navigation request id; the public SDK owns those details.pageInstanceId in the token provider or business broker. A replacement UUID may make token exchange pass while causing Chat Session or Page Action identity mismatch.@reachai/embed-chat/style.css, mount one visible global launcher, and keep the SDK's visible-first Token state: Token Broker pending/failure must remain visible and retryable instead of being replaced by a business-side hidden failure./api/reachai/embed/**, /api/embed/chat/sessions, and message APIs.POST /api/embed/chat/sessions/{sessionId}/messages or the /messages/stream variant with body { "message": "..." }.{ "content": "..." }, { "text": "..." }, or { "question": "..." }; map any business UI field to message at the ReachAI API boundary.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.message.completed; there is no done event.references/platform-apis.md for ApiResult vs bare JSON response shapes and apiBase rules.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.references/page-action-contract.md. For Angular, reuse references/angular-page-action.md and templates/angular/ rather than inventing a second bridge protocol.powershell -File scripts/reachai-page-actions.ps1 -Mode scaffold-angular -FrontendRoot <frontend> -PageKey <pageKey>.
Adapt the generated registry example to the page's real component methods. Scaffolding is not runtime verification.powershell -File scripts/reachai-page-actions.ps1 -Mode verify-static -FrontendRoot <frontend> -PageKey <pageKey> -ActionKeys <keys>;
on other systems inspect the same source registrations with available search tools instead.
A static PASS proves only source alignment; use an authenticated browser and a fresh Embed session before reporting runtime PASS. Use only an existing authorized business-system test session or account supplied outside ReachAI. If none is available, keep browserVerification null and report browser acceptance as NOT RUN; never fabricate evidence or place login credentials in task artifacts.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.reachai_business_system_sdk_access_check with the project ID for a platform check, or explain why a live check cannot run. In an independently authenticated manifest flow, the manifest's sdkAccessCheckUrl remains available.EMBED_CONVERSATION_E2E=PASSWORKFLOW_CAPABILITY_E2EPAGE_ACTION_BROWSER_E2EPENDINGscripts/set-reachai-registry-secret.ps1 optionally stores a hidden-input secret in the current user's environment without printing it; start a new terminal/process before launching the business service. On other systems, use the business system's secret manager or protected runtime environment without printing or committing the value.scripts/reachai-page-actions.ps1.