From b049bd61eb6172f74e83cf29dbeba39aa207d29e Mon Sep 17 00:00:00 2001 From: Onur Ravli Date: Thu, 3 Apr 2025 16:10:50 +0300 Subject: [PATCH 1/4] chore: add install script to makefile, readme --- Makefile | 10 ++++++++++ README.md | 21 ++++++++++++++++++--- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index d8d8fe7..5740a53 100644 --- a/Makefile +++ b/Makefile @@ -22,6 +22,16 @@ build: @echo "$(YELLOW)Building $(BINARY_NAME)...$(NC)" go build -ldflags "-X main.Version=$(VERSION)" -o bin/$(BINARY_NAME) ./cmd/mcptools +install: + @echo "$(YELLOW)Installing $(BINARY_NAME)...$(NC)" + sudo install bin/$(BINARY_NAME) /usr/local/bin/$(BINARY_NAME) + sudo ln -s /usr/local/bin/$(BINARY_NAME) /usr/local/bin/$(ALIAS_NAME) + +uninstall: + @echo "$(YELLOW)Uninstalling $(BINARY_NAME)...$(NC)" + sudo rm -f /usr/local/bin/$(BINARY_NAME) + sudo rm -f /usr/local/bin/$(ALIAS_NAME) + test: check-go @echo "$(YELLOW)Running tests...$(NC)" go test -v ./... diff --git a/README.md b/README.md index c09b6cf..634a00d 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ brew install mcp > ❕ The binary is installed as `mcp` but can also be accessed as `mcpt` to avoid conflicts with other tools that might use the `mcp` command name. -### From Source +### Installing From Source ```bash go install github.com/f/mcptools/cmd/mcptools@latest @@ -68,6 +68,20 @@ go install github.com/f/mcptools/cmd/mcptools@latest The binary will be installed as `mcptools` but can be aliased to `mcpt` for convenience. +## Building and Installing From Source + +```bash +make build && sudo make install +``` + +The binary will be installed as `mcptools` but can be aliased to `mcpt` for convenience. + +## Uninstalling + +```bash +make uninstall +``` + ## Getting Started The simplest way to start using MCP Tools is to connect to an MCP server and list available tools: @@ -90,7 +104,7 @@ MCP Tools supports a wide range of features for interacting with MCP servers: ``` Usage: mcp [command] - + Available Commands: alias Manage MCP server aliases call Call a tool, resource, or prompt on the MCP server @@ -102,7 +116,7 @@ Available Commands: shell Start an interactive shell for MCP commands tools List available tools on the MCP server version Print the version information - + Flags: -f, --format string Output format (table, json, pretty) (default "table") -h, --help Help for mcp @@ -161,6 +175,7 @@ edit_file(edits:{newText:str,oldText:str}[], path:str) ``` Key features of the format: + - Function names are displayed in bold cyan - Required parameters are shown in green (e.g., `path:str`) - Optional parameters are shown in yellow brackets (e.g., `[limit:int]`) From 5f4054c4fefa2d63f4f2cde8a2cab054c9c59ad5 Mon Sep 17 00:00:00 2001 From: Onur Ravli Date: Thu, 3 Apr 2025 16:15:06 +0300 Subject: [PATCH 2/4] chore: format --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 634a00d..335154d 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ MCP Tools supports a wide range of features for interacting with MCP servers: ``` Usage: mcp [command] - + Available Commands: alias Manage MCP server aliases call Call a tool, resource, or prompt on the MCP server @@ -116,7 +116,7 @@ Available Commands: shell Start an interactive shell for MCP commands tools List available tools on the MCP server version Print the version information - + Flags: -f, --format string Output format (table, json, pretty) (default "table") -h, --help Help for mcp @@ -175,7 +175,6 @@ edit_file(edits:{newText:str,oldText:str}[], path:str) ``` Key features of the format: - - Function names are displayed in bold cyan - Required parameters are shown in green (e.g., `path:str`) - Optional parameters are shown in yellow brackets (e.g., `[limit:int]`) From 26057bbee57bfd029df00db91a9d157558f2b9ca Mon Sep 17 00:00:00 2001 From: Onur Ravli Date: Fri, 4 Apr 2025 00:39:29 +0300 Subject: [PATCH 3/4] docs: remove unnecessary sudo --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 335154d..735ecf3 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ The binary will be installed as `mcptools` but can be aliased to `mcpt` for conv ## Building and Installing From Source ```bash -make build && sudo make install +make build && make install ``` The binary will be installed as `mcptools` but can be aliased to `mcpt` for convenience. @@ -104,7 +104,7 @@ MCP Tools supports a wide range of features for interacting with MCP servers: ``` Usage: mcp [command] - + Available Commands: alias Manage MCP server aliases call Call a tool, resource, or prompt on the MCP server @@ -116,7 +116,7 @@ Available Commands: shell Start an interactive shell for MCP commands tools List available tools on the MCP server version Print the version information - + Flags: -f, --format string Output format (table, json, pretty) (default "table") -h, --help Help for mcp @@ -175,6 +175,7 @@ edit_file(edits:{newText:str,oldText:str}[], path:str) ``` Key features of the format: + - Function names are displayed in bold cyan - Required parameters are shown in green (e.g., `path:str`) - Optional parameters are shown in yellow brackets (e.g., `[limit:int]`) From 34a70dd0179245b748a966cd1c5efedfb62a0d5e Mon Sep 17 00:00:00 2001 From: Onur Ravli Date: Fri, 4 Apr 2025 00:40:10 +0300 Subject: [PATCH 4/4] docs: fix a typo in description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 735ecf3..d5ce4bd 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ The binary will be installed as `mcptools` but can be aliased to `mcpt` for conv make build && make install ``` -The binary will be installed as `mcptools` but can be aliased to `mcpt` for convenience. +The binary will be installed as `mcp` but can be aliased to `mcpt` for convenience. ## Uninstalling