mcp-terminal-server logo

mcp-terminal-server

by RichardTheuws

Terminal server implementation for Model Context Protocol (MCP). It provides secure and controlled access to terminal commands and npm operations.

View on GitHub

Last updated: N/A

What is mcp-terminal-server?

This is a terminal server designed to work with the Model Context Protocol (MCP). It allows for the execution of shell commands and npm operations in a secure and controlled environment.

How to use mcp-terminal-server?

Install the package using npm install @modelcontextprotocol/server-terminal. Then, configure it within your MCP configuration file, specifying allowed commands, default timeout, working directory, and environment variables. You can then use the provided methods to execute commands, install npm packages, and run npm scripts.

Key features of mcp-terminal-server

  • Execute shell commands with full control

  • Built-in npm operations (install, run scripts)

  • Timeout handling

  • Security through allowed commands list

  • Environment variables management

  • Working directory control

  • Typescript support

Use cases of mcp-terminal-server

  • Automated build processes

  • Remote server administration

  • Controlled execution of scripts

  • Integration with CI/CD pipelines

FAQ from mcp-terminal-server

What is MCP?

Model Context Protocol, used for managing and controlling server-side operations.

How do I secure the terminal server?

By configuring the allowedCommands list to restrict which commands can be executed.

What is the purpose of autoApproveScope?

It automatically approves certain scopes like execute_command, npm_install, and npm_run.

Can I customize the timeout for commands?

Yes, you can set a defaultTimeout in the configuration.

How can I set environment variables for commands?

You can define environmentVariables in the configuration, which will be available to the executed commands.