Skip to content

docs: Refactors the MCP tools in a tabular format #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Refactors the MCP tools in a tabular format #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 6 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,12 @@ At the moment, only `stdio` transport has been implemented.

## Tools

- **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.
- `workspaceFolder`: Path to the workspace folder (string, required)
- `outputFilePath`: Path to write output logs (string, optional)

- **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.
- `workspaceFolder`: Path to the workspace folder (string, required)
- `outputFilePath`: Path to write output logs (string, optional)

- **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.
- `workspaceFolder`: Path to the workspace folder (string, required)
- `command`: Command to execute (string[], required)
- `outputFilePath`: Path to write output logs (string, optional)
| Tool | workspaceFolder | outputFilePath | Command | Description |
| ---------------------------------- | ----------------------------------------------- | -------------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **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. |
| **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. |
| **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. | |

## License

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