feat: version/user-agent and doc changes to use public images (#30)

* feat: version and user agent

* docs: added public docker info to the README.md

* docs: nits

Author: KarthikBoddeda

.cursorignore

@@ -72,15 +72,12 @@ authorized_keys
 config/*
 
 # Documentation and Notes
-*.md
 *.mdx
 *.rst
 *.txt
 docs/*
-README*
 CHANGELOG*
 LICENSE*
-CONTRIBUTING*
 
 # Database Files
 *.sql

.github/workflows/docker-publish.yml

@@ -43,3 +43,5 @@ jobs:
           platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ steps.vars.outputs.tags }}
+          build-args: |
+            VERSION=${{ github.ref_name }}

Dockerfile

@@ -8,7 +8,9 @@ RUN go mod download
 
 COPY . .
 
-RUN CGO_ENABLED=0 GOOS=linux go build -o razorpay-mcp-server ./cmd/razorpay-mcp-server
+ARG VERSION="dev"
+
+RUN CGO_ENABLED=0 GOOS=linux go build -ldflags "-X main.version=${VERSION} -X main.commit=$(git rev-parse HEAD) -X main.date=$(date -u +%Y-%m-%dT%H:%M:%SZ)" -o razorpay-mcp-server ./cmd/razorpay-mcp-server
 
 FROM alpine:latest
 

Makefile

@@ -2,7 +2,7 @@
 VERSION ?= $(shell git describe --tags --always --dirty --match="v*" 2> /dev/null || echo "dev")
 BUILD_DATE = $(shell date -u '+%Y-%m-%d')
 COMMIT = $(shell git rev-parse --short HEAD 2>/dev/null || echo "unknown")
-LDFLAGS = -ldflags "-X main.version=$(VERSION) -X main.commit=$(COMMIT) -X main.buildDate=$(BUILD_DATE)"
+LDFLAGS = -ldflags "-X main.version=$(VERSION) -X main.commit=$(COMMIT) -X main.date=$(BUILD_DATE)"
 
 # Go variables
 GO = go
@@ -17,7 +17,10 @@ all: verify fmt test lint build
 
 # Build docker image
 build:
-	docker build -t $(IMAGE):$(TAG) .
+	docker build \
+		--build-arg VERSION="$(VERSION)" \
+		-t $(IMAGE):$(TAG) \
+		.
 
 # Run docker container
 run:
@@ -31,7 +34,7 @@ local-run:
 	$(GO) run ./cmd/razorpay-mcp-server
 
 local-build:
-	$(GO) build -v ./cmd/razorpay-mcp-server
+	$(GO) build $(LDFLAGS) -v -o razorpay-mcp-server ./cmd/razorpay-mcp-server
 
 # Verify dependencies
 verify:

README.md

@@ -60,33 +60,15 @@ Currently, the Razorpay MCP Server provides the following tools:
 
 To run the Razorpay MCP server, use one of the following methods:
 
-### Using Docker (Recommended)
+### Using Public Docker Image (Recommended)
 
-You need to clone the Github repo and build the image for Razorpay MCP Server using `docker`. Do make sure `docker` is installed and running in your system. 
+You can use the public Razorpay image directly. No need to build anything yourself - just copy-paste the configurations below and make sure Docker is already installed.
 
-```bash
-# Run the server
-git clone https://github.com/razorpay/razorpay-mcp-server.git
-cd razorpay-mcp-server
-docker build -t razorpay-mcp-server:latest .
-```
+> **Note:** To use a specific version instead of the latest, replace `razorpay/mcp` with `razorpay/mcp:v1.0.0` (or your desired version tag) in the configurations below. Available tags can be found on [Docker Hub](https://hub.docker.com/r/razorpay/mcp/tags).
 
-Post this razorpay-mcp-server:latest docker image would be ready in your system.
+#### Usage with Claude Desktop
 
-### Build from source
-
-```bash
-# Clone the repository
-git clone https://github.com/razorpay/razorpay-mcp-server.git
-cd razorpay-mcp-server
-
-# Build the binary
-go build -o razorpay-mcp-server ./cmd/razorpay-mcp-server
-```
-
-Binary `razorpay-mcp-server` would be present in your system post this.
-
-## Usage with Claude Desktop
+This will use the public razorpay image
 
 Add the following to your `claude_desktop_config.json`:
 
@@ -103,7 +85,7 @@ Add the following to your `claude_desktop_config.json`:
                 "RAZORPAY_KEY_ID",
                 "-e",
                 "RAZORPAY_KEY_SECRET",
-                "razorpay-mcp-server:latest"
+                "razorpay/mcp"
             ],
             "env": {
                 "RAZORPAY_KEY_ID": "your_razorpay_key_id",
@@ -118,7 +100,7 @@ Please replace the `your_razorpay_key_id` and `your_razorpay_key_secret` with yo
 - Learn about how to configure MCP servers in Claude desktop: [Link](https://modelcontextprotocol.io/quickstart/user)
 - How to install Claude Desktop: [Link](https://claude.ai/download)
 
-## Usage with VS Code
+#### Usage with VS Code
 
 Add the following to your VS Code settings (JSON):
 
@@ -150,7 +132,7 @@ Add the following to your VS Code settings (JSON):
           "RAZORPAY_KEY_ID",
           "-e",
           "RAZORPAY_KEY_SECRET",
-          "razorpay-mcp-server:latest"
+          "razorpay/mcp"
         ],
         "env": {
           "RAZORPAY_KEY_ID": "${input:razorpay_key_id}",
@@ -164,6 +146,46 @@ Add the following to your VS Code settings (JSON):
 
 Learn more about MCP servers in VS Code's [agent mode documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
 
+### Build from Docker (Alternative)
+
+You need to clone the Github repo and build the image for Razorpay MCP Server using `docker`. Do make sure `docker` is installed and running in your system. 
+
+```bash
+# Run the server
+git clone https://github.com/razorpay/razorpay-mcp-server.git
+cd razorpay-mcp-server
+docker build -t razorpay-mcp-server:latest .
+```
+
+Once the razorpay-mcp-server:latest docker image is built, you can replace the public image(`razorpay/mcp`) with it in the above configurations.
+
+### Build from source
+
+You can directly build from the source instead of using docker by following these steps:
+
+```bash
+# Clone the repository
+git clone https://github.com/razorpay/razorpay-mcp-server.git
+cd razorpay-mcp-server
+
+# Build the binary
+go build -o razorpay-mcp-server ./cmd/razorpay-mcp-server
+```
+Once the build is ready, you need to specify the path to the binary executable in the `command` option. Here's an example for VS Code settings:
+
+```json
+{
+  "razorpay": {
+    "command": "/path/to/razorpay-mcp-server",
+    "args": ["stdio","--log-file=/path/to/rzp-mcp.log"],
+    "env": {
+      "RAZORPAY_KEY_ID": "<YOUR_ID>",
+      "RAZORPAY_KEY_SECRET" : "<YOUR_SECRET>"
+    }
+  }
+}
+```
+
 ## Configuration
 
 The server requires the following configuration:

cmd/razorpay-mcp-server/stdio.go

@@ -36,6 +36,8 @@ var stdioCmd = &cobra.Command{
 		secret := viper.GetString("secret")
 		client := rzpsdk.NewClient(key, secret)
 
+		client.SetUserAgent("razorpay-mcp/" + version + "/stdio")
+
 		// Get toolsets to enable from config
 		enabledToolsets := viper.GetStringSlice("toolsets")
 

go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/go-test/deep v1.1.1
 	github.com/gorilla/mux v1.8.1
 	github.com/mark3labs/mcp-go v0.23.1
-	github.com/razorpay/razorpay-go v1.3.3
+	github.com/razorpay/razorpay-go v1.3.4
 	github.com/spf13/cobra v1.9.1
 	github.com/spf13/viper v1.20.1
 	github.com/stretchr/testify v1.10.0

go.sum

@@ -28,8 +28,8 @@ github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0
 github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/razorpay/razorpay-go v1.3.3 h1:htVhJPI8SXx7X9POcoGg2uMVzbn8hzv7UP9VvbMYYdw=
-github.com/razorpay/razorpay-go v1.3.3/go.mod h1:VcljkUylUJAUEvFfGVv/d5ht1to1dUgF4H1+3nv7i+Q=
+github.com/razorpay/razorpay-go v1.3.4 h1:A9DZ18GZDn/bGRjQ9SesTGUNIAEw+IB27512l3I81aI=
+github.com/razorpay/razorpay-go v1.3.4/go.mod h1:VcljkUylUJAUEvFfGVv/d5ht1to1dUgF4H1+3nv7i+Q=
 github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
 github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=