@jupyter-ai/acp-client 0.0.1

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Project Jupyter
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,238 @@
+# jupyter_ai_acp_client
+
+[![Github Actions Status](https://github.com/jupyter-ai-contrib/jupyter-ai-acp-client/workflows/Build/badge.svg)](https://github.com/jupyter-ai-contrib/jupyter-ai-acp-client/actions/workflows/build.yml)
+
+A proof-of-concept package providing a client implementation of the Agent Client
+Protocol (ACP) in Jupyter AI v3, as well as helper classes for other developers
+to use when custom AI personas wrapping ACP agents.
+
+This package provides a default ACP client implementation as `JaiAcpClient`.
+This client provides a `prompt_and_reply()` method which calls the ACP server
+and streams the reply back to the chat. In addition, it provides file read, file
+write, and terminal use capabilities.
+
+This package also provides a default `BaseAcpPersona` class which can be easily
+extended to add ACP agents as AI personas in JupyterLab. This base class takes
+an additional `executable` argument which starts the ACP agent server. This
+package also provides a default ACP client implementation as `JaiAcpClient`.
+
+- `BaseAcpPersona` automatically creates new subprocesses for the ACP agent and
+  client when needed. These are stored as class attributes, so all instances of
+  the same ACP persona share a common ACP agent subprocess.
+
+- Since `BaseAcpPersona` inherits from `BasePersona`, subclasses can be provided
+  simply as entry points to become available for use in Jupyter AI. (see
+  [documentation](https://jupyter-ai.readthedocs.io/en/v3/developers/entry_points_api/personas_group.html))
+
+- Personas based on ACP now just need to derive from `BaseAcpPersona` and define
+  the persona name, the persona avatar, and the `executable` starting the ACP
+  agent server.
+
+For example, the `@Claude-ACP` persona is defined in `claude.py` using less than
+20 lines of code:
+
+```py
+class ClaudeAcpPersona(BaseAcpPersona):
+    def __init__(self, *args, **kwargs):
+        executable = ["claude-code-acp"]
+        super().__init__(*args, executable=executable, **kwargs)
+
+    @property
+    def defaults(self) -> PersonaDefaults:
+        avatar_path = str(os.path.abspath(
+            os.path.join(os.path.dirname(__file__), "..", "static", "claude.svg")
+        ))
+
+        return PersonaDefaults(
+            name="Claude-ACP",
+            description="Claude Code as an ACP agent persona.",
+            avatar_path=avatar_path,
+            system_prompt="unused"
+        )
+```
+
+Currently, this package provides 2 personas: `@Test-ACP` and `@Claude-ACP`.
+Note that `@Claude-ACP` requires the `claude-code-acp` executable to appear.
+This can be installed via:
+
+```
+npm install -g @zed-industries/claude-code-acp
+```
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+- `jupyter-ai-persona-manager>=0.0.5`
+- `agent_client_protocol`
+- Optional: `claude-code-acp`
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install jupyter_ai_acp_client
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jupyter_ai_acp_client
+```
+
+## Troubleshoot
+
+If you are seeing the frontend extension, but it is not working, check
+that the server extension is enabled:
+
+```bash
+jupyter server extension list
+```
+
+If the server extension is installed and enabled, but you are not seeing
+the frontend extension, check the frontend extension is installed:
+
+```bash
+jupyter labextension list
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the jupyter_ai_acp_client directory
+
+# Set up a virtual environment and install package in development mode
+python -m venv .venv
+source .venv/bin/activate
+pip install --editable ".[dev,test]"
+
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Server extension must be manually installed in develop mode
+jupyter server extension enable jupyter_ai_acp_client
+
+# Rebuild extension Typescript source after making changes
+# IMPORTANT: Unlike the steps above which are performed only once, do this step
+# every time you make a change.
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+# Server extension must be manually disabled in develop mode
+jupyter server extension disable jupyter_ai_acp_client
+pip uninstall jupyter_ai_acp_client
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `@jupyter-ai/acp-client` within that folder.
+
+### Testing the extension
+
+#### Server tests
+
+This extension is using [Pytest](https://docs.pytest.org/) for Python code testing.
+
+Install test dependencies (needed only once):
+
+```sh
+pip install -e ".[test]"
+# Each time you install the Python package, you need to restore the front-end extension link
+jupyter labextension develop . --overwrite
+```
+
+To execute them, run:
+
+```sh
+pytest -vv -r ap --cov jupyter_ai_acp_client
+```
+
+#### Frontend tests
+
+This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
+
+To execute them, execute:
+
+```sh
+jlpm
+jlpm test
+```
+
+#### Integration tests
+
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
+More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
+
+More information are provided within the [ui-tests](./ui-tests/README.md) README.
+
+## AI Coding Assistant Support
+
+This project includes an `AGENTS.md` file with coding standards and best practices for JupyterLab extension development. The file follows the [AGENTS.md standard](https://agents.md) for cross-tool compatibility.
+
+### Compatible AI Tools
+
+`AGENTS.md` works with AI coding assistants that support the standard, including Cursor, GitHub Copilot, Windsurf, Aider, and others. For a current list of compatible tools, see [the AGENTS.md standard](https://agents.md).
+This project also includes symlinks for tool-specific compatibility:
+
+- `CLAUDE.md` → `AGENTS.md` (for Claude Code)
+
+- `GEMINI.md` → `AGENTS.md` (for Gemini Code Assist)
+
+Other conventions you might encounter:
+
+- `.cursorrules` - Cursor's YAML/JSON format (Cursor also supports AGENTS.md natively)
+- `CONVENTIONS.md` / `CONTRIBUTING.md` - For CodeConventions.ai and GitHub bots
+- Project-specific rules in JetBrains AI Assistant settings
+
+All tool-specific files should be symlinks to `AGENTS.md` as the single source of truth.
+
+### What's Included
+
+The `AGENTS.md` file provides guidance on:
+
+- Code quality rules and file-scoped validation commands
+- Naming conventions for packages, plugins, and files
+- Coding standards (TypeScript, Python)
+- Development workflow and debugging
+- Backend-frontend integration patterns (`APIHandler`, `requestAPI()`, routing)
+- Common pitfalls and how to avoid them
+
+### Customization
+
+You can edit `AGENTS.md` to add project-specific conventions or adjust guidelines to match your team's practices. The file uses plain Markdown with Do/Don't patterns and references to actual project files.
+
+**Note**: `AGENTS.md` is living documentation. Update it when you change conventions, add dependencies, or discover new patterns. Include `AGENTS.md` updates in commits that modify workflows or coding standards.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)

package/lib/index.d.ts

@@ -0,0 +1,39 @@
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { IChatCommandProvider, IInputModel, ChatCommand } from '@jupyter/chat';
+/**
+ * A command provider that provides completions for slash commands and handles
+ * slash command calls.
+ *
+ * - Slash commands are intended for "chat-level" operations that aren't
+ * specific to any persona.
+ *
+ * - Slash commands may only appear one-at-a-time, and only do something if the
+ * first word of the input specifies a slash command `/{slash-command-id}`.
+ *
+ * - Note: In v2, slash commands were reserved for specific tasks like
+ * 'generate' or 'learn'. But because tasks are handled by AI personas via agent
+ * tools in v3, slash commands in v3 are reserved for "chat-level" operations
+ * that are not specific to an AI persona.
+ */
+export declare class SlashCommandProvider implements IChatCommandProvider {
+    id: string;
+    /**
+     * Regex that matches a potential slash command. The first capturing group
+     * captures the ID of the slash command. Slash command IDs may be any
+     * combination of: `\`, `-`.
+     */
+    _regex: RegExp;
+    constructor();
+    /**
+     * Returns slash command completions for the current input.
+     */
+    listCommandCompletions(inputModel: IInputModel): Promise<ChatCommand[]>;
+    /**
+     * Returns the set of mention names that have already been @-mentioned in the
+     * input.
+     */
+    _getExistingMentions(inputModel: IInputModel): Set<string>;
+    onSubmit(inputModel: IInputModel): Promise<void>;
+}
+export declare const slashCommandPlugin: JupyterFrontEndPlugin<void>;
+export default slashCommandPlugin;

package/lib/index.js

@@ -0,0 +1,101 @@
+import { IChatCommandRegistry } from '@jupyter/chat';
+import { getAcpSlashCommands } from './request';
+const SLASH_COMMAND_PROVIDER_ID = '@jupyter-ai/acp-client:slash-command-provider';
+/**
+ * A command provider that provides completions for slash commands and handles
+ * slash command calls.
+ *
+ * - Slash commands are intended for "chat-level" operations that aren't
+ * specific to any persona.
+ *
+ * - Slash commands may only appear one-at-a-time, and only do something if the
+ * first word of the input specifies a slash command `/{slash-command-id}`.
+ *
+ * - Note: In v2, slash commands were reserved for specific tasks like
+ * 'generate' or 'learn'. But because tasks are handled by AI personas via agent
+ * tools in v3, slash commands in v3 are reserved for "chat-level" operations
+ * that are not specific to an AI persona.
+ */
+export class SlashCommandProvider {
+    constructor() {
+        this.id = SLASH_COMMAND_PROVIDER_ID;
+        /**
+         * Regex that matches a potential slash command. The first capturing group
+         * captures the ID of the slash command. Slash command IDs may be any
+         * combination of: `\`, `-`.
+         */
+        this._regex = /\/([\w-]*)/g;
+    }
+    /**
+     * Returns slash command completions for the current input.
+     */
+    async listCommandCompletions(inputModel) {
+        var _a;
+        const currentWord = inputModel.currentWord || '';
+        const chatPath = inputModel.chatContext.name;
+        const existingMentions = this._getExistingMentions(inputModel);
+        // return early if current word doesn't start with '/'.
+        if (!currentWord.startsWith('/')) {
+            return [];
+        }
+        // return early if >1 persona is mentioned in the input. we never show ACP
+        // slash command suggestions in this case.
+        if (existingMentions.size > 1) {
+            return [];
+        }
+        // otherwise, call the `/ai/acp/slash_commands` endpoint to get slash
+        // command suggestions
+        let personaMentionName = null;
+        if (existingMentions.size) {
+            personaMentionName = (_a = existingMentions.values().next().value) !== null && _a !== void 0 ? _a : null;
+        }
+        const response = await getAcpSlashCommands(chatPath, personaMentionName);
+        const commandSuggestions = [];
+        for (const cmd of response) {
+            // continue if command does not match current word
+            if (!cmd.name.startsWith(currentWord)) {
+                continue;
+            }
+            // otherwise add it as a suggestion
+            commandSuggestions.push({
+                name: cmd.name,
+                providerId: this.id,
+                description: cmd.description,
+                spaceOnAccept: true
+            });
+        }
+        return commandSuggestions;
+    }
+    /**
+     * Returns the set of mention names that have already been @-mentioned in the
+     * input.
+     */
+    _getExistingMentions(inputModel) {
+        var _a;
+        const matches = (_a = inputModel.value) === null || _a === void 0 ? void 0 : _a.matchAll(/@([\w-]*)/g);
+        const existingMentions = new Set();
+        for (const match of matches) {
+            const mention = match === null || match === void 0 ? void 0 : match[1];
+            // ignore if 1st group capturing the mention name is an empty string
+            if (!mention) {
+                continue;
+            }
+            existingMentions.add(mention);
+        }
+        return existingMentions;
+    }
+    async onSubmit(inputModel) {
+        // no-op. ACP slash commands are handled by the ACP agent
+        return;
+    }
+}
+export const slashCommandPlugin = {
+    id: SLASH_COMMAND_PROVIDER_ID,
+    description: 'Adds support for slash commands in Jupyter AI.',
+    autoStart: true,
+    requires: [IChatCommandRegistry],
+    activate: (app, registry) => {
+        registry.addProvider(new SlashCommandProvider());
+    }
+};
+export default slashCommandPlugin;

package/lib/request.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Call the server extension
+ *
+ * @param endPoint API REST end point for the extension
+ * @param init Initial values for the request
+ * @returns The response body interpreted as JSON
+ */
+export declare function requestAPI<T>(endPoint?: string, init?: RequestInit): Promise<T>;
+type AcpSlashCommand = {
+    name: string;
+    description: string;
+};
+export declare function getAcpSlashCommands(chatPath: string, personaMentionName?: string | null): Promise<AcpSlashCommand[]>;
+export {};

package/lib/request.js

@@ -0,0 +1,51 @@
+import { URLExt } from '@jupyterlab/coreutils';
+import { ServerConnection } from '@jupyterlab/services';
+/**
+ * Call the server extension
+ *
+ * @param endPoint API REST end point for the extension
+ * @param init Initial values for the request
+ * @returns The response body interpreted as JSON
+ */
+export async function requestAPI(endPoint = '', init = {}) {
+    // Make request to Jupyter API
+    const settings = ServerConnection.makeSettings();
+    const requestUrl = URLExt.join(settings.baseUrl, 'ai/acp', // our server extension's API namespace
+    endPoint);
+    let response;
+    try {
+        response = await ServerConnection.makeRequest(requestUrl, init, settings);
+    }
+    catch (error) {
+        throw new ServerConnection.NetworkError(error);
+    }
+    let data = await response.text();
+    if (data.length > 0) {
+        try {
+            data = JSON.parse(data);
+        }
+        catch (error) {
+            console.log('Not a JSON response body.', response);
+        }
+    }
+    if (!response.ok) {
+        throw new ServerConnection.ResponseError(response, data.message || data);
+    }
+    return data;
+}
+export async function getAcpSlashCommands(chatPath, personaMentionName = null) {
+    let response;
+    try {
+        if (personaMentionName === null) {
+            response = await requestAPI(`/slash_commands?chat_path=${chatPath}`);
+        }
+        else {
+            response = await requestAPI(`/slash_commands/${personaMentionName}?chat_path=${chatPath}`);
+        }
+    }
+    catch (e) {
+        console.warn('Error retrieving ACP slash commands: ', e);
+        return [];
+    }
+    return response.commands;
+}

package/package.json

@@ -0,0 +1,217 @@
+{
+    "name": "@jupyter-ai/acp-client",
+    "version": "0.0.1",
+    "description": "The ACP client for Jupyter AI, allowing for ACP agents to be used in JupyterLab",
+    "keywords": [
+        "jupyter",
+        "jupyterlab",
+        "jupyterlab-extension"
+    ],
+    "homepage": "https://github.com/jupyter-ai-contrib/jupyter-ai-acp-client",
+    "bugs": {
+        "url": "https://github.com/jupyter-ai-contrib/jupyter-ai-acp-client/issues"
+    },
+    "license": "BSD-3-Clause",
+    "author": {
+        "name": "Project Jupyter",
+        "email": "jupyter@googlegroups.com"
+    },
+    "files": [
+        "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+        "style/**/*.{css,js,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
+        "src/**/*.{ts,tsx}"
+    ],
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "style": "style/index.css",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/jupyter-ai-contrib/jupyter-ai-acp-client.git"
+    },
+    "scripts": {
+        "build": "jlpm build:lib && jlpm build:labextension:dev",
+        "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:labextension",
+        "build:labextension": "jupyter labextension build .",
+        "build:labextension:dev": "jupyter labextension build --development True .",
+        "build:lib": "tsc --sourceMap",
+        "build:lib:prod": "tsc",
+        "clean": "jlpm clean:lib",
+        "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
+        "clean:lintcache": "rimraf .eslintcache .stylelintcache",
+        "clean:labextension": "rimraf jupyter_ai_acp_client/labextension jupyter_ai_acp_client/_version.py",
+        "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+        "eslint": "jlpm eslint:check --fix",
+        "eslint:check": "eslint . --cache --ext .ts,.tsx",
+        "install:extension": "jlpm build",
+        "lint": "jlpm stylelint && jlpm prettier && jlpm eslint",
+        "lint:check": "jlpm stylelint:check && jlpm prettier:check && jlpm eslint:check",
+        "prettier": "jlpm prettier:base --write --list-different",
+        "prettier:base": "prettier \"**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}\"",
+        "prettier:check": "jlpm prettier:base --check",
+        "stylelint": "jlpm stylelint:check --fix",
+        "stylelint:check": "stylelint --cache \"style/**/*.css\"",
+        "test": "jest --coverage",
+        "watch": "run-p watch:src watch:labextension",
+        "watch:src": "tsc -w --sourceMap",
+        "watch:labextension": "jupyter labextension watch ."
+    },
+    "dependencies": {
+        "@jupyter/chat": "^0.17.0",
+        "@jupyterlab/application": "^4.0.0",
+        "@jupyterlab/coreutils": "^6.0.0",
+        "@jupyterlab/services": "^7.0.0"
+    },
+    "devDependencies": {
+        "@jupyterlab/builder": "^4.0.0",
+        "@jupyterlab/testutils": "^4.0.0",
+        "@types/jest": "^29.2.0",
+        "@types/json-schema": "^7.0.11",
+        "@types/react": "^18.0.26",
+        "@types/react-addons-linked-state-mixin": "^0.14.22",
+        "@typescript-eslint/eslint-plugin": "^6.1.0",
+        "@typescript-eslint/parser": "^6.1.0",
+        "css-loader": "^6.7.1",
+        "eslint": "^8.36.0",
+        "eslint-config-prettier": "^8.8.0",
+        "eslint-plugin-prettier": "^5.0.0",
+        "jest": "^29.2.0",
+        "mkdirp": "^1.0.3",
+        "npm-run-all2": "^7.0.1",
+        "prettier": "^3.0.0",
+        "rimraf": "^5.0.1",
+        "source-map-loader": "^1.0.2",
+        "style-loader": "^3.3.1",
+        "stylelint": "^15.10.1",
+        "stylelint-config-recommended": "^13.0.0",
+        "stylelint-config-standard": "^34.0.0",
+        "stylelint-csstree-validator": "^3.0.0",
+        "stylelint-prettier": "^4.0.0",
+        "typescript": "~5.5.4",
+        "yjs": "^13.5.0"
+    },
+    "resolutions": {
+        "lib0": "0.2.111"
+    },
+    "sideEffects": [
+        "style/*.css",
+        "style/index.js"
+    ],
+    "styleModule": "style/index.js",
+    "publishConfig": {
+        "access": "public"
+    },
+    "jupyterlab": {
+        "discovery": {
+            "server": {
+                "managers": [
+                    "pip"
+                ],
+                "base": {
+                    "name": "jupyter_ai_acp_client"
+                }
+            }
+        },
+        "extension": true,
+        "outputDir": "jupyter_ai_acp_client/labextension",
+        "sharedPackages": {
+            "@jupyter/chat": {
+                "bundled": false,
+                "singleton": true
+            }
+        }
+    },
+    "eslintIgnore": [
+        "node_modules",
+        "dist",
+        "coverage",
+        "**/*.d.ts",
+        "tests",
+        "**/__tests__",
+        "ui-tests"
+    ],
+    "eslintConfig": {
+        "extends": [
+            "eslint:recommended",
+            "plugin:@typescript-eslint/eslint-recommended",
+            "plugin:@typescript-eslint/recommended",
+            "plugin:prettier/recommended"
+        ],
+        "parser": "@typescript-eslint/parser",
+        "parserOptions": {
+            "project": "tsconfig.json",
+            "sourceType": "module"
+        },
+        "plugins": [
+            "@typescript-eslint"
+        ],
+        "rules": {
+            "@typescript-eslint/naming-convention": [
+                "error",
+                {
+                    "selector": "interface",
+                    "format": [
+                        "PascalCase"
+                    ],
+                    "custom": {
+                        "regex": "^I[A-Z]",
+                        "match": true
+                    }
+                }
+            ],
+            "@typescript-eslint/no-unused-vars": [
+                "warn",
+                {
+                    "args": "none"
+                }
+            ],
+            "@typescript-eslint/no-explicit-any": "off",
+            "@typescript-eslint/no-namespace": "off",
+            "@typescript-eslint/no-use-before-define": "off",
+            "@typescript-eslint/quotes": [
+                "error",
+                "single",
+                {
+                    "avoidEscape": true,
+                    "allowTemplateLiterals": false
+                }
+            ],
+            "curly": [
+                "error",
+                "all"
+            ],
+            "eqeqeq": "error",
+            "prefer-arrow-callback": "error"
+        }
+    },
+    "prettier": {
+        "singleQuote": true,
+        "trailingComma": "none",
+        "arrowParens": "avoid",
+        "endOfLine": "auto",
+        "overrides": [
+            {
+                "files": "package.json",
+                "options": {
+                    "tabWidth": 4
+                }
+            }
+        ]
+    },
+    "stylelint": {
+        "extends": [
+            "stylelint-config-recommended",
+            "stylelint-config-standard",
+            "stylelint-prettier/recommended"
+        ],
+        "plugins": [
+            "stylelint-csstree-validator"
+        ],
+        "rules": {
+            "csstree/validator": true,
+            "property-no-vendor-prefix": null,
+            "selector-class-pattern": "^([a-z][A-z\\d]*)(-[A-z\\d]+)*$",
+            "selector-no-vendor-prefix": null,
+            "value-no-vendor-prefix": null
+        }
+    }
+}

package/src/__tests__/jupyter_ai_acp_client.spec.ts

@@ -0,0 +1,9 @@
+/**
+ * Example of [Jest](https://jestjs.io/docs/getting-started) unit tests
+ */
+
+describe('@jupyter-ai/acp-client', () => {
+  it('should be tested', () => {
+    expect(1 + 1).toEqual(2);
+  });
+});

package/src/index.ts

@@ -0,0 +1,127 @@
+import {
+  // JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+
+import {
+  IChatCommandProvider,
+  IChatCommandRegistry,
+  IInputModel,
+  ChatCommand
+} from '@jupyter/chat';
+
+import { getAcpSlashCommands } from './request';
+
+const SLASH_COMMAND_PROVIDER_ID =
+  '@jupyter-ai/acp-client:slash-command-provider';
+
+/**
+ * A command provider that provides completions for slash commands and handles
+ * slash command calls.
+ *
+ * - Slash commands are intended for "chat-level" operations that aren't
+ * specific to any persona.
+ *
+ * - Slash commands may only appear one-at-a-time, and only do something if the
+ * first word of the input specifies a slash command `/{slash-command-id}`.
+ *
+ * - Note: In v2, slash commands were reserved for specific tasks like
+ * 'generate' or 'learn'. But because tasks are handled by AI personas via agent
+ * tools in v3, slash commands in v3 are reserved for "chat-level" operations
+ * that are not specific to an AI persona.
+ */
+export class SlashCommandProvider implements IChatCommandProvider {
+  public id: string = SLASH_COMMAND_PROVIDER_ID;
+
+  /**
+   * Regex that matches a potential slash command. The first capturing group
+   * captures the ID of the slash command. Slash command IDs may be any
+   * combination of: `\`, `-`.
+   */
+  _regex: RegExp = /\/([\w-]*)/g;
+
+  constructor() {}
+
+  /**
+   * Returns slash command completions for the current input.
+   */
+  async listCommandCompletions(
+    inputModel: IInputModel
+  ): Promise<ChatCommand[]> {
+    const currentWord = inputModel.currentWord || '';
+    const chatPath = inputModel.chatContext.name;
+    const existingMentions = this._getExistingMentions(inputModel);
+
+    // return early if current word doesn't start with '/'.
+    if (!currentWord.startsWith('/')) {
+      return [];
+    }
+
+    // return early if >1 persona is mentioned in the input. we never show ACP
+    // slash command suggestions in this case.
+    if (existingMentions.size > 1) {
+      return [];
+    }
+
+    // otherwise, call the `/ai/acp/slash_commands` endpoint to get slash
+    // command suggestions
+    let personaMentionName: string | null = null;
+    if (existingMentions.size) {
+      personaMentionName = existingMentions.values().next().value ?? null;
+    }
+    const response = await getAcpSlashCommands(chatPath, personaMentionName);
+    const commandSuggestions: ChatCommand[] = [];
+    for (const cmd of response) {
+      // continue if command does not match current word
+      if (!cmd.name.startsWith(currentWord)) {
+        continue;
+      }
+
+      // otherwise add it as a suggestion
+      commandSuggestions.push({
+        name: cmd.name,
+        providerId: this.id,
+        description: cmd.description,
+        spaceOnAccept: true
+      });
+    }
+
+    return commandSuggestions;
+  }
+
+  /**
+   * Returns the set of mention names that have already been @-mentioned in the
+   * input.
+   */
+  _getExistingMentions(inputModel: IInputModel): Set<string> {
+    const matches = inputModel.value?.matchAll(/@([\w-]*)/g);
+    const existingMentions = new Set<string>();
+    for (const match of matches) {
+      const mention = match?.[1];
+      // ignore if 1st group capturing the mention name is an empty string
+      if (!mention) {
+        continue;
+      }
+      existingMentions.add(mention);
+    }
+
+    return existingMentions;
+  }
+
+  async onSubmit(inputModel: IInputModel): Promise<void> {
+    // no-op. ACP slash commands are handled by the ACP agent
+    return;
+  }
+}
+
+export const slashCommandPlugin: JupyterFrontEndPlugin<void> = {
+  id: SLASH_COMMAND_PROVIDER_ID,
+  description: 'Adds support for slash commands in Jupyter AI.',
+  autoStart: true,
+  requires: [IChatCommandRegistry],
+  activate: (app, registry: IChatCommandRegistry) => {
+    registry.addProvider(new SlashCommandProvider());
+  }
+};
+
+export default slashCommandPlugin;

package/src/request.ts

@@ -0,0 +1,76 @@
+import { URLExt } from '@jupyterlab/coreutils';
+
+import { ServerConnection } from '@jupyterlab/services';
+
+/**
+ * Call the server extension
+ *
+ * @param endPoint API REST end point for the extension
+ * @param init Initial values for the request
+ * @returns The response body interpreted as JSON
+ */
+export async function requestAPI<T>(
+  endPoint = '',
+  init: RequestInit = {}
+): Promise<T> {
+  // Make request to Jupyter API
+  const settings = ServerConnection.makeSettings();
+  const requestUrl = URLExt.join(
+    settings.baseUrl,
+    'ai/acp', // our server extension's API namespace
+    endPoint
+  );
+
+  let response: Response;
+  try {
+    response = await ServerConnection.makeRequest(requestUrl, init, settings);
+  } catch (error) {
+    throw new ServerConnection.NetworkError(error as any);
+  }
+
+  let data: any = await response.text();
+
+  if (data.length > 0) {
+    try {
+      data = JSON.parse(data);
+    } catch (error) {
+      console.log('Not a JSON response body.', response);
+    }
+  }
+
+  if (!response.ok) {
+    throw new ServerConnection.ResponseError(response, data.message || data);
+  }
+
+  return data;
+}
+
+type AcpSlashCommand = {
+  name: string;
+  description: string;
+};
+
+type AcpSlashCommandsResponse = {
+  commands: AcpSlashCommand[];
+};
+
+export async function getAcpSlashCommands(
+  chatPath: string,
+  personaMentionName: string | null = null
+): Promise<AcpSlashCommand[]> {
+  let response: AcpSlashCommandsResponse;
+  try {
+    if (personaMentionName === null) {
+      response = await requestAPI(`/slash_commands?chat_path=${chatPath}`);
+    } else {
+      response = await requestAPI(
+        `/slash_commands/${personaMentionName}?chat_path=${chatPath}`
+      );
+    }
+  } catch (e) {
+    console.warn('Error retrieving ACP slash commands: ', e);
+    return [];
+  }
+
+  return response.commands;
+}

package/style/base.css

@@ -0,0 +1,5 @@
+/*
+    See the JupyterLab Developer Guide for useful CSS Patterns:
+
+    https://jupyterlab.readthedocs.io/en/stable/developer/css.html
+*/

package/style/index.css

@@ -0,0 +1 @@
+@import url('base.css');

package/style/index.js

@@ -0,0 +1 @@
+import './base.css';