Merge pull request #9 from selesy/feat/generate-method-param-lists

Feat/generate method param lists

Author: smoyer64

gen/go.mod

@@ -7,18 +7,19 @@ require (
 	github.com/google/go-github/v74 v74.0.0
 	github.com/invopop/yaml v0.3.1
 	github.com/lmittmann/tint v1.1.2
-	github.com/selesy/ethereum-mcp v0.1.0
+	github.com/selesy/jsonschema v0.14.0-rc1
 	github.com/stretchr/testify v1.11.0
+	github.com/wk8/go-ordered-map/v2 v2.1.8
+	gotest.tools/v3 v3.5.2
 )
 
 require (
 	github.com/bahlo/generic-list-go v0.2.0 // indirect
 	github.com/buger/jsonparser v1.1.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/selesy/jsonschema v0.14.0-rc1 // indirect
-	github.com/wk8/go-ordered-map/v2 v2.1.8 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

gen/go.sum

@@ -22,8 +22,6 @@ github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0
 github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
 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/selesy/ethereum-mcp v0.1.0 h1:R4iMYgEQ+qg6k6KZzRjZIQaNUt+OG+lvmYvjb+1g6oY=
-github.com/selesy/ethereum-mcp v0.1.0/go.mod h1:sfYXFegKyqhjuk3atQmYUIkfIAnA2D/6mEEB6dMox0E=
 github.com/selesy/jsonschema v0.14.0-rc1 h1:rGdpQeWFk76uxpmOx0lrA9Lwb+eVTBPZ6io5IC7rVIk=
 github.com/selesy/jsonschema v0.14.0-rc1/go.mod h1:QgbdOu2y8GVkNvmK+npB2dvXlbdEL0eQ2LrRcHRTcKU=
 github.com/stretchr/testify v1.11.0 h1:ib4sjIrwZKxE5u/Japgo/7SJV3PvgjGiRNAvTVGqQl8=

gen/internal/generator/generator.go

@@ -12,7 +12,7 @@ import (
 
 	"github.com/dave/jennifer/jen"
 
-	"github.com/selesy/ethereum-mcp/pkg/openrpc"
+	"github.com/selesy/ethereum-mcp/gen/internal/openrpc"
 )
 
 // Generator writes JSONSchema files and Go code for each OpenRPC method
@@ -40,11 +40,11 @@ func (g *Generator) Run(ctx context.Context, methods []openrpc.Method) error {
 	schemaFile.Anon("embed")
 	schemaDict := jen.Dict{}
 
-	if err := os.Mkdir("mcp", 0o750); err != nil && !os.IsExist(err) {
+	if err := os.Mkdir("tool", 0o750); err != nil && !os.IsExist(err) {
 		return err
 	}
 
-	toolFile := jen.NewFile("mcp")
+	toolFile := jen.NewFile("tool")
 	toolFile.HeaderComment("Code generated by /gen. DO NOT EDIT.")
 	toolDict := jen.Dict{}
 
@@ -61,7 +61,7 @@ func (g *Generator) Run(ctx context.Context, methods []openrpc.Method) error {
 		goDescr := goDescription(method.Description())
 
 		// Save the method schemas as formatted JSON files
-		data, err := json.MarshalIndent(method, "", "  ")
+		data, err := json.MarshalIndent(method.Schema(), "", "  ")
 		if err != nil {
 			return err
 		}
@@ -92,11 +92,19 @@ func (g *Generator) Run(ctx context.Context, methods []openrpc.Method) error {
 		toolDict[jen.Lit(method.Name())] = jen.Id(goName + "Tool")
 
 		// Add the tool parameters - in order - to the lookup table
-		paramNames := make([]jen.Code, 0, len(method.Params()))
+		paramOrder := make([]jen.Code, 0, len(method.Params()))
+		paramRequired := jen.Dict{}
+
 		for _, param := range method.Params() {
-			paramNames = append(paramNames, jen.Lit(param.Name()))
+			paramOrder = append(paramOrder, jen.Lit(param.Name()))
+			if param.Required() {
+				paramRequired[jen.Lit(param.Name())] = jen.Struct().Block()
+			}
 		}
-		paramsDict[jen.Lit(method.Name())] = jen.Index().String().Values(paramNames...)
+		paramsDict[jen.Lit(method.Name())] = jen.Id("").Values(jen.Dict{
+			jen.Id("order"):    jen.Index().String().Values(paramOrder...),
+			jen.Id("required"): jen.Map(jen.String()).Struct().Values(paramRequired),
+		})
 	}
 
 	schemaFile.Comment("Schemas returns a map relating method names to the associated JSONSchema.")
@@ -115,15 +123,15 @@ func (g *Generator) Run(ctx context.Context, methods []openrpc.Method) error {
 		jen.Return(jen.Map(jen.String()).Qual("github.com/mark3labs/mcp-go/mcp", "Tool").Values(toolDict)),
 	)
 
-	if err := toolFile.Save(filepath.Join("mcp", "tool_gen.go")); err != nil {
+	if err := toolFile.Save(filepath.Join("tool", "tool_gen.go")); err != nil {
 		return err
 	}
 
 	g.log.Info("Generated mcp/tool_gen.go file")
 
-	paramsFile.Comment("Parameters returns a map relating method names to the associated (ordered) list of parameters.")
-	paramsFile.Func().Id("Parameters").Params().Map(jen.String()).Index().String().Block(
-		jen.Return(jen.Map(jen.String()).Index().String().Values(paramsDict)),
+	paramsFile.Comment("ParamsSpecs returns a map relating method names to the associated (ordered) list of parameters.")
+	paramsFile.Func().Id("ParamsSpecs").Params().Map(jen.String()).Id("ParamsSpec").Block(
+		jen.Return(jen.Map(jen.String()).Id("ParamsSpec").Values(paramsDict)),
 	)
 
 	if err := paramsFile.Save(filepath.Join("proxy", "params_gen.go")); err != nil {

pkg/openrpc/definition.go gen/internal/openrpc/definition.gopkg/openrpc/definition.go renamed to gen/internal/openrpc/definition.go

@@ -11,7 +11,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"gotest.tools/v3/golden"
 
-	"github.com/selesy/ethereum-mcp/pkg/openrpc"
+	"github.com/selesy/ethereum-mcp/gen/internal/openrpc"
 )
 
 func TestMerge(t *testing.T) {
@@ -65,28 +65,33 @@ func TestDefinitions_Filter(t *testing.T) {
 		"A2": {},
 		"A3": {"deprecated":true},
 		"B1": {},
-		"B2": {},
-		"B3": {}
+		"B2": {
+			"title": "C2 or C4",
+			"oneOf": [
+				{"$ref":"#/components/schemas/C2"},
+				{"$ref":"#/components/schemas/C4"}
+			]
+		},
+		"B3": {},
+		"C1": {},
+		"C2": {},
+		"C3": {},
+		"C4": {}
 	}`
 
 	var defs openrpc.Definitions
 
 	require.NoError(t, json.Unmarshal([]byte(in), &defs))
-	assert.Equal(t, 6, defs.Len())
-
-	assert.True(t, defs.Contains("A1"))
-	assert.True(t, defs.Contains("A2"))
-	assert.True(t, defs.Contains("A3"))
-	assert.True(t, defs.Contains("B1"))
-	assert.True(t, defs.Contains("B2"))
-	assert.True(t, defs.Contains("B3"))
+	require.Equal(t, 10, defs.Len())
 
 	defs, err := defs.Filter("A3", "B2")
 	require.NoError(t, err)
-	assert.Equal(t, 2, defs.Len())
+	assert.Equal(t, 4, defs.Len())
 
 	assert.True(t, defs.Contains("A3"))
 	assert.True(t, defs.Contains("B2"))
+	assert.True(t, defs.Contains("C2"))
+	assert.True(t, defs.Contains("C4"))
 
 	assert.True(t, defs.Get("A3").Deprecated)
 	assert.False(t, defs.Get("B2").Deprecated)

pkg/openrpc/definition_test.go gen/internal/openrpc/definition_test.gopkg/openrpc/definition_test.go renamed to gen/internal/openrpc/definition_test.go

@@ -6,9 +6,12 @@ import (
 	"strings"
 
 	"github.com/selesy/jsonschema"
+	orderedmap "github.com/wk8/go-ordered-map/v2"
 )
 
-// Method is an idempotent representation of an OpenRPC method.  Only the
+var _ json.Unmarshaler = (*Method)(nil)
+
+// Method is an immutable representation of an OpenRPC method.  Only the
 // fields needed to create a "raw schema" for an MCP tool are defined and
 // processed while unmarshaling the JSON.  See [the specification] for
 // more details on the available fields when updating or expanding this
@@ -19,6 +22,10 @@ type Method struct {
 	method method
 }
 
+// WithDefs returns a deep copy of the receiver with the provided
+// Definitions replacing any previously set definitions.  This
+// method is integral to merging the OpenRPC schemas and definitions
+// into "complete" JSONSchema types.
 func (m *Method) WithDefs(defs Definitions) *Method {
 
 	return &Method{
@@ -60,9 +67,30 @@ func (m *Method) Defs() Definitions {
 	return m.method.Defs
 }
 
-// MarshalJSON implements the json.Marshaler interface.
-func (m Method) MarshalJSON() ([]byte, error) {
-	return json.Marshal(m.method)
+func (m *Method) Schema() jsonschema.Schema {
+	s := jsonschema.Schema{
+		ID:          jsonschema.ID("https://github.com/selesy/ethereum-mcp/" + m.Name() + ".json"),
+		Version:     "https://json-schema.org/draft/2020-12/schema",
+		Title:       m.Name(),
+		Description: m.Description(),
+		Type:        "object",
+		Properties:  orderedmap.New[string, *jsonschema.Schema](),
+		Definitions: m.method.Defs.GetAll(),
+	}
+
+	required := []string{}
+	for _, param := range m.Params() {
+		s.Properties.Store(param.Name(), param.Schema())
+		if param.Required() {
+			required = append(required, param.Name())
+		}
+	}
+
+	if len(required) > 0 {
+		s.Required = required
+	}
+
+	return s
 }
 
 // UnmarshalJSON implements the json.Unmarshaler interface.
@@ -89,8 +117,11 @@ type method struct {
 	Params []Param     `json:"params"`
 	Refs   []string    `json:"-"`
 	Defs   Definitions `json:"defs"`
+	Type   string      `json:"type"`
 }
 
+var _ json.Unmarshaler = (*Param)(nil)
+
 // Param is an idempotent representation of an OpenRPC method parameter.
 // For the Ethereum RPC, this is always a ContentDescriptorObject and all
 // fields are decoded.  See [the specification] for more details.
@@ -110,9 +141,13 @@ func (p *Param) Description() string {
 	return p.param.description()
 }
 
-// Schema returns the schema of the parameter.
-func (p *Param) Schema() jsonschema.Schema {
-	return p.param.Schema
+// Schema returns the JSONSchema representation of the parameter.
+func (p *Param) Schema() *jsonschema.Schema {
+	s := &p.param.Schema
+	s.Title = p.Name()
+	s.Description = p.Description()
+
+	return s
 }
 
 // Required returns whether the parameter is required.
@@ -125,11 +160,6 @@ func (p *Param) Deprecated() bool {
 	return p.param.Deprecated
 }
 
-// MarshalJSON implements the json.Marshaler interface.
-func (p Param) MarshalJSON() ([]byte, error) {
-	return json.Marshal(p.param)
-}
-
 // UnmarshalJSON implements the json.Unmarshaler interface.
 func (p *Param) UnmarshalJSON(data []byte) error {
 	var err error

pkg/openrpc/error.go gen/internal/openrpc/error.gopkg/openrpc/error.go renamed to gen/internal/openrpc/error.go

@@ -9,14 +9,41 @@ import (
 	"github.com/stretchr/testify/require"
 	"gotest.tools/v3/golden"
 
-	"github.com/selesy/ethereum-mcp/pkg/openrpc"
+	"github.com/selesy/ethereum-mcp/gen/internal/openrpc"
 )
 
+func TestMethod_Schema(t *testing.T) {
+	t.Parallel()
+
+	data := golden.Get(t, "transaction.yaml")
+	assert.NotNil(t, data)
+
+	data, err := yaml.YAMLToJSON(data)
+	require.NoError(t, err)
+
+	var methods []openrpc.Method
+
+	require.NoError(t, json.Unmarshal(data, &methods))
+
+	for _, method := range methods {
+		// t.Log(method.Schema())
+
+		data, err := json.MarshalIndent(method.Schema(), "", "  ")
+		require.NoError(t, err)
+
+		_ = data
+		// t.Log(string(data))
+	}
+
+	// t.Fail()
+}
+
 func TestMethod_UnmarshalJSON(t *testing.T) {
 	t.Parallel()
 
 	t.Run("with execution-api example", func(t *testing.T) {
 		t.Parallel()
+
 		data := golden.Get(t, "transaction.yaml")
 		assert.NotNil(t, data)