Merge pull request #186 from githubnext/copilot/review-markdown-style

Author: pelikhan

internal/logger/rpc_logger.go

@@ -184,7 +184,7 @@ func isEffectivelyEmpty(data map[string]interface{}) bool {
 
 // formatRPCMessageMarkdown formats an RPC message for markdown logging
 func formatRPCMessageMarkdown(info *RPCMessageInfo) string {
-	// Concise format: **server**→method \n~~~ \n{formatted json} \n~~~
+	// Concise format: **server**→method \n```json \n{formatted json} \n```
 	var dir string
 	if info.Direction == RPCDirectionOutbound {
 		dir = "→"
@@ -199,7 +199,7 @@ func formatRPCMessageMarkdown(info *RPCMessageInfo) string {
 		if info.Method != "" {
 			message = fmt.Sprintf("**%s**%s`%s`", info.ServerID, dir, info.Method)
 		} else {
-			message = fmt.Sprintf("**%s**%sresp", info.ServerID, dir)
+			message = fmt.Sprintf("**%s**%s`resp`", info.ServerID, dir)
 		}
 	}
 
@@ -210,9 +210,9 @@ func formatRPCMessageMarkdown(info *RPCMessageInfo) string {
 		if isValidJSON {
 			// Don't show JSON block if it's effectively empty (only params: null)
 			if !isEmpty {
-				// Valid JSON: use code block for better readability (pretty printed)
-				// Empty line before ~~~ per markdown convention
-				message += fmt.Sprintf(" \n\n~~~\n%s\n~~~", formatted)
+				// Valid JSON: use json code block for syntax highlighting (pretty printed)
+				// Empty line before code block per markdown convention
+				message += fmt.Sprintf("\n\n```json\n%s\n```", formatted)
 			}
 		} else {
 			// Invalid JSON: use inline backticks to avoid malformed markdown

internal/logger/rpc_logger_test.go

@@ -194,7 +194,7 @@ func TestFormatRPCMessageMarkdown(t *testing.T) {
 				PayloadSize: 50,
 				Payload:     `{"jsonrpc":"2.0","method":"tools/list","params":{}}`,
 			},
-			want:    []string{"**github**→`tools/list`", "~~~", `"params"`, "{}"},
+			want:    []string{"**github**→`tools/list`", "```json", `"params"`, "{}"},
 			notWant: []string{`"jsonrpc"`, `"method"`},
 		},
 		{
@@ -206,7 +206,7 @@ func TestFormatRPCMessageMarkdown(t *testing.T) {
 				PayloadSize: 100,
 				Payload:     `{"result":{}}`,
 			},
-			want:    []string{"**github**←resp", "~~~", `"result"`},
+			want:    []string{"**github**←`resp`", "```json", `"result"`},
 			notWant: []string{`"jsonrpc"`, `"method"`},
 		},
 		{
@@ -218,7 +218,7 @@ func TestFormatRPCMessageMarkdown(t *testing.T) {
 				PayloadSize: 100,
 				Error:       "Connection timeout",
 			},
-			want:    []string{"**github**←resp", "⚠️`Connection timeout`"},
+			want:    []string{"**github**←`resp`", "⚠️`Connection timeout`"},
 			notWant: []string{},
 		},
 		{
@@ -232,7 +232,7 @@ func TestFormatRPCMessageMarkdown(t *testing.T) {
 				Payload:     `{invalid json syntax}`,
 			},
 			want:    []string{"**github**→`tools/call`", "`{invalid json syntax}`"},
-			notWant: []string{"~~~"}, // Should NOT use code blocks for invalid JSON
+			notWant: []string{"```json"}, // Should NOT use code blocks for invalid JSON
 		},
 		{
 			name: "request with only params null after field removal",
@@ -245,7 +245,7 @@ func TestFormatRPCMessageMarkdown(t *testing.T) {
 				Payload:     `{"jsonrpc":"2.0","method":"tools/list","params":null}`,
 			},
 			want:    []string{"**github**→`tools/list`"},
-			notWant: []string{"~~~", `"params"`}, // Should NOT show JSON block when only params: null
+			notWant: []string{"```json", `"params"`}, // Should NOT show JSON block when only params: null
 		},
 		{
 			name: "request with empty object after field removal",
@@ -258,7 +258,7 @@ func TestFormatRPCMessageMarkdown(t *testing.T) {
 				Payload:     `{"jsonrpc":"2.0","method":"tools/list"}`,
 			},
 			want:    []string{"**github**→`tools/list`"},
-			notWant: []string{"~~~"}, // Should NOT show JSON block when empty
+			notWant: []string{"```json"}, // Should NOT show JSON block when empty
 		},
 	}
 
@@ -475,7 +475,7 @@ func TestLogRPCResponse(t *testing.T) {
 	}
 
 	mdStr := string(mdContent)
-	expectedInMd := []string{"**github**←resp", "⚠️`backend connection failed`"}
+	expectedInMd := []string{"**github**←`resp`", "⚠️`backend connection failed`"}
 	for _, expected := range expectedInMd {
 		if !strings.Contains(mdStr, expected) {
 			t.Errorf("Markdown log does not contain %q", expected)