使用说明
mcp终端
用于git和终端访问的MCP服务器
特性
此MCP服务器提供以下工具:
execute_command:在指定目录中执行终端命令。git_clone:将git存储库克隆到指定位置。install_react_project:使用Vite创建一个新的React项目。install_vue_project:使用Vite创建一个新的Vue项目。install_next_project:创建一个新的Next.js项目。open_in_vscode:在VSCode中打开目录或文件。check_directory:检查目录是否存在并列出其内容。
先决条件
- Node.js (包括npm)
- Visual Studio Code (用于在VSCode中打开项目的功能)
安装
- 克隆存储库(如果您还没有):
git clone https://github.com/AbdurRaahimm/mcp-git-terminal-server.git mcp-terminal cd mcp-terminal - 安装依赖项:
npm install
用法
-
构建服务器:
npm run build -
启动服务器:
npm run start或者,您可以使用构建并启动服务器的开发脚本:
npm run dev然后,服务器将在stdio上运行,准备接受来自兼容客户端的MCP请求。
要使用MCP客户端配置此服务器,您可能需要指定构建的
index.js文件(例如。,dist/index.js在该项目的根中)和运行它的命令(例如。,node).有关具体说明,请参阅MCP客户的文档。
可用工具
以下是对可用工具及其参数的更详细了解:
execute_command
在指定目录中执行终端命令。
- 输入架构:
command(string,必填):要执行的命令(例如,'npm install','ls-la')。cwd(string,可选):命令的工作目录(默认为当前目录)。
git_clone
将git存储库克隆到指定位置。
- 输入架构:
repositoryUrl(字符串,必填):Git存储库URL。destination(字符串,必填):克隆存储库的目标路径。openInVSCode(布尔值,可选):在VSCode中打开克隆的存储库(默认值:false).
install_react_project
使用Vite创建一个新的React项目,并在VSCode中打开它。
- 输入架构:
projectName(string,必填):React项目的名称。destination(string,必填):创建项目的目录(例如。,~/Desktop).template(字符串,可选,枚举:["react", "react-ts", "react-swc", "react-swc-ts"]):要使用的Vite模板(默认值:react-ts).installDependencies(布尔值,可选):创建项目后安装依赖项(默认值:true).
install_vue_project
使用Vite创建一个新的Vue项目,并在VSCode中打开它。
- 输入架构:
projectName(string,必填):Vue项目的名称。destination(string,必填):创建项目的目录(例如。,~/Desktop).template(字符串,可选,枚举:["vue", "vue-ts"]):要使用的Vite模板(默认值:vue-ts).installDependencies(布尔值,可选):创建项目后安装依赖项(默认值:true).
install_next_project
创建一个新的Next.js项目,并在VSCode中打开它。
- 输入架构:
projectName(string,必填):Next.js项目的名称。destination(string,必填):创建项目的目录(例如。,~/Desktop).typescript(布尔值,可选):使用TypeScript(默认值:true).installDependencies(布尔值,可选):创建项目后安装依赖项(默认值:true).
open_in_vscode
在VSCode中打开目录或文件。
- 输入架构:
path(字符串,必填):在VSCode中打开的路径。
check_directory
检查目录是否存在并列出其内容。
- 输入架构:
path(字符串,必填):要检查的目录路径。
许可证
该项目根据MIT许可证获得许可。(如所述 package.json)
用法
{
"mcpServers": {
"git-terminal": {
"command": "node",
"args": ["/path/to/mcp-git-terminal/dist/index.js"]
}
}
}
