Skip to content

Commit 4e24186

Browse files
authored
docs: Refactors the MCP tools in a tabular format (#8)
1 parent e49b105 commit 4e24186

1 file changed

Lines changed: 6 additions & 13 deletions

File tree

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,12 @@ At the moment, only `stdio` transport has been implemented.
3838

3939
## Tools
4040

41-
- **devcontainer_up** - Start or initialize a devcontainer environment in the specified workspace folder. Use this to ensure the devcontainer is running and ready for development tasks.
42-
- `workspaceFolder`: Path to the workspace folder (string, required)
43-
- `outputFilePath`: Path to write output logs (string, optional)
44-
45-
- **devcontainer_run_user_commands** - Run the user-defined `postCreateCommand` and `postStartCommand` scripts in the devcontainer for the specified workspace folder. Use this to execute setup or initialization commands after the devcontainer starts.
46-
- `workspaceFolder`: Path to the workspace folder (string, required)
47-
- `outputFilePath`: Path to write output logs (string, optional)
48-
49-
- **devcontainer_exec** - Execute an arbitrary shell command inside the devcontainer for the specified workspace folder. Use this to run custom commands or scripts within the devcontainer context.
50-
- `workspaceFolder`: Path to the workspace folder (string, required)
51-
- `command`: Command to execute (string[], required)
52-
- `outputFilePath`: Path to write output logs (string, optional)
41+
| Tool | workspaceFolder | outputFilePath | Command | Description |
42+
| ---------------------------------- | ----------------------------------------------- | -------------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
43+
| **devcontainer_up** | Path to the workspace folder (string, required) | Path to write output logs (string, optional) | N/A | Start or initialize a devcontainer environment in the specified workspace folder.<br>Use this to ensure the devcontainer is running and ready for development tasks. |
44+
| **devcontainer_run_user_commands** | Path to the workspace folder (string, required) | Path to write output logs (string, optional) | N/A | Run the user-defined `postCreateCommand` and `postStartCommand` scripts in the devcontainer for the specified workspace folder.<br>Use this to execute setup or initialization commands after the devcontainer starts. |
45+
| **devcontainer_exec** | Path to the workspace folder (string, required) | Path to write output logs (string, optional) | Command to execute (string[], required) | Execute an arbitrary shell command inside the devcontainer for the specified workspace folder.<br>Use this to run custom commands or scripts within the devcontainer context. | |
5346

5447
## License
5548

56-
Released under the MIT License. See the [LICENSE](./LICENSE) file for further details.
49+
Released under the MIT License. See the [LICENSE](./LICENSE) file for further details.

0 commit comments

Comments
 (0)