Skip to content

(chore) add install script to makefile #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

(chore) add install script to makefile #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b049bd6
chore: add install script to makefile, readme
onurravli Apr 3, 2025
5f4054c
chore: format
onurravli Apr 3, 2025
26057bb
docs: remove unnecessary sudo
onurravli Apr 3, 2025
34a70dd
docs: fix a typo in description
onurravli Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ./...
Expand Down
21 changes: 18 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,28 @@ 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
```

The binary will be installed as `mcptools` but can be aliased to `mcpt` for convenience.

## Building and Installing From Source

```bash
make build && make install
```

The binary will be installed as `mcp` 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:
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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]`)
Expand Down