Skip to content

Commit 384b630

Browse files
committed
update readme
1 parent a84a603 commit 384b630

File tree

1 file changed

+34
-13
lines changed

1 file changed

+34
-13
lines changed

src/TALXIS.CLI.MCP/README.md

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,46 @@ This project hosts a ModelContextProtocol (MCP) server for the TALXIS CLI, adver
44

55
## Features
66
- Dynamic discovery of CLI commands and subcommands using reflection
7-
- Implements MCP ListTools and CallTool handlers
7+
- Implements MCP ListTools and CallTool handlers
88

9-
## Usage
9+
## Debugging and Testing Locally
1010

11-
Build and run the server:
11+
You can debug and test the MCP server locally in two main ways:
1212

13-
```sh
14-
dotnet run --project src/TALXIS.CLI.MCP
15-
```
16-
17-
The server will listen for MCP stdio requests and advertise available CLI tools.
18-
19-
20-
## Debugging Locally
13+
### 1. Using the Model Context Protocol Inspector
2114

22-
You can debug the MCP server locally using the [Model Context Protocol Inspector](https://www.npmjs.com/package/@modelcontextprotocol/inspector):
15+
You can use the [Model Context Protocol Inspector](https://www.npmjs.com/package/@modelcontextprotocol/inspector) for interactive inspection and debugging:
2316

2417
```sh
2518
npx @modelcontextprotocol/inspector dotnet run --project src/TALXIS.CLI.MCP
2619
```
2720

28-
This will launch the MCP Inspector and connect it to the running server for interactive inspection and debugging.
21+
This will launch the MCP Inspector and connect it to the running server.
22+
23+
### 2. Using VS Code with `.vscode/mcp`
24+
25+
You can also test the MCP server integration with VS Code by opening another window and adding a `.vscode/mcp` file to your project with the following content:
26+
27+
```json
28+
{
29+
"inputs": [],
30+
"servers": {
31+
"TALXIS CLI": {
32+
"type": "stdio",
33+
"command": "dotnet",
34+
"args": [
35+
"run",
36+
"--project",
37+
"/Users/tomasprokop/Desktop/Repos/tools-cli/src/TALXIS.CLI.MCP/TALXIS.CLI.MCP.csproj"
38+
]
39+
}
40+
}
41+
}
42+
```
43+
44+
**Steps:**
45+
46+
1. Open a new VS Code window in any folder (it does not have to be this repo).
47+
2. Create a `.vscode` directory if it does not exist.
48+
3. Add the above `mcp` file as `.vscode/mcp`.
49+
4. Make sure the path in `args` points to the correct location of your `TALXIS.CLI.MCP.csproj` file.

0 commit comments

Comments
 (0)