yexuanyang commented on code in PR #3547: URL: https://github.com/apache/hertzbeat/pull/3547#discussion_r2240267548
########## mcp-servers/mcp-bash-server/README.md: ########## @@ -0,0 +1,275 @@ +# mcp-bash-server + +A HertzBeat MCP server for running scripts with security command blacklist and logging capabilities + +## Dependencies + +### Rust + +If you need to deploy this MCP Server locally, you will need a Rust runtime environment. + +Visit [rust-lang.org](https://www.rust-lang.org/tools/install) to learn how to install the Rust runtime environment. + +We recommend using the latest version of Rust. + +## Deployment + +### Local Deployment + +If you want to run this MCP server locally using the default settings provided by the project, simply run the following command in the project root directory: + +```Rust +cargo run +``` + +This MCP server will be deployed at `http://127.0.0.1:4000/mcp`, and you can use the `modelcontextprotocol/inspector` tool to connect to and use this MCP server. + +For information on how to use the modelcontextprotocol/inspector tool, refer to the [inspector documentation](https://github.com/modelcontextprotocol/inspector). + +### Container Deployment + +Using container deployment for this MCP Server is an excellent way to try out the tools provided by the server without polluting your machine, as all MCP Server operations are completed within the container. + +To deploy using containers, simply run the following docker command: + +```shell +docker run -d --name mcp-bash-server -p 4000:4000 --restart unless-stopped yexuanyang/mcp-bash-server +``` + +If you want to build this image yourself, refer to the `Dockerfile` in the code repository and create your own Dockerfile. After creating it, run the following build command: + +```shell +docker build -t custom/mcp-bash-server:latest . +``` + +After building, use the following command to run it: + +```shell +docker run -d --name mcp-bash-server -p 4000:4000 --restart unless-stopped custom/mcp-bash-server:latest +``` + +The MCP Server inside the container runs on 0.0.0.0:4000. On the host machine, use the inspector with URL `http://localhost:4000/mcp` to connect to the MCP Server inside the container. + +## Configuration Review Comment: The program reads the `config.toml` file in the same directory, using `-v` to bind the custom config to container will cover the default config in image. I will describe how to do it in details in the upcoming commits. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
