Repository navigation
fix: escape proto comments correctly in generated descriptions and schemas #100
Description
Found while reviewing #99. Both bugs are in how proto comments become Go string literals and JSON Schema descriptions:
- A backslash in an RPC or message comment breaks generation. For example,
// matches \d+produces Go that doesn't parse, becauseprocessCommentToString(cmd/protoc-gen-go-mcp/mcp.go) escapes only". This already happens onmainbefore the migration.- Fix: emit string literals with
strconv.Quote(or%q) instead of hand-escaping.
- Fix: emit string literals with
- Quotes are double-escaped in schema descriptions.
schema.go(feat: generate JSON Schema for tool inputs from proto descriptors (protojson-compatible) #88) runs comments throughprocessCommentToStringand thenjson.Marshalescapes them again, so clients see\"quote\"in tool and field descriptions. feat!: generate MCP servers on the official Go MCP SDK (#89) #99 is the first PR to expose this to clients.- Fix: the schema builder uses the raw comment text, and only the final Go literal gets escaped.
Acceptance criteria
- Add comments with
",\, a backtick and a newline to the example proto (or a test proto), and regenerate. - The generated code compiles, and the tool description and schema descriptions match the comment text exactly (an e2e or unit assertion).
- Update the golden file.
Activity
erikist commentedon Oct 8, 2026
🤖 Factory: picked up by dispatcher; working on branch factory/100-fix-escape-proto-comments-correctly-in.
docs: clarify processCommentToString's comment-stripping comment (#100)
erikist commentedon Oct 8, 2026
🤖 Factory: opened PR #101 to fix this: #101
Summary:
processCommentToStringno longer escapes"/\itself (that was causing the double-escaping and the invalid-Go-literal bug); the toolDescriptionfield is now emitted withstrconv.Quote, and the schema builder's raw comment text is escaped exactly once byencoding/json. Added",\, a backtick and a newline toexamples/protos/example.proto'sSetVibeRequest.vibefield and theSetVibeRPC comment, regenerated the example and golden file, and addedTestProcessCommentToStringplus updated e2e assertions.Checks:
gofmt -l .,go vet ./...,go build ./...,go test ./..., and the golden-file test all pass — see the PR body for full output.fix: escape proto comments correctly in generated descriptions and sc…