Frequently Asked Questions (FAQ) about UBOS MCP Terminal Server

Q: What is the MCP Terminal Server?

A: The MCP Terminal Server is a lightweight FastAPI server that runs as a Windows service. It allows you to execute shell commands and stream their output in real-time through an API endpoint.

Q: What are the prerequisites for installing the MCP Terminal Server?

A: You need a Windows operating system, Python 3.7 or higher, and administrator privileges to install the MCP Terminal Server.

Q: How do I install the MCP Terminal Server?

A: To install, clone the repository, open PowerShell as Administrator, navigate to the project directory, and run the install_service.ps1 script.

Q: Can I customize the installation?

A: Yes, you can customize the installation by using parameters such as -ApiKey, -Port, -Host, -LogLevel, and -ConfigFile when running the installation script.

Q: How can I configure the server?

A: You can configure the server through environment variables, a configuration file (config.json), or command-line arguments during installation.

Q: What environment variables can I use to configure the server?

A: You can use environment variables such as MCP_TERMINAL_API_KEY, MCP_HOST, MCP_PORT, MCP_LOG_LEVEL, and others to configure the server.

Q: How do I manage the MCP Terminal Server service?

A: You can manage the service using PowerShell commands like python service.py install, python service.py start, python service.py stop, and others.

Q: Where are the logs stored?

A: Logs are stored in the configured log file, which defaults to mcp_terminal_server.log.

Q: How do I use the API?

A: You can use the API by sending a POST request to the /run endpoint with the command to execute in the request body. You need to include an API key in the X-API-Key header.

Q: Is there a test client available?

A: Yes, a test client (test_client.py) is provided to interact with the server. It supports command-line arguments, API key authentication, and more.

Q: How do I configure the test client?

A: You can configure the test client using a JSON configuration file (client_config.json) or environment variables.

Q: What security considerations should I keep in mind?

A: Always change the default API key in production, restrict the host to 127.0.0.1 if the server should only be accessible locally, and consider using HTTPS in production.

Q: What do I do if I encounter issues?

A: Check the log file for errors, run in debug mode (python service.py debug), verify the service is running, and check the Windows Event Viewer for service-related errors.