From bac71e7b0be2f08fef8c975c7a7073fbb604fed2 Mon Sep 17 00:00:00 2001 From: enisn Date: Wed, 11 Feb 2026 15:39:15 +0300 Subject: [PATCH 1/4] fix conflict --- docs/en/studio/overview.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/en/studio/overview.md b/docs/en/studio/overview.md index 9ad50ad95a..d59025ee82 100644 --- a/docs/en/studio/overview.md +++ b/docs/en/studio/overview.md @@ -99,6 +99,23 @@ This pane is dedicated to managing Kubernetes services. It simplifies the proces ![kubernetes-integration-kubernetes-panel](./images/overview/kubernetes-integration-kubernetes.png) +### AI Assistant + +The AI Assistant is an integrated chat interface within ABP Studio that provides intelligent assistance for ABP-related questions. You can access it from the left sidebar by clicking the AI icon. + +For external AI tool integrations through MCP, see the [Model Context Protocol (MCP)](./model-context-protocol.md) documentation. + +![ai-assistant](./images/overview/ai-assistant.png) + +Key features of the AI Assistant include: + +- **Chat Interface**: Ask anything about ABP Framework, and get instant, context-aware responses to help with your development workflow. +- **File Attachments**: Attach files to your conversations to get more specific assistance with your code or configuration. +- **Recent Chats**: Access your conversation history to continue previous discussions or reference past solutions. +- **Credits System**: The AI Assistant uses a credits-based system, with usage tracked and displayed in the interface. + +> **Note**: Review the Privacy Notice available in the AI Assistant panel to understand how your data is handled. + ## Application Monitoring Area The [Application Monitoring Area](./monitoring-applications.md) is a functional component within ABP Studio that displays real-time operational status and metrics for applications. It indicates the active state of applications, the count of running instances, and so on. The user interface is organized into several tabs: Overall, Browse, HTTP Requests, Events, Exceptions, and Logs. Now let's examine the **Overall** tab. From 51c2c183b30f94968dcb4db17adfa50dc5ee00a3 Mon Sep 17 00:00:00 2001 From: enisn Date: Wed, 11 Feb 2026 15:48:41 +0300 Subject: [PATCH 2/4] Add MCP Studio CLI and documentation Introduce the new `abp mcp-studio` CLI command and documentation for the Model Context Protocol (MCP). Adds a new docs page (studio/model-context-protocol.md) with usage, configuration examples for Cursor/Claude Desktop/VS Code, available MCP tools, and notes about the local bridge vs the cloud `abp mcp` service. Updates CLI index to list the new command and adjusts docs navigation (docs-nav.json) and the next link in monitoring-applications.md to include the MCP page. --- docs/en/cli/index.md | 26 +++++ docs/en/docs-nav.json | 4 + docs/en/studio/model-context-protocol.md | 133 ++++++++++++++++++++++ docs/en/studio/monitoring-applications.md | 4 +- 4 files changed, 165 insertions(+), 2 deletions(-) create mode 100644 docs/en/studio/model-context-protocol.md diff --git a/docs/en/cli/index.md b/docs/en/cli/index.md index 3a3d0c2304..a644ab3b6b 100644 --- a/docs/en/cli/index.md +++ b/docs/en/cli/index.md @@ -73,6 +73,7 @@ Here is the list of all available commands before explaining their details: * **[`clear-download-cache`](../cli#clear-download-cache)**: Clears the templates download cache. * **[`check-extensions`](../cli#check-extensions)**: Checks the latest version of the ABP CLI extensions. * **[`install-old-cli`](../cli#install-old-cli)**: Installs old ABP CLI. +* **[`mcp-studio`](../cli#mcp-studio)**: Starts ABP Studio MCP bridge for AI tools (requires ABP Studio running). * **[`generate-razor-page`](../cli#generate-razor-page)**: Generates a page class that you can use it in the ASP NET Core pipeline to return an HTML page. ### help @@ -981,6 +982,31 @@ Usage: abp install-old-cli [options] ``` +### mcp-studio + +Starts an MCP stdio bridge for AI tools (Cursor, Claude Desktop, VS Code, etc.) that connects to the local ABP Studio instance. ABP Studio must be running for this command to work. + +> This command connects to the **local ABP Studio** instance. It is separate from the `abp mcp` command, which connects to the ABP.IO cloud MCP service and requires an active license. + +Usage: + +```bash +abp mcp-studio [options] +``` + +Options: + +* `--endpoint` or `-e`: Overrides ABP Studio MCP endpoint. Default value is `http://localhost:38280/mcp/`. + +Example: + +```bash +abp mcp-studio +abp mcp-studio --endpoint http://localhost:38280/mcp/ +``` + +For detailed configuration examples (Cursor, Claude Desktop, VS Code) and the full list of available MCP tools, see the [Model Context Protocol (MCP)](../studio/model-context-protocol.md) documentation. + ### generate-razor-page `generate-razor-page` command to generate a page class and then use it in the ASP NET Core pipeline to return an HTML page. diff --git a/docs/en/docs-nav.json b/docs/en/docs-nav.json index fb94db85b2..dec47b14d9 100644 --- a/docs/en/docs-nav.json +++ b/docs/en/docs-nav.json @@ -340,6 +340,10 @@ "text": "Monitoring Applications", "path": "studio/monitoring-applications.md" }, + { + "text": "Model Context Protocol (MCP)", + "path": "studio/model-context-protocol.md" + }, { "text": "Working with Kubernetes", "path": "studio/kubernetes.md" diff --git a/docs/en/studio/model-context-protocol.md b/docs/en/studio/model-context-protocol.md new file mode 100644 index 0000000000..7af1dd7663 --- /dev/null +++ b/docs/en/studio/model-context-protocol.md @@ -0,0 +1,133 @@ +```json +//[doc-seo] +{ + "Description": "Learn how to connect AI tools like Cursor, Claude Desktop, and VS Code to ABP Studio using the Model Context Protocol (MCP)." +} +``` + +# ABP Studio: Model Context Protocol (MCP) + +````json +//[doc-nav] +{ + "Previous": { + "Name": "Monitoring Applications", + "Path": "studio/monitoring-applications" + }, + "Next": { + "Name": "Working with Kubernetes", + "Path": "studio/kubernetes" + } +} +```` + +ABP Studio includes built-in [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) support so AI tools can query runtime telemetry and control solution runner operations. + +## How It Works + +ABP Studio runs a local MCP server in the background. The `abp mcp-studio` CLI command acts as a stdio bridge that AI clients connect to. The bridge forwards requests to ABP Studio and returns responses. + +```text +MCP Client (Cursor / Claude Desktop / VS Code) + ──stdio──▶ abp mcp-studio ──HTTP──▶ ABP Studio +``` + +> ABP Studio must be running while MCP is used. If ABP Studio is not running (or its MCP endpoint is unavailable), `abp mcp-studio` returns an error to the AI client. + +## Configuration + +### Cursor (`.cursor/mcp.json`) + +```json +{ + "mcpServers": { + "abp-studio": { + "command": "abp", + "args": ["mcp-studio"] + } + } +} +``` + +### Claude Desktop (`claude_desktop_config.json`) + +```json +{ + "mcpServers": { + "abp-studio": { + "command": "abp", + "args": ["mcp-studio"] + } + } +} +``` + +Claude Desktop config file locations: + +- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` +- Windows: `%APPDATA%\Claude\claude_desktop_config.json` +- Linux: `~/.config/Claude/claude_desktop_config.json` + +### VS Code (`.vscode/mcp.json`) + +```json +{ + "servers": { + "abp-studio": { + "command": "abp", + "args": ["mcp-studio"] + } + } +} +``` + +### Generating Config Files from ABP Studio + +When creating a new solution, ABP Studio can generate MCP configuration files for Cursor and VS Code automatically. + +## Available Tools + +ABP Studio exposes the following tools to MCP clients. All tools operate on the currently open solution and selected run profile in ABP Studio. + +### Monitoring + +| Tool | Description | +|------|-------------| +| `list_applications` | Lists all running ABP applications connected to ABP Studio. | +| `get_exceptions` | Gets recent exceptions including stack traces and error messages. | +| `get_logs` | Gets log entries. Can be filtered by log level. | +| `get_requests` | Gets HTTP request information. Can be filtered by status code. | +| `get_events` | Gets distributed events for debugging inter-service communication. | +| `clear_monitor` | Clears collected monitor data. | + +### Application Control + +| Tool | Description | +|------|-------------| +| `list_runnable_applications` | Lists all applications in the current run profile with their state. | +| `start_application` | Starts a stopped application. | +| `stop_application` | Stops a running application. | +| `restart_application` | Restarts a running application. | +| `build_application` | Builds a .NET application using `dotnet build`. | + +### Container Control + +| Tool | Description | +|------|-------------| +| `list_containers` | Lists Docker containers in the current run profile with their state. | +| `start_containers` | Starts Docker containers (docker-compose up). | +| `stop_containers` | Stops Docker containers (docker-compose down). | + +### Solution Structure + +| Tool | Description | +|------|-------------| +| `get_solution_info` | Gets solution name, path, template, and run profile information. | +| `list_modules` | Lists all modules in the solution. | +| `list_packages` | Lists packages (projects) in the solution. Can be filtered by module. | +| `get_module_dependencies` | Gets module dependency/import information. | + +## Notes + +- Monitor data (exceptions, logs, requests, events) is kept in memory and is cleared when the solution is closed. +- The `abp mcp-studio` command connects to the local ABP Studio instance. This is separate from the `abp mcp` command, which connects to the ABP.IO cloud MCP service and requires an active license. diff --git a/docs/en/studio/monitoring-applications.md b/docs/en/studio/monitoring-applications.md index 04dac9ef13..e06d387146 100644 --- a/docs/en/studio/monitoring-applications.md +++ b/docs/en/studio/monitoring-applications.md @@ -11,8 +11,8 @@ //[doc-nav] { "Next": { - "Name": "Working with Kubernetes", - "Path": "studio/kubernetes" + "Name": "Model Context Protocol (MCP)", + "Path": "studio/model-context-protocol" } } ```` From c597805eac19a8fde982ba74aa22850206c8fdc7 Mon Sep 17 00:00:00 2001 From: enisn Date: Wed, 11 Feb 2026 15:55:01 +0300 Subject: [PATCH 3/4] docs: add mcp-studio help and usage notes Improve discoverability and guidance for the MCP/Studio CLI. Added a note in the CLI docs that the mcp-studio bridge is invoked automatically by AI tools (no manual run required) and that `abp help mcp-studio` shows options and IDE config snippets. Also added a Quick Reference entry to the Model Context Protocol doc pointing users to `abp help mcp-studio` for example configurations. --- docs/en/cli/index.md | 4 ++++ docs/en/studio/model-context-protocol.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/en/cli/index.md b/docs/en/cli/index.md index a644ab3b6b..e376887baf 100644 --- a/docs/en/cli/index.md +++ b/docs/en/cli/index.md @@ -986,6 +986,8 @@ abp install-old-cli [options] Starts an MCP stdio bridge for AI tools (Cursor, Claude Desktop, VS Code, etc.) that connects to the local ABP Studio instance. ABP Studio must be running for this command to work. +> You do not need to run this command manually. It is invoked automatically by your AI tool once you add the MCP configuration to your IDE. See the [Configuration](#configuration) examples below. + > This command connects to the **local ABP Studio** instance. It is separate from the `abp mcp` command, which connects to the ABP.IO cloud MCP service and requires an active license. Usage: @@ -1007,6 +1009,8 @@ abp mcp-studio --endpoint http://localhost:38280/mcp/ For detailed configuration examples (Cursor, Claude Desktop, VS Code) and the full list of available MCP tools, see the [Model Context Protocol (MCP)](../studio/model-context-protocol.md) documentation. +> You can also run `abp help mcp-studio` to see available options and example IDE configuration snippets directly in your terminal. + ### generate-razor-page `generate-razor-page` command to generate a page class and then use it in the ASP NET Core pipeline to return an HTML page. diff --git a/docs/en/studio/model-context-protocol.md b/docs/en/studio/model-context-protocol.md index 7af1dd7663..04b0232a6f 100644 --- a/docs/en/studio/model-context-protocol.md +++ b/docs/en/studio/model-context-protocol.md @@ -81,6 +81,10 @@ Claude Desktop config file locations: } ``` +### Quick Reference + +You can run `abp help mcp-studio` at any time to see the available options and example configuration snippets for each supported IDE directly in your terminal. + ### Generating Config Files from ABP Studio When creating a new solution, ABP Studio can generate MCP configuration files for Cursor and VS Code automatically. From c0dbb84748509515932489ed9d7f9ddbca908e3c Mon Sep 17 00:00:00 2001 From: enisn Date: Wed, 11 Feb 2026 16:11:49 +0300 Subject: [PATCH 4/4] Update model-context-protocol.md --- docs/en/studio/model-context-protocol.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/en/studio/model-context-protocol.md b/docs/en/studio/model-context-protocol.md index 04b0232a6f..7be6557df9 100644 --- a/docs/en/studio/model-context-protocol.md +++ b/docs/en/studio/model-context-protocol.md @@ -10,10 +10,6 @@ ````json //[doc-nav] { - "Previous": { - "Name": "Monitoring Applications", - "Path": "studio/monitoring-applications" - }, "Next": { "Name": "Working with Kubernetes", "Path": "studio/kubernetes"