Skip to content

Commit de83171

Browse files
committed
Update README.md
1 parent 0978c26 commit de83171

File tree

1 file changed

+60
-16
lines changed

1 file changed

+60
-16
lines changed

README.md

Lines changed: 60 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,36 +32,80 @@ npx -y mcp-devcontainers
3232

3333
## MCP Transport
3434

35-
- Start server: `npm start` - Launches the MCP server with **stdio transport**
36-
- Start SSE server: `npm start sse` - Runs the MCP server with **Server-Sent Events transport**
37-
- Start Streamable HTTP server: `npm start http` - Starts the MCP server with **Streamable HTTP transport**
35+
### Option 1 - Start STDIO server
36+
37+
Launches the MCP server with **stdio transport**
38+
```bash
39+
npm start
40+
```
41+
42+
### Option 2 - Start SSE server
43+
Runs the MCP server with **Server-Sent Events transport** on `https://{your-domain}/sse`
44+
```bash
45+
npm start sse
46+
```
47+
48+
### Option 3 - Start Streamable HTTP server
49+
Starts the MCP server with **Streamable HTTP transport** on `https://{your-domain}/mcp`
50+
```bash
51+
npm start http
52+
```
3853

3954
## 📚 Tools
4055

4156
Tools are built on the [devcontainers/cli](https://github.com/devcontainers/cli)
4257

4358
They enable you to generate and configure development containers directly from `devcontainer.json` configuration files:
4459

45-
- ### devcontainer_up
46-
- workspaceFolder: Path to the workspace folder (string)
47-
- outputFilePath: Path for output logs (string)
60+
### `devcontainer_up`
61+
62+
Initializes and starts a devcontainer environment in the specified workspace folder. Ensures the devcontainer is operational and ready for development tasks.
63+
64+
- #### Input Parameters
65+
| Name | Required | Type | Description |
66+
| -------- | -------- | -------- | -------- |
67+
| workspaceFolder || string | Path to the workspace folder |
68+
| outputFilePath || string | Path for output logs |
69+
70+
- #### Returns
71+
72+
Text content with the devcontainer startup information
73+
74+
75+
### `devcontainer_run_user_commands`
76+
77+
Executes user-defined postCreateCommand and postStartCommand scripts within the devcontainer for the specified workspace. Use this to run setup or initialization tasks after container startup.
78+
79+
- #### Input Parameters
80+
| Name | Required | Type | Description |
81+
| -------- | -------- | -------- | -------- |
82+
| workspaceFolder || string | Path to the workspace folder |
83+
| outputFilePath || string | Path for output logs |
84+
85+
- #### Returns
86+
87+
Text content with the command execution result
88+
89+
90+
### `devcontainer_exec`
4891

49-
> Initializes and starts a devcontainer environment in the specified workspace folder. Ensures the devcontainer is operational and ready for development tasks.
92+
Runs a custom shell command inside the devcontainer for the specified workspace. Useful for executing arbitrary commands or scripts within the devcontainer environment.
5093

94+
- #### Input Parameters
95+
| Name | Required | Type | Description |
96+
| -------- | -------- | -------- | -------- |
97+
| workspaceFolder || string | Path to the workspace folder |
98+
| outputFilePath || string | Path for output logs |
99+
| command || string[ ] | Command to execute as string array |
51100

52-
- ### devcontainer_run_user_commands
53-
- workspaceFolder: Path to the workspace folder (string)
54-
- outputFilePath: Path for output logs (string)
101+
- #### Returns
55102

56-
> Executes user-defined postCreateCommand and postStartCommand scripts within the devcontainer for the specified workspace. Use this to run setup or initialization tasks after container startup.
103+
Text content with the command execution result
57104

58105

59-
- ### devcontainer_exec
60-
- workspaceFolder: Path to the workspace folder (string)
61-
- outputFilePath: Path for output logs (string)
62-
- command: Command to execute (array of string)
106+
### `devcontainer_list (TODO)`
63107

64-
> Runs a custom shell command inside the devcontainer for the specified workspace. Useful for executing arbitrary commands or scripts within the devcontainer environment.
108+
### `devcontainer_cleanup (TODO)`
65109

66110
## 🤝 Contributing
67111

0 commit comments

Comments
 (0)