repository·main·Indexed 25 days ago
https://github.com/opensumi/coreA framework for building AI-native IDE products across Cloud, Desktop (Electron), and Web environments. It provides tools for collaborative editing, remote service communication via backService and RemoteService patterns, UI overlay management, and a flexible icon system using Codicons and IconfontCN. The framework includes specialized utilities like GDataStore for state management in remote services and FileDecorationsService for managing file-based UI decorations.
OpenSumi provides several example projects to help you quickly build different types of IDE products:
The Collaboration Module has specific environmental requirements and functional constraints:
git pull or modifications via external software).The OpenSumi editor uses several distinct tab states and organizational structures to manage user workflows. Understanding these is key to managing editor sessions and tab behavior:
The Extension module is organized into several key services and layers to manage plugin lifecycles, command execution, and view bindings across different environments (browser, worker, and node):
Lifecycle & Management:
activation.service.ts: Manages and emits activateEvents.extension-instance-management.ts: Aggregates and queries plugin instance data.extension-management.service.ts: Provides low-level plugin management logic.extension-node.service.ts: Manages plugin contribution point activation and process lifecycle for the node layer.extension-worker.service.ts: Manages plugin contribution point activation and process lifecycle for the worker layer.extension-view.service.ts: Manages plugin contribution points for the browser view layer and handles proxy binding with worker/node layers.extension.service.ts: Provides the complete logic for plugin process activation.Execution & Environment:
extension-command-management.ts: Provides the command execution environment for the plugin process and manages environment executors.extension.contribution.ts: Provides contribution point logic for the plugin process.extension.ts: Represents the Extension Instance.API Layers:
sumi/: Node-layer APIs and contribution points for Sumi.sumi-browser/: Browser-layer APIs and contribution points for Sumi.vscode/: Node-layer APIs and contribution points for VSCode (includes builtin-commands.ts for command namespaces).In OpenSumi, a RemoteService is a specialized service designed exclusively for communication with the frontend. It acts similarly to a Controller in a layered architecture (Controller-Service-DAO), handling validation, logic, and scheduling for external requests.
Key Principles of Remote Services:
RemoteService is instantiated only after a communication connection is established and cannot be re-instantiated.RemoteService classes end with the suffix RemoteService.RemoteService via @Autowired to prevent state inconsistency and dependency issues.OpenSumi's Agentic Layout is integrated directly into the existing workspace-local workbench rather than being a standalone application. The layout combines the following components into a single desktop workbench:
The Model Control Protocol (MCP) is an integration layer that exposes IDE functionalities to AI models through a standardized interface. It allows AI models to interact with the IDE environment, manipulate files, and execute various operations.
ToolInvocationRegistry instances, ensuring isolation between different client contexts (each instance is associated with a specific clientId).OpenSumi's Agentic Layout is a workspace-local mode that integrates an Agent Task List and an ACP Main Conversation Area into the ACP Chat Slot alongside the standard editor and file tree.
All agents in this layout must be ACP Agents (Agent implementation communicating via the Agent Client Protocol).
Key constraints:
When a tool encounters an error, it should return a standardized error response so the AI model can understand the failure. The response must include isError: true and a content array containing the error message.
{
content: [{
type: 'text',
text: 'Error: <error message>'
}],
isError: true
}Opening a tab in the IDE follows a specific lifecycle managed by the WorkbenchEditorService:
WorkbenchEditorService.open(uri) with a target URI (e.g., file://path/to/file.ts).IResource via a registered IResourceProvider. This resource provides metadata like the tab name and icon.IResource is used to create the tab in the UI, displaying its name and icon.code, diff, or a React component) by querying the EditorComponentRegistry.