From 23942f4d51dd81298e06be851ea8e7afda6c953f Mon Sep 17 00:00:00 2001 From: maliming Date: Tue, 11 Aug 2026 09:26:27 +0800 Subject: [PATCH 1/3] Document the abp mcp CLI command --- docs/en/cli/index.md | 59 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/docs/en/cli/index.md b/docs/en/cli/index.md index 8196ba993e..02402ac0ed 100644 --- a/docs/en/cli/index.md +++ b/docs/en/cli/index.md @@ -78,6 +78,7 @@ Here is the list of all available commands before explaining their details: - [install-old-cli](../cli#install-old-cli): Installs old ABP CLI. - [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. - [generate-jwks](../cli#generate-jwks): Generates an RSA key pair (JWKS public key + PEM private key) for OpenIddict `private_key_jwt` client authentication. +- [mcp](../cli#mcp): Runs the ABP MCP server, so AI coding assistants can search the ABP documentation, articles, support questions and source code. ### help @@ -1310,6 +1311,64 @@ var tokenResponse = await httpClient.RequestClientCredentialsTokenAsync( }); ``` +### mcp + +Runs the ABP [MCP (Model Context Protocol)](https://modelcontextprotocol.io/) server on your computer, so MCP clients such as Claude Code, Codex, Cursor and Visual Studio Code can search the ABP documentation, community articles, answered support questions and the framework source code. + +The command communicates with the MCP client over `stdio` and forwards the tool calls to `https://mcp.abp.io` by default. It uses the credentials of the [logged in](../cli#login) user, so you should run `abp login` before using it and your organization must have an active license. An internet connection is also required: the command checks the server before starting and fails when it can not be reached. + +Usage: + +```bash +abp mcp [get-config] +``` + +Examples: + +```bash +abp mcp # Starts the MCP server. MCP clients run this command themselves. +abp mcp get-config # Prints the configuration to be added to your MCP client. +``` + +#### Configuring your MCP client + +`abp mcp get-config` prints the following configuration: + +```json +{ + "mcpServers": { + "abp": { + "command": "abp", + "args": [ + "mcp" + ], + "env": {} + } + } +} +``` + +Claude Code uses that JSON directly. Add it to the `.mcp.json` file in your solution folder to enable the server for a single solution, or to `~/.claude.json` (`%USERPROFILE%\.claude.json` on Windows) to enable it for all of them. Cursor uses the same format in its own `mcp.json` file. For the other clients, check their documentation for the configuration file and the format they expect; the command and the arguments are always the same. + +Codex uses the TOML format, so add the following section to `~/.codex/config.toml` (`%USERPROFILE%\.codex\config.toml` on Windows): + +```toml +[mcp_servers.abp] +command = "abp" +args = ["mcp"] +``` + +#### Tools + +| Tool | Description | +| --- | --- | +| `get_relevant_abp_documentation` | Searches the official ABP documentation. | +| `get_relevant_abp_articles` | Searches the ABP community articles. | +| `get_relevant_abp_support_questions` | Searches the previously answered support questions. | +| `search_source_code` | Searches the ABP source code. Can be filtered by version and repository. | +| `get_source_code_file` | Returns the full content of a file in an ABP repository. | +| `list_abp_github_repositories` | Lists the official ABP GitHub repositories. | + ## See Also - [Examples for the new command](./new-command-samples.md) From 4ce797c4492a1d5b72f4e24f423b1325fafb0e49 Mon Sep 17 00:00:00 2001 From: Ma Liming Date: Tue, 11 Aug 2026 13:17:48 +0800 Subject: [PATCH 2/3] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- docs/en/cli/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/cli/index.md b/docs/en/cli/index.md index 02402ac0ed..f6937f8322 100644 --- a/docs/en/cli/index.md +++ b/docs/en/cli/index.md @@ -1315,7 +1315,7 @@ var tokenResponse = await httpClient.RequestClientCredentialsTokenAsync( Runs the ABP [MCP (Model Context Protocol)](https://modelcontextprotocol.io/) server on your computer, so MCP clients such as Claude Code, Codex, Cursor and Visual Studio Code can search the ABP documentation, community articles, answered support questions and the framework source code. -The command communicates with the MCP client over `stdio` and forwards the tool calls to `https://mcp.abp.io` by default. It uses the credentials of the [logged in](../cli#login) user, so you should run `abp login` before using it and your organization must have an active license. An internet connection is also required: the command checks the server before starting and fails when it can not be reached. +The command communicates with the MCP client over `stdio` and forwards the tool calls to `https://mcp.abp.io` by default. It uses the credentials of the [logged in](../cli#login) user, so you should run `abp login` before using it and your organization must have an active license. An internet connection is also required: the command checks the server before starting and fails when it cannot be reached. Usage: From d052143eb51353be8223cd1f7484c1e08a6483f7 Mon Sep 17 00:00:00 2001 From: maliming Date: Tue, 11 Aug 2026 17:06:53 +0800 Subject: [PATCH 3/3] Fix the MCP tool descriptions in the CLI documentation --- docs/en/cli/index.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/en/cli/index.md b/docs/en/cli/index.md index f6937f8322..64aeef17a7 100644 --- a/docs/en/cli/index.md +++ b/docs/en/cli/index.md @@ -78,7 +78,7 @@ Here is the list of all available commands before explaining their details: - [install-old-cli](../cli#install-old-cli): Installs old ABP CLI. - [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. - [generate-jwks](../cli#generate-jwks): Generates an RSA key pair (JWKS public key + PEM private key) for OpenIddict `private_key_jwt` client authentication. -- [mcp](../cli#mcp): Runs the ABP MCP server, so AI coding assistants can search the ABP documentation, articles, support questions and source code. +- [mcp](../cli#mcp): Runs a local MCP bridge to the ABP.IO MCP service, so AI coding assistants can search the ABP documentation, articles, support questions and source code. ### help @@ -1313,7 +1313,7 @@ var tokenResponse = await httpClient.RequestClientCredentialsTokenAsync( ### mcp -Runs the ABP [MCP (Model Context Protocol)](https://modelcontextprotocol.io/) server on your computer, so MCP clients such as Claude Code, Codex, Cursor and Visual Studio Code can search the ABP documentation, community articles, answered support questions and the framework source code. +Runs a local [MCP (Model Context Protocol)](https://modelcontextprotocol.io/) bridge to the ABP.IO MCP service, so MCP clients such as Claude Code, Codex, Cursor and Visual Studio Code can search the ABP documentation, community articles, answered support questions and the framework source code. The command communicates with the MCP client over `stdio` and forwards the tool calls to `https://mcp.abp.io` by default. It uses the credentials of the [logged in](../cli#login) user, so you should run `abp login` before using it and your organization must have an active license. An internet connection is also required: the command checks the server before starting and fails when it cannot be reached. @@ -1365,9 +1365,8 @@ args = ["mcp"] | `get_relevant_abp_documentation` | Searches the official ABP documentation. | | `get_relevant_abp_articles` | Searches the ABP community articles. | | `get_relevant_abp_support_questions` | Searches the previously answered support questions. | -| `search_source_code` | Searches the ABP source code. Can be filtered by version and repository. | -| `get_source_code_file` | Returns the full content of a file in an ABP repository. | -| `list_abp_github_repositories` | Lists the official ABP GitHub repositories. | +| `search_source_code` | Searches the indexed ABP source code. | +| `list_abp_github_repositories` | Lists the ABP GitHub repositories available to the source code search. | ## See Also