Frequently Asked Questions about MCP Shell Server

Q: What is the MCP Shell Server?

A: The MCP Shell Server is a secure server that implements the Model Context Protocol (MCP) to allow authorized AI agents to remotely execute shell commands.

Q: What is MCP?

A: MCP (Model Context Protocol) is an open protocol that standardizes how applications provide context to Large Language Models (LLMs), enabling them to interact with external data and tools.

Q: Why is the MCP Shell Server needed?

A: It provides a secure way for AI agents to interact with systems by executing shell commands while preventing unauthorized access and malicious activities.

Q: What security measures does the MCP Shell Server implement?

A: It uses a command whitelist, validates input, validates shell operators, and can be run in a sandboxed environment.

Q: How do I specify allowed commands?

A: You can specify allowed commands using the ALLOW_COMMANDS or ALLOWED_COMMANDS environment variable.

Q: What happens if I try to execute a command that is not allowed?

A: The server will return an error indicating that the command is not permitted.

Q: Can I pass input to commands via stdin?

A: Yes, the server supports passing input to commands via stdin.

Q: Can I specify a timeout for command execution?

A: Yes, you can specify a maximum execution time for commands using the timeout parameter in the request.

Q: How do I install the MCP Shell Server?

A: You can install it using pip: pip install mcp-shell-server.

Q: What are the requirements to run the MCP Shell Server?

A: You need Python 3.11 or higher and mcp>=1.1.0.

Q: How does the MCP Shell Server integrate with UBOS?

A: It integrates seamlessly, allowing AI agents developed on the UBOS platform to securely execute shell commands and interact with other UBOS services.

Q: Can I specify a working directory for command execution?

A: Yes, you can specify a working directory using the directory parameter in the request.

Q: What kind of output does the server return?

A: The server returns stdout, stderr, exit code, and execution time for each command.

Q: How do I contribute to the MCP Shell Server project?

A: You can contribute by submitting pull requests, reporting issues, and providing feedback on the GitHub repository.