Skip to content

Commit 3607a59

Browse files
authored
Merge pull request #25951 from abpframework/maliming/docs-cli-mcp-command
Document the `abp mcp` command in the CLI documentation
2 parents d25b529 + d052143 commit 3607a59

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

docs/en/cli/index.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ Here is the list of all available commands before explaining their details:
7878
- [install-old-cli](../cli#install-old-cli): Installs old ABP CLI.
7979
- [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.
8080
- [generate-jwks](../cli#generate-jwks): Generates an RSA key pair (JWKS public key + PEM private key) for OpenIddict `private_key_jwt` client authentication.
81+
- [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.
8182

8283
### help
8384

@@ -1310,6 +1311,63 @@ var tokenResponse = await httpClient.RequestClientCredentialsTokenAsync(
13101311
});
13111312
```
13121313
1314+
### mcp
1315+
1316+
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.
1317+
1318+
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.
1319+
1320+
Usage:
1321+
1322+
```bash
1323+
abp mcp [get-config]
1324+
```
1325+
1326+
Examples:
1327+
1328+
```bash
1329+
abp mcp # Starts the MCP server. MCP clients run this command themselves.
1330+
abp mcp get-config # Prints the configuration to be added to your MCP client.
1331+
```
1332+
1333+
#### Configuring your MCP client
1334+
1335+
`abp mcp get-config` prints the following configuration:
1336+
1337+
```json
1338+
{
1339+
"mcpServers": {
1340+
"abp": {
1341+
"command": "abp",
1342+
"args": [
1343+
"mcp"
1344+
],
1345+
"env": {}
1346+
}
1347+
}
1348+
}
1349+
```
1350+
1351+
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.
1352+
1353+
Codex uses the TOML format, so add the following section to `~/.codex/config.toml` (`%USERPROFILE%\.codex\config.toml` on Windows):
1354+
1355+
```toml
1356+
[mcp_servers.abp]
1357+
command = "abp"
1358+
args = ["mcp"]
1359+
```
1360+
1361+
#### Tools
1362+
1363+
| Tool | Description |
1364+
| --- | --- |
1365+
| `get_relevant_abp_documentation` | Searches the official ABP documentation. |
1366+
| `get_relevant_abp_articles` | Searches the ABP community articles. |
1367+
| `get_relevant_abp_support_questions` | Searches the previously answered support questions. |
1368+
| `search_source_code` | Searches the indexed ABP source code. |
1369+
| `list_abp_github_repositories` | Lists the ABP GitHub repositories available to the source code search. |
1370+
13131371
## See Also
13141372
13151373
- [Examples for the new command](./new-command-samples.md)

0 commit comments

Comments
 (0)