diff --git a/en/docs/assets/img/develop/mi-for-vscode/open-ai-panel.png b/en/docs/assets/img/develop/mi-for-vscode/open-ai-panel.png index 8b0c130f9..a68b6189e 100644 Binary files a/en/docs/assets/img/develop/mi-for-vscode/open-ai-panel.png and b/en/docs/assets/img/develop/mi-for-vscode/open-ai-panel.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/sign-in-to-copilot.png b/en/docs/assets/img/develop/mi-for-vscode/sign-in-to-copilot.png index cb486ee6a..6f0c89a5d 100644 Binary files a/en/docs/assets/img/develop/mi-for-vscode/sign-in-to-copilot.png and b/en/docs/assets/img/develop/mi-for-vscode/sign-in-to-copilot.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/adaptive-thinking-setting.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/adaptive-thinking-setting.png new file mode 100644 index 000000000..d661c97d2 Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/adaptive-thinking-setting.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/ask-mode-add-to-project.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/ask-mode-add-to-project.png new file mode 100644 index 000000000..9efcad04b Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/ask-mode-add-to-project.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/attachments.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/attachments.png new file mode 100644 index 000000000..4bcf1bdc7 Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/attachments.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/checkpoint-card.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/checkpoint-card.png new file mode 100644 index 000000000..2df3116cc Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/checkpoint-card.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/edit-mode-checkpoint.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/edit-mode-checkpoint.png new file mode 100644 index 000000000..2df3116cc Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/edit-mode-checkpoint.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/edit-mode-todo-list.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/edit-mode-todo-list.png new file mode 100644 index 000000000..94266b14a Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/edit-mode-todo-list.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/first-message-walkthrough.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/first-message-walkthrough.png new file mode 100644 index 000000000..7bc57bd12 Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/first-message-walkthrough.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/mentions.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/mentions.png new file mode 100644 index 000000000..dce8a03f4 Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/mentions.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/message-checkpoint.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/message-checkpoint.png new file mode 100644 index 000000000..d9abac27c Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/message-checkpoint.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/mode-switcher.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/mode-switcher.png new file mode 100644 index 000000000..84a413d40 Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/mode-switcher.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/model-settings.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/model-settings.png new file mode 100644 index 000000000..1c5ce7b34 Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/model-settings.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/plan-approval-dialog.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/plan-approval-dialog.png new file mode 100644 index 000000000..910a85932 Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/plan-approval-dialog.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/session-switcher.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/session-switcher.png new file mode 100644 index 000000000..4308b7fa2 Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/session-switcher.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/sign-in-options.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/sign-in-options.png new file mode 100644 index 000000000..6f0c89a5d Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/sign-in-options.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/thinking-segment.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/thinking-segment.png new file mode 100644 index 000000000..1cec7c9b3 Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/thinking-segment.png differ diff --git a/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/todo-list.png b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/todo-list.png new file mode 100644 index 000000000..94266b14a Binary files /dev/null and b/en/docs/assets/img/develop/mi-for-vscode/wso2-integrator-copilot/todo-list.png differ diff --git a/en/docs/assets/img/get-started/how-to-guides/ai-code-gen/ai-code-gen-open-ai-panel.png b/en/docs/assets/img/get-started/how-to-guides/ai-code-gen/ai-code-gen-open-ai-panel.png index d77fa6448..a68b6189e 100644 Binary files a/en/docs/assets/img/get-started/how-to-guides/ai-code-gen/ai-code-gen-open-ai-panel.png and b/en/docs/assets/img/get-started/how-to-guides/ai-code-gen/ai-code-gen-open-ai-panel.png differ diff --git a/en/docs/assets/img/get-started/how-to-guides/ai-code-gen/ai-code-gen-sign-in-ai.png b/en/docs/assets/img/get-started/how-to-guides/ai-code-gen/ai-code-gen-sign-in-ai.png index 7e70953eb..6f0c89a5d 100644 Binary files a/en/docs/assets/img/get-started/how-to-guides/ai-code-gen/ai-code-gen-sign-in-ai.png and b/en/docs/assets/img/get-started/how-to-guides/ai-code-gen/ai-code-gen-sign-in-ai.png differ diff --git a/en/docs/develop/create-integration-project.md b/en/docs/develop/create-integration-project.md index abe0a3a42..ed341b9d3 100644 --- a/en/docs/develop/create-integration-project.md +++ b/en/docs/develop/create-integration-project.md @@ -81,4 +81,4 @@ Follow the below steps to create an integration project using the WSO2 Integrato Now you can start creating your integration by developing artifacts. See the [Integration Artifacts Overview]({{base_path}}/develop/creating-artifacts/creating-artifacts-overview) documentation to learn about the integration artifacts. -Additionally, you can enhance your experience by incorporating AI-powered assistance with [WSO2 Integrator: MI Copilot]({{base_path}}/develop/mi-for-vscode/mi-copilot). +Additionally, you can enhance your experience by incorporating AI-powered assistance with [WSO2 Integrator Copilot]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/overview). diff --git a/en/docs/develop/creating-unit-test-suite.md b/en/docs/develop/creating-unit-test-suite.md index 2d3bcd67a..22732ded6 100644 --- a/en/docs/develop/creating-unit-test-suite.md +++ b/en/docs/develop/creating-unit-test-suite.md @@ -188,7 +188,7 @@ For a detailed coverage report, review the JSON report generated at ` !!! Note - In order to use AI services, a MI Copilot account is required. You shall be prompted to login to MI Copilot if you are not already signed in. + AI services require a signed-in [WSO2 Integrator Copilot]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/overview) account. You will be prompted to sign in if you haven't already. ## Generate Unit Test Case using AI diff --git a/en/docs/develop/intro-integration-development.md b/en/docs/develop/intro-integration-development.md index bfbb83bb5..fbfb796be 100644 --- a/en/docs/develop/intro-integration-development.md +++ b/en/docs/develop/intro-integration-development.md @@ -33,10 +33,10 @@ MI for VS Code is the comprehensive developer tool, which you will use to dev - MI Copilot + WSO2 Integrator Copilot - Explore the capabilities of MI Copilot and learn how to integrate it into your projects. + Explore the conversational AI assistant built into MI for VS Code — Ask, Edit, and Plan modes, checkpoints, attachments, and more. diff --git a/en/docs/develop/mi-for-vscode/mi-copilot.md b/en/docs/develop/mi-for-vscode/mi-copilot.md deleted file mode 100644 index be8639d78..000000000 --- a/en/docs/develop/mi-for-vscode/mi-copilot.md +++ /dev/null @@ -1,59 +0,0 @@ -# MI Copilot - -The WSO2 Integrator: MI Copilot is an AI-powered tool that simplifies the process of creating integration scenarios. It allows you to specify integration requirements using natural language or by providing relevant files, such as OpenAPI specifications. MI Copilot generates the necessary integration artifacts, which can be seamlessly incorporated into your projects. You can iteratively refine your projects through conversational prompts, enabling the addition of features or modifications with ease. This approach supports incremental development, allowing you to build and enhance your integration projects over time. - -1. [Create a new integration project]({{base_path}}/develop/create-integration-project) or [open an existing integration project]({{base_path}}/develop/opening-projects). - -2. Click the **Open AI Panel** icon in the top-right corner of VS Code to open the MI Copilot interface. You can also type in the text box below and click **Generate** to open the MI Copilot interface. - - Open AI Panel - - !!! note - To use WSO2 MI Copilot in your integration project, you need an MI Copilot account. - - If you don’t have an account, the MI Copilot interface will display a message: **MI Copilot Account Not Found**. - - Follow these steps to create an account if you don't already have one: - - 1.Click **Sign In**. A dialog box will appear, asking if you want VS Code to open an external website. - - 2.Click **Open**. - - 3.To create an account, click **Register**. - - sign-in-to-copilot - - 4.Sign up using your email, Google account, or GitHub account. - - sign-up-to-copilot - -3. You can describe your integration scenarios in natural language in the provided text box, and the Copilot will generate the necessary integration projects, configurations, and required artifacts. - - MI Copilot - - !!! info - You can provide integration requirements as: - - - Text prompts: Describe your integration scenario in natural language. - - Files: Upload relevant files, such as OpenAPI specifications, that provide additional context for the integration. - -4. Click **Generate** or the arrow button next to the text box. - - Based on the provided input, the MI Copilot processes the data and automatically generates an integration sequence tailored to your scenario. - -5. Add artifacts to your integration project. - - Once the integration sequence and artifacts are generated, - - 1. Review the generated artifacts to ensure they align with your requirements. - 2. Click **Add to Project** to add the artifacts to your existing integration project. - -??? "Click here for examples" - - **Example 1:** Describe the integration scenario in natural language. - - text prompt - - **Example 2:** Describe the integration scenario in natural language and upload an additional file. - - file upload diff --git a/en/docs/develop/mi-for-vscode/mi-for-vscode-overview.md b/en/docs/develop/mi-for-vscode/mi-for-vscode-overview.md index 1d47a8d80..40441fa25 100644 --- a/en/docs/develop/mi-for-vscode/mi-for-vscode-overview.md +++ b/en/docs/develop/mi-for-vscode/mi-for-vscode-overview.md @@ -60,19 +60,27 @@ Shown below is the **Project Overview** of a sample integration project. project overview -## WSO2 MI Copilot +## WSO2 Integrator Copilot -WSO2 Integrator: MI Copilot is an AI-powered tool that simplifies the creation of integration scenarios. By describing your requirements in natural language or uploading relevant files, MI Copilot generates the necessary integration artifacts for seamless project integration. +WSO2 Integrator Copilot is a conversational AI assistant built into MI for VS Code. It reads your project, generates and edits integration artifacts, adds connectors, validates Synapse XML, and can even build the project and run the MI runtime — all from a chat panel in the IDE. -Clicking on the **Open AI Panel** icon located in the top right corner of VS Code will open the WSO2 MI Copilot interface. +Click the **Open AI Panel** icon in the top right corner of VS Code to open the Copilot panel. -Open AI Panel +Open the Copilot panel -You can create any integration project by entering your integration scenario in natural language into the provided text box, allowing AI to generate the necessary artifacts. +The Copilot has three modes you can pick per message: -MI Copilot +- **Ask** — read-only, for exploring and previewing suggestions. +- **Edit** — the default working mode; the Copilot implements changes directly in your project with a checkpoint you can undo. +- **Plan** — write a reviewable plan first, get your approval, then switch back to Edit to execute it. -For more information on WSO2 MI Copilot and its capabilities, see [MI Copilot]({{base_path}}/develop/mi-for-vscode/mi-copilot) documentation. +Copilot panel + +Learn more: + +- [WSO2 Integrator Copilot — Overview]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/overview) — opening the panel, signing in, and your first message. +- [Modes: Ask, Edit, and Plan]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/modes) — when to use each mode, with walkthroughs. +- [Features]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/features) — checkpoints, plan approval, attachments, sessions, model selection, and usage limits. ## Samples diff --git a/en/docs/develop/mi-for-vscode/wso2-integrator-copilot/features.md b/en/docs/develop/mi-for-vscode/wso2-integrator-copilot/features.md new file mode 100644 index 000000000..dd729609f --- /dev/null +++ b/en/docs/develop/mi-for-vscode/wso2-integrator-copilot/features.md @@ -0,0 +1,186 @@ +--- +tags: + - vscode + - extension + - copilot + - ai +--- + +# Features + +This page is a reference for the user-facing features of the Copilot panel. For how to use the three modes, see [Modes]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/modes). + +## Checkpoints and undo + +The Copilot creates two kinds of checkpoints so you can roll back changes at different granularities — a fine-grained one for each turn the Copilot edits files, and a coarse-grained one for each message you send. + +### Per-turn checkpoint — artifact changes + +Every time the Copilot adds, edits, or deletes an artifact in your project, it snapshots the previous state of the affected files. When the turn finishes, a **Checkpoint** card appears in the conversation listing the files that changed and how many lines were added or removed. + +Per-turn checkpoint card + +The card has two actions: + +- **Accept** — acknowledges the changes and dismisses the card. Files stay as they are. +- **Undo** — rolls back every file the Copilot changed in that turn. Works across multiple tool calls, file creations, edits, and deletions made in the same turn. + +Per-turn checkpoints cover any project mutation: file writes, file edits, new data mappers, connector additions, and connector removals. If you edit the same files yourself between the turn and hitting **Undo**, the Copilot detects the conflict and asks whether you want to force the rollback or keep your manual edits. + +### Per-message checkpoint — rewind project and chat + +Before each message you send, the panel snapshots both **your project state** and **the chat history**. This lets you rewind an entire multi-turn exchange back to the moment before a specific message — not just the most recent edit. + +Per-message checkpoint + +Click the rewind icon next to an earlier user message to: + +- Revert every file in your project to the state it was in when you sent that message. +- Trim the chat history so the conversation returns to that point. Messages and replies sent after it are removed. + +Reach for this when a series of follow-ups has gone down the wrong path and you want a clean reset before re-prompting, rather than undoing one turn at a time. + +!!! info + Both kinds of checkpoints are stored on disk and survive VS Code restarts. The Copilot keeps the most recent checkpoints and garbage-collects older ones automatically. + +## Plan approval + +When the Copilot finishes writing a plan in Plan mode, it presents a **Plan Approval** dialog. + +Plan approval dialog + +Your options: + +- **Approve Plan** — confirms the plan. The Copilot exits Plan mode, and you typically switch to Edit mode to execute it. +- **Request Changes** — opens a feedback box. Type what you want changed (for example, *"Don't touch the existing unit tests; I'll update them separately"*), and the Copilot revises the plan and re-asks for approval. + +The Copilot may also ask for permission to **enter** or **exit** Plan mode if it thinks the task warrants a switch. These use the same approval dialog with a different prompt. + +## Todo tracking + +For multi-step tasks, the Copilot maintains a **todo list** visible in the conversation. Each item shows its status — pending, in progress, or done — as the Copilot works through them. This gives you a live view of what's happening during longer operations. + +Todo list + +Todos are in-memory for the current turn — they're a progress indicator, not a persistent task tracker. + +## Attachments + +You can attach files and images to a message by clicking the **Attach** button in the input bar. + +Attachments + +### Supported types + +- **Text files** — `.txt`, `.md`, `.csv`, `.html`, `.js`, `.ts`, `.css`, `.json`, `.xml`, `.yaml`, and 12 other common text formats. The Copilot reads the contents as part of your message. +- **PDF** — parsed as a document (vision-based). +- **Images** — `.png`, `.jpg`, and similar. The Copilot uses vision to read diagrams, screenshots, UI mockups, and documents-as-images. + +Attachments are validated before the message is sent — if anything is unsupported or malformed, the Copilot tells you upfront instead of partially failing halfway through a generation. + +### Typical uses + +- **OpenAPI specs and JSON/XML schemas** for generating REST APIs and transformations +- **Screenshots of error dialogs** when asking the Copilot to help debug +- **Architecture diagrams** when asking the Copilot to scaffold a project from a design +- **Sample request/response payloads** when building mediations + +## @Mentions + +Type `@` in the input bar and start typing a file or folder name to mention it inline. Mentions are picked from your open project. + +File and folder @mentions + +Mentions are a quick way to point the Copilot at a specific file or directory without having to describe it. For example: + +> *Refactor `@src/main/wso2mi/artifacts/sequences/TransformOrders.xml` to use the data mapper.* + +The Copilot reads the mentioned file automatically — you don't need to attach it. + +## Sessions + +Each conversation you have with the Copilot is a **session**. Sessions are saved automatically and you can switch between them from the **session switcher** in the header. + +Session switcher + +- **New Chat** (in the header) starts a fresh session. Your current session is saved to history. +- The session switcher groups history into **Today**, **Yesterday**, **Past Week**, and **Older**. +- Session titles are derived from your first message (or a short fallback label). You can switch between sessions freely; the Copilot remembers the full history per session. + +!!! note + Sessions are append-only — you can't edit or delete individual messages. If a conversation has gone in the wrong direction, start a new session. + +## Adaptive thinking + +For complex requests, the Copilot can use **adaptive thinking** — it works through the problem before responding, and skips the step when the request is straightforward. When it does think, a collapsible *Thinking* segment appears in the conversation with the Copilot's reasoning. Expand it to see the approach, or collapse it to focus on the final answer and the changes. + +Thinking segment in the conversation + +Adaptive thinking is **on by default**. You can toggle it from the **Settings** gear in the panel header. Turn it off if you find the Copilot is overthinking — for example, deliberating on small edits where you'd rather it just make the change. + +Adaptive thinking toggle in settings + +## Shell command approvals + +In **Edit** mode, the Copilot can run shell commands — typically build, test, or project-setup commands. Commands are classified into three tiers: + +- **Auto-approved** — standard, read-only, or project-scoped commands (for example, `ls`, `mvn clean install`, `pnpm test`). These run without interruption. +- **Needs approval** — commands that write outside the project, use the network, or look unfamiliar. The Copilot pauses and asks for your approval, showing the exact command. You can approve once, approve for the rest of the session, or deny. +- **Blocked** — anything genuinely dangerous: elevated commands (`sudo`), interactive editors (`vim`, `nano`), access to sensitive paths (`~/.ssh`, `~/.aws`, `.env`), or commands that try to escape the project directory via symlinks. These are refused outright and the Copilot explains why. + +In **Ask** and **Plan** modes, only read-only shell commands are permitted. + +## Model selection + +Open **Settings** from the header and find the **Models** section to choose which Claude model the Copilot uses. + +Model settings + +Two presets are configurable: + +- **Main model** — used for the primary conversation. Options include **Claude Sonnet** (default, best balance of speed and quality) and **Claude Opus** (stronger reasoning, slower). +- **Sub-agent model** — used when the Copilot spawns a sub-agent for codebase exploration or deep documentation lookups. Options include **Claude Haiku** (default, fast) and **Claude Sonnet** (more thorough). + +You can also override with a custom model ID if your account supports a specific model. Your selection is saved locally per device. + +## Usage limits and quota + +The behaviour here depends on how you signed in — see [Sign in]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/overview/#sign-in) for the three options. + +### WSO2 Account + +- Your account includes a free usage quota that resets on a recurring schedule. +- The Copilot shows your remaining quota and reset time when you open **Settings**. +- When you run out, the panel displays a **Usage limit reached** message explaining when your quota resets. You have three options: + - **Wait** — your quota refreshes automatically at the displayed reset time. + - **Switch to Anthropic API key** — unlimited, billed to your Anthropic account. + - **Switch to AWS Bedrock** — unlimited, billed to your AWS account. + +### Anthropic API key + +- No WSO2-side quota. Usage is billed directly by Anthropic based on your key's plan. +- If your key is revoked or rate-limited, the Copilot signs you out and asks for a new key. + +### AWS Bedrock + +- No WSO2-side quota. Usage is billed through your AWS account. +- If your credentials expire (for example, a session token runs out), the Copilot signs you out and asks for new credentials. + +!!! info "AI usage and data handling" + For details on how your prompts and attached files are processed, see [AI Usage and Data Handling Guidelines]({{base_path}}/install-and-setup/setup/reference/ai-usage-and-data-handling-guidelines). + +## Long conversations + +The Copilot handles very long conversations automatically. When a session gets close to the context limit, it summarizes older messages in-place without interrupting you — you'll see a *Compacted earlier messages* segment in the conversation where the summary was written. The Copilot keeps going from there with the summarized history plus your newer messages. + +You don't need to do anything; this is entirely automatic. If you prefer a fresh slate at any point, click **New Chat** in the header. + +## Reconnecting after closing the panel + +If you close the Copilot panel or VS Code while the Copilot is working on a long task, you can reopen the panel and the Copilot will reconnect to the in-flight run. The conversation picks up where you left off, including streaming events and tool calls. If the task already finished while the panel was closed, you'll see the final results when you reopen. + +## What's next + +- **[Overview]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/overview)** — a quick introduction to the Copilot and how to sign in. +- **[Modes]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/modes)** — a walkthrough for each of the three modes. +- **[Generate integrations using AI]({{base_path}}/get-started/how-to-guides/ai-code-generation)** — a full end-to-end tutorial using the Copilot. diff --git a/en/docs/develop/mi-for-vscode/wso2-integrator-copilot/modes.md b/en/docs/develop/mi-for-vscode/wso2-integrator-copilot/modes.md new file mode 100644 index 000000000..00703b612 --- /dev/null +++ b/en/docs/develop/mi-for-vscode/wso2-integrator-copilot/modes.md @@ -0,0 +1,261 @@ +--- +tags: + - vscode + - extension + - copilot + - ai +--- + +# Modes: Ask, Edit, and Plan + +The Copilot has three modes, selectable from the pill on the left of the input bar. Each mode changes what the Copilot is allowed to do — you pick the mode that matches how much autonomy you want to give it for the task at hand. + +Mode switcher + +## Mode comparison + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 AskEdit (default)Plan
Use it whenYou want to understand an existing project, get explanations, or preview code without changes.You want the Copilot to implement something — create or edit artifacts, add connectors, build, and run.You're starting a larger task and want a written plan to review before any file is touched.
Reads filesYesYesYes
Edits filesNo — shows code blocks with an Add to Project button insteadYes — direct in-workspace edits with checkpointsOnly the plan file; no source file edits until the plan is approved and you switch back to Edit
Runs the server / buildsNoYesNo
Runs shell commandsRead-only commands onlyYes (sensitive commands require your approval)Read-only commands only
Ends turn withAny replyAny replyA question for you, or a plan approval request
+ +You can switch modes between messages. If you start in **Plan** and later approve the plan, you'll typically move to **Edit** to run it. + +--- + +## Ask mode — explore and preview + +**Ask** is read-only. The Copilot can open files, run searches, look up connector docs, and generate code snippets, but it does not automatically write to your project. If it produces code, the code appears in a code block with an **Add to Project** button — you stay in control of what goes in, and clicking it inserts the snippet into your project with a checkpoint. + +Use Ask mode to: + +- Understand how an existing integration is wired (sequences, APIs, connections) +- Preview what a mediation would look like before committing to it +- Ask "how do I…" questions without modifying the project +- Compare approaches ("should I use the `http.get` connector or a send mediator here?") + +### Walkthrough — explore an existing project + +**Scenario:** You just inherited a Synapse project and need to understand what the `OrderAPI` does before making changes. + +1. Open the Copilot panel and switch the mode pill to **Ask**. +2. Type: + + > *Walk me through what `OrderAPI` does. Which endpoints does it call, and what transformations happen along the way?* + +3. The Copilot reads the relevant files, lists the resources exposed by the API, and explains the flow in plain language. No files are modified. + +4. Ask a follow-up: + + > *Show me what a `PUT /orders/{id}` resource for this API would look like, but don't add it yet.* + +5. The Copilot replies with a Synapse XML snippet in a code block. You see an **Add to Project** button above the snippet. + + Ask mode — Add to Project button + +6. If you like it, click **Add to Project**. The Copilot inserts the snippet at the right place in your project and creates a [checkpoint]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/features/#checkpoints-and-undo) so you can undo if needed. + +!!! tip + **Add to Project** in Ask mode is a one-click way to apply a specific snippet without giving the Copilot full Edit-mode access. It's useful when you want control over exactly what lands in the project. + +--- + +## Edit mode — the default working mode + +**Edit** is the default. The Copilot can create and edit files, run the language server to validate XML, add or remove connectors (updating `pom.xml`), create data mappers, build the project, deploy the CAR, and start or stop the MI runtime. + +Every file the Copilot changes is captured on a **Checkpoint** card so you can review and undo before moving on. + +Use Edit mode to: + +- Build a new API or mediation from a prompt +- Extend an existing integration ("add a retry with exponential backoff to the payment call") +- Migrate a data mapper, generate mappings, or refactor a flow +- Build and run the project to verify it works + +### Walkthrough — build a REST API end-to-end + +**Scenario:** You want to build a REST API that fetches weather data for a city and emails the result to a recipient. + +1. Make sure you are in **Edit** mode (the default). +2. Open the Copilot panel and type: + + > *Create a REST API called `WeatherEmailService` at context `/weatherEmail`. Add a `GET /getWeather` resource with `city` and `email` query parameters. It should call OpenWeather's geolocation and current-weather endpoints, then email the weather details to the recipient. Use the HTTP and Email connectors.* + +3. (Optional) Attach the OpenAPI specifications for the weather endpoints by clicking the **Attach** button. + +4. Press **Enter**. The Copilot will: + + - **Plan out the work** internally and show a **Todo** list of what it's about to do. + + Edit mode — todo list + + - **Add the connectors** (`mi-connector-http`, `mi-connector-email`) to your `pom.xml` and trigger the download. + - **Create the API** file at `src/main/wso2mi/artifacts/apis/WeatherEmailService.xml`. + - **Create the connections** (`OpenWeather`, `EMAIL_CONN`) as local entries. + - **Validate** the generated XML against the LemMinx language server. + +5. As each tool runs, you see a **tool call indicator** in the chat (for example, *Adding HTTP connector*, *Writing WeatherEmailService.xml*, *Validating XML*). When everything finishes, a **Checkpoint** card appears listing the files changed: + + Edit mode — checkpoint card + +6. Open the **Design View** to confirm the API is wired correctly. If something's off, you can either: + + - Click **Undo** on the Checkpoint card to roll back every file the Copilot changed in that turn, then rephrase your prompt; or + - Send a follow-up like *"The email subject should include the city name — update it."* + +7. When you're happy, ask the Copilot to build and run: + + > *Build the project and start the server.* + + The Copilot runs Maven, deploys the resulting `.car`, and starts the MI runtime. When the server is up, a link to the Runtime Services panel appears in the chat so you can try your API. + +### Shell commands in Edit mode + +When the Copilot needs to run a shell command — for example, `mvn clean install` or `pnpm test` — the command goes through a safety layer: + +- **Safe commands** (typical build, test, and read-only commands) run automatically. +- **Sensitive commands** (anything touching outside the project directory, elevated commands, or unrecognized commands) pause the turn and ask you to approve. You can approve once or remember the approval for the rest of the session. +- **Blocked commands** (for example, `sudo`, interactive editors, or commands touching `~/.ssh`) are refused entirely. The Copilot explains the block and suggests an alternative. + +You can always see the full command before it runs. + +--- + +## Plan mode — structured workflow for larger tasks + +**Plan** is the right choice when a task is big enough that you want a written plan before any code changes. In Plan mode the Copilot: + +1. **Understands the task** — reads relevant files, asks clarifying questions if needed. +2. **Writes a plan** to a dedicated plan file (stored per session) covering context, approach, which files will change, reusable code, steps, and how to verify the result. +3. **Presents the plan for approval** — you review it and either approve, reject with feedback, or request changes. +4. **On approval**, you typically switch to **Edit** mode and ask the Copilot to execute the plan. + +While in Plan mode, the Copilot cannot modify source files — only the plan file itself. That's the safety guarantee: no surprise edits, no matter how long the planning conversation runs. + +### Walkthrough — plan a connector migration + +**Scenario:** Your project uses the legacy XSLT-based CSV transformation flow. You want to migrate it to use the data mapper, but you want a reviewable plan first. + +1. Switch the mode pill to **Plan**. +2. Type: + + > *I need to migrate `TransformOrdersSequence` from XSLT to the data mapper. Study the existing sequence and write a plan.* + +3. The Copilot reads `TransformOrdersSequence`, inspects the input and expected output, and may ask a clarifying question — for example: + + > *The XSLT currently drops the `internalNotes` field. Should the new data mapper also drop it, or include it?* + + Respond inline in the question dialog and the Copilot continues. + +4. When ready, the Copilot writes a plan like: + + ```markdown + # Migrate TransformOrdersSequence to Data Mapper + + ## Context + - Current implementation uses XSLT at resources/xslt/orders.xslt + - Called from TransformOrdersSequence.xml line 12 + - … + + ## Approach + - Create a new data mapper at … + - Replace the mediator call with a mediator + - … + + ## Files to change + - TransformOrdersSequence.xml (modify) + - datamapper/OrdersMapper/OrdersMapper.ts (new) + - … + + ## Steps + 1. … + + ## Verification + - … + ``` + +5. The Copilot then presents a **Plan Approval** dialog: + + Plan approval dialog + + You can: + + - **Approve Plan** — the Copilot acknowledges approval and exits Plan mode. + - **Request Changes** — type feedback (for example, *"Keep the XSLT as a fallback until we've tested the new flow in dev"*) and the Copilot updates the plan and re-asks for approval. + +6. Once the plan is approved, switch the mode pill back to **Edit** and say: + + > *Execute the plan.* + + The Copilot now implements the plan in Edit mode, with the full set of tools available. + +!!! tip "When to prefer Plan mode" + Use Plan mode when the task is ambiguous, touches many files, or is risky enough that you'd want a written record of the intent. For small, well-defined tasks, Edit mode is more direct. + +--- + +## Switching modes mid-conversation + +You can change modes between turns. A few common patterns: + +- **Ask → Edit:** Explore the project, then ask the Copilot to implement what you just discussed. +- **Edit → Plan:** Mid-task you realize the scope is larger than you thought. Switch to Plan and ask for a plan. +- **Plan → Edit:** The most common post-approval move — switch back to Edit and say *"Execute the plan."* + +The Copilot also can suggest a mode switch itself when it thinks the task warrants it. For example, if you start a very large request in Edit mode, it may reply: + +> *This is a big change that will touch several files. I recommend switching to Plan mode first so we can review a plan before editing. Would you like to switch?* + +You can accept the suggested switch from the dialog, or decline and keep going in your current mode. + +--- + +## What's next + +- **[Features]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/features)** — a detailed reference for checkpoints, plan approval, attachments, sessions, shell approvals, model settings, and usage limits. +- **[Generate integrations using AI]({{base_path}}/get-started/how-to-guides/ai-code-generation)** — a full end-to-end tutorial using the Copilot. diff --git a/en/docs/develop/mi-for-vscode/wso2-integrator-copilot/overview.md b/en/docs/develop/mi-for-vscode/wso2-integrator-copilot/overview.md new file mode 100644 index 000000000..0943bf2cf --- /dev/null +++ b/en/docs/develop/mi-for-vscode/wso2-integrator-copilot/overview.md @@ -0,0 +1,125 @@ +--- +tags: + - vscode + - extension + - copilot + - ai +--- + +# WSO2 Integrator Copilot (MI) + +WSO2 Integrator Copilot is an AI assistant built into the MI for VS Code extension. It works alongside you inside your integration project — reading your files, running validations, adding connectors, generating mediations, and even building and running the server — through a conversational chat panel. + +You can describe what you want to build in natural language, ask questions about an existing project, or hand over larger tasks and review the plan before execution. The Copilot edits files directly in your workspace, keeping everything in sync with the language server and project model. + +## What the Copilot can do + +- Generate integration artifacts (REST APIs, sequences, proxy services, inbound endpoints, scheduled tasks, message stores) from a natural-language description +- Explore and explain an existing integration project +- Add or remove connectors and configure connections (pom.xml updates, connector catalog lookup) +- Generate data mappings (TypeScript) and create new data mappers +- Build the project, deploy the `.car`, and start or stop the MI runtime +- Read server logs and help you debug failures +- Validate Synapse XML against the language server before you save +- Reference Synapse syntax and connector documentation on demand + +The Copilot works with any MI project — new or existing — and chooses the right tools for the job based on your request. + +## Open the Copilot panel + +You can open the Copilot panel in either of these ways: + +- Click the **Copilot** icon in the top-right corner of VS Code. + +Open the Copilot panel + +!!! info + The Copilot panel is a VS Code side-panel webview. You can drag it to the right, bottom, or secondary side bar like any other panel. + +## Sign in + +The first time you open the Copilot panel, you are asked to sign in. The Copilot supports three sign-in methods — you can switch between them at any time from **Settings**. + +Sign-in options + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionWho should pick thisHow it works
WSO2 Account (default)Most users. Free, no setup.Sign in with your WSO2 account (email, Google, or GitHub). A free usage quota is applied to your account and resets periodically. You are notified in the panel when your quota runs out.
Anthropic API keyUsers who have their own Anthropic account and want unlimited usage billed directly to Anthropic.Paste your Anthropic API key. All Copilot requests go directly to the Anthropic API using your key.
AWS BedrockOrganizations that run Claude through Amazon Bedrock for compliance or procurement reasons.Provide your AWS access key ID, secret access key, and region (session token optional). Requests are sent to Claude on Bedrock using cross-region inference.
+ +### Switching auth methods later + +From the Copilot panel, click the **Settings** gear in the header and click the **Sign Out** button. You can sign out and switch to any of the three methods without losing your chat history. The provider you are currently using is shown in the header as a small chip (for example, **WSO2**, **Anthropic**, or **Bedrock**). + +## Your first message + +Before you send your first message, make sure you have: + +1. [Created a new integration project]({{base_path}}/develop/create-integration-project) or [opened an existing one]({{base_path}}/develop/opening-projects). +2. Signed in with one of the three methods above. + +To start a new chat session, open the Copilot panel and type in the input at the bottom. For example: + +> *Create a REST API called `OrderAPI` at context `/orders` with a `GET /orders/{id}` resource that fetches an order from the `https://api.example.com/orders/{id}` endpoint and returns the JSON response.* + +Press **Enter**. The Copilot opens a new chat session in **Edit mode** (the default) and starts working: + +- You see the Copilot's reasoning stream in live, followed by **tool call indicators** (for example, *reading file*, *adding connector*, *writing `src/main/wso2mi/artifacts/apis/OrderAPI.xml`*). +- Files it creates or edits appear on a **Checkpoint** card at the bottom of the conversation, with **Accept** and **Undo** buttons so you can review before keeping the changes. +- When it finishes, you can ask a follow-up (for example, *"Add a `POST /orders` resource too"*) and the Copilot continues from the same context. + +First message walkthrough + +!!! tip + You can also attach files with your message — OpenAPI specifications, JSON schemas, CSVs, PDFs, or images. The Copilot uses them as additional context. See [Attachments]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/features/#attachments). + +## Anatomy of the Copilot panel + +**Header (top)** + +- **Auth provider chip** — which sign-in method you are using. +- **New Chat** — start a fresh session. Your current session is saved to history. +- **Settings gear** — open the full settings view (authentication, model selection). + +**Conversation (middle)** + +- Your messages and the Copilot's replies, including live **tool call indicators**, **code blocks**, and **Checkpoint** cards with Accept/Undo. +- Long-running tasks show a **Todo** list so you can see progress step by step. + +**Input bar (bottom)** + +- **Text input** — type your prompt. Use `@` to mention a file or folder from your project. +- **Mode switcher** — a pill on the left lets you pick between **Ask**, **Edit**, and **Plan**. See [Modes]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/modes). +- **Attach** — add files or images to your message. +- **Send** — submit the message (or press Enter). + +## Where to go next + +- **[Modes: Ask, Edit, and Plan]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/modes)** — learn when to use each mode, with hands-on walkthroughs. +- **[Features]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/features)** — checkpoints, plan approval, sessions, attachments, model selection, and more. +- **[Generate integrations using AI]({{base_path}}/get-started/how-to-guides/ai-code-generation)** — a full end-to-end tutorial that builds a weather-email integration with the Copilot. + +!!! info "AI usage and data handling" + For details on how your prompts and files are processed by the Copilot, see [AI Usage and Data Handling Guidelines]({{base_path}}/install-and-setup/setup/reference/ai-usage-and-data-handling-guidelines). diff --git a/en/docs/get-started/about-this-release.md b/en/docs/get-started/about-this-release.md index 3d4437314..b34d402a3 100644 --- a/en/docs/get-started/about-this-release.md +++ b/en/docs/get-started/about-this-release.md @@ -38,7 +38,7 @@ The following features and improvements were introduced with **WSO2 Integrator: ??? note "AI Features" - MCP tool support for agents in the AI connector - Agent memory trim and summarization support - - Agent mode in MI Copilot + - Conversational WSO2 Integrator Copilot — Ask, Edit, and Plan modes with in-workspace file edits, checkpoints, plan approval, attachments, and more. See [WSO2 Integrator Copilot]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/overview). ??? note "Connector Enhancements" - AMQP 1.0 protocol support diff --git a/en/docs/get-started/how-to-guides/ai-code-generation.md b/en/docs/get-started/how-to-guides/ai-code-generation.md index f0dd75e7d..28b34954e 100644 --- a/en/docs/get-started/how-to-guides/ai-code-generation.md +++ b/en/docs/get-started/how-to-guides/ai-code-generation.md @@ -1,7 +1,7 @@ # Generate integrations using AI Did you know that the WSO2 Integrator: MI component of WSO2 Integrator includes an AI-powered assistant to help you effortlessly generate integration flows? -In this guide, we are generating an API to retrieve weather information for a specified city and send it via email to a designated recipient. +In this guide, you'll use the [WSO2 Integrator Copilot]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/overview) to generate an API that retrieves weather information for a specified city and emails it to a designated recipient. Check out this video on YouTube to see it in action. @@ -26,48 +26,65 @@ You need Visual Studio Code (VS Code) with the open ai panel + open the Copilot panel -2. Sign in to MI Copilot via the MI extension. +2. Sign in with one of the three supported methods — **WSO2 Account** (default, free with usage quota), **Anthropic API key**, or **AWS Bedrock**. For this tutorial, signing in with your WSO2 Account is the simplest option. - sign in to mi copilot + sign in to the Copilot -### Step 3: Generate the mediation using MI Copilot + !!! info + For details on the three sign-in options, see [Sign in]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/overview/#sign-in). + +### Step 3: Describe the integration to the Copilot + +The Copilot opens a new chat session in **Edit mode** (the default). In Edit mode the Copilot acts as an agent — it reads your project, adds the connectors it needs, writes the artifacts, validates them against the language server, and captures everything on a **Checkpoint** card you can review or roll back. + +1. Make sure the mode pill in the input bar is set to **Edit**. + +2. Attach the two OpenAPI specifications that describe the geolocation and weather endpoints by clicking the **Attach** attach files button. Use [GeoLocationOAS.yaml]({{base_path}}/assets/attachments/quick-start-guide/how-to-guides/ai-code-gen/GeoLocationOAS.yaml) and [OpenWeatherOAS.yaml]({{base_path}}/assets/attachments/quick-start-guide/how-to-guides/ai-code-gen/OpenWeatherOAS.yaml). + +3. Describe the integration in a single message. For example: -1. Describe the scenario that you need to generate the integration. - ??? "Example Prompt" ``` - Generate a service to fetch weather data from a city name and email the weather details to the given email in the request. Refer to the attached OpenAPI Specifications for more details about the geolocation endpoint and weather endpoint. + Create a REST API called WeatherEmailService at context /weatherEmail with a GET /getWeather resource that accepts city and email query parameters. Use the attached OpenAPI specs to call the OpenWeather geolocation endpoint to get coordinates for the city, then call the current-weather endpoint using those coordinates, and finally email the weather details to the email address in the request. Use the HTTP and Email connectors. ``` -2. Add any supporting files that are required to generate this integration such as OpenAPI specifications, schemas, etc., by clicking on the **Add Files** attach files button. In this guide, we are using the [GeoLocationOAS.yaml]({{base_path}}/assets/attachments/quick-start-guide/how-to-guides/ai-code-gen/GeoLocationOAS.yaml) and [OpenWeatherOAS.yaml]({{base_path}}/assets/attachments/quick-start-guide/how-to-guides/ai-code-gen/OpenWeatherOAS.yaml) OpenAPI specifications. +4. Press **Enter** to send the message. You don't click a "Generate" button — the Copilot runs the whole task autonomously. -3. Click on the **Generate** button and wait for the MI copilot to generate the necessary synapse configurations to work the scenario. + As it works, the chat panel streams the agent loop in real time: - generate code + - A **todo list** appears at the top of the response showing what the Copilot has planned (for example, *add HTTP connector*, *add Email connector*, *create API*, *create connections*, *validate*). Items tick off as they complete. + - **Tool call indicators** such as *Adding HTTP connector*, *Writing WeatherEmailService.xml*, and *Validating XML* show each step. If validation fails, the Copilot reads the error and self-corrects before continuing. + - The Copilot may pause to ask a clarifying question — for example, which email subject to use — and resumes after your reply. -4. Once the configurations are generated, add them to the project using the **Add to Project** button, which is in line with the artifact name. + Copilot agent loop streaming in the chat panel - add artifacts +5. When the agent finishes, a **Checkpoint** card lists every file it created or changed. The artifacts are already in your project — open the **Design View** to confirm the API looks right. - The API will resemble the following structure once all the generated artifacts have been added. + Checkpoint card with generated artifacts - !!! Note - The generated view may differ from ours, as AI-generated designs can vary. For example, AI may create separate sequences for the Weather API calls and email operation. + If something looks off, you have two options without leaving the chat: - add artifacts + - Click **Undo** on the Checkpoint card to roll back every file the Copilot changed in that turn, then rephrase your prompt. + - Send a follow-up message — for example, *"Include the city name in the email subject"* — and the Copilot will edit the files in place and produce a new checkpoint. - ??? "WeatherEmailService API" - === "Design View" - ai-code-gen-api - + When you're happy with the result, click **Accept** on the Checkpoint card. + + !!! Note + Your generated flow may differ slightly from what's shown here — AI-generated designs can vary. For example, the Copilot may place the mediation logic in a separate sequence instead of inline. + + The generated API resembles the structure below: + + generated API + + ??? "WeatherEmailService API source" === "Source View" ```yaml @@ -118,7 +135,7 @@ You will now see the projects listed in the **Project Explorer**. ??? "Email Connection" === "Design View" http connection config - + === "Source View" ```yaml @@ -133,11 +150,11 @@ You will now see the projects listed in the **Project Explorer**. ``` - + ??? "HTTP Connection" === "Design View" http connection config - + === "Source View" ```yaml @@ -157,31 +174,44 @@ You will now see the projects listed in the **Project Explorer**. ``` !!! Note - After adding the synapse artifacts to the project, make sure to update the synapse configurations as follows, + Before running the API, update the generated configurations with real credentials: + + - Update the email connection with the credentials of the sender's email account. + - Update the `API_KEY` variable with your OpenWeather API key. + + You can ask the Copilot to open a specific file for you — for example, *"Open the Email connection so I can update the credentials."* + +### Step 4: Build and run with the Copilot + +The Copilot can build the project and start the MI runtime for you — no need to leave the chat panel. Send a follow-up message: + +``` +Build the project and start the server. +``` - - Update the email connection with the credentials of the sender’s email account. - - Update the `API_KEY` variable with the OpenWeather key obtained to retrieve the weather data. +The agent runs the Maven build, deploys the resulting `.car`, and starts the MI runtime. You'll see tool call indicators for each step (*Running build*, *Starting MI server*) and a link to the **Runtime Services** panel in the chat when the server is up. -### Step 4: Build and run +??? tip "Prefer the button?" + If you'd rather build manually, click the **Build and Run** button at the top of the editor. -1. Click on the **Build and Run** button to build and deploy the integration. + Build and Run button - build and run +Once the server is running, **Runtime Services** opens. From that panel: -2. **Runtime Services** will open after the server is up and running, and from that panel, select the API that you need to try out using the **Try It** button. +1. Select your API and click **Try It**. try out swagger -3. Click the **Try it Out** button to provide the required query parameters. +2. Click **Try it Out** to open the parameter form. try out operation -4. Provide the required parameters and click the **Execute** button to invoke the API. +3. Provide the required query parameters and click **Execute**. execute request -5. Check the response received from the server and confirm that the weather details for the specified city have been successfully sent to the email address provided as a query parameter in the API request. +4. Check the response and confirm that the weather details for the specified city were emailed to the address in the request. response -Automating complex integrations has never been easier. Why spend time doing all this manually when the WSO2 Integrator: MI Copilot can do it for you? Try it out today and save yourself hours of effort! +That's the agent loop in action — one prompt, the Copilot plans the work, adds the right connectors, writes and validates the artifacts, deploys, and starts the server. From here you can keep going: ask for new resources, request retries with backoff, switch to **Plan** mode for a reviewable change list, or explore [Modes]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/modes) and [Features]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/features) to see what else the Copilot can do. diff --git a/en/docs/reference/mediators/data-mapper-mediator.md b/en/docs/reference/mediators/data-mapper-mediator.md index 5dcae2d34..47c1dd3c8 100644 --- a/en/docs/reference/mediators/data-mapper-mediator.md +++ b/en/docs/reference/mediators/data-mapper-mediator.md @@ -203,10 +203,10 @@ The operations that the Data Mapper supports as shown below. - **match** – check whether the input match with a (JS) Regular Expression ## AI Data Mapper -The MI Copilot AI Assistant will allow you to seamlessly generate the input-output mapping. Simply load the input and output schema (of any type) to the relevant sections as shown below and click **Map**. Use the **Clear** button to clear all mappings. +The [WSO2 Integrator Copilot]({{base_path}}/develop/mi-for-vscode/wso2-integrator-copilot/overview) will allow you to seamlessly generate the input-output mapping. Simply load the input and output schema (of any type) to the relevant sections as shown below and click **Map**. Use the **Clear** button to clear all mappings. !!! info "WSO2 Account and Usage Limits" - To use this feature, you must have a WSO2 account. If you do not have one, attempting to access Copilot or the mapping feature will prompt you to create an account. If your account exceeds the usage limit, it will be refreshed after the specified time limit. + To use this feature, you must have a WSO2 account. If you do not have one, attempting to access the Copilot or the mapping feature will prompt you to create an account. If your account exceeds the usage limit, it will be refreshed after the specified time limit. !!! info "Review and Fine-tune" Since AI powers the automated mapping, it may contain errors. Always verify the accuracy of the generated mappings. To fine tune the mappings you can use the `` button and edit the TypeScript (TS) file. diff --git a/en/mkdocs.yml b/en/mkdocs.yml index 7dfa459ce..748db47af 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -207,7 +207,10 @@ nav: - WSO2 MI for VSCode: - "WSO2 Integrator: MI for VSCode Overview": develop/mi-for-vscode/mi-for-vscode-overview.md - Troubleshooting MI for VS Code: develop/mi-for-vscode/troubleshooting-mi-for-vscode.md - - MI Copilot: develop/mi-for-vscode/mi-copilot.md + - WSO2 Integrator Copilot: + - Overview: develop/mi-for-vscode/wso2-integrator-copilot/overview.md + - "Modes: Ask, Edit, and Plan": develop/mi-for-vscode/wso2-integrator-copilot/modes.md + - Features: develop/mi-for-vscode/wso2-integrator-copilot/features.md - Best Practices Guide: develop/mi-for-vscode/best-practices.md #- Publish Integrations to the API Manager: develop/working-with-service-catalog.md - Integration Projects: