Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
76 changes: 64 additions & 12 deletions pkg/mcp/tools/detail_tools.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,44 @@ import (
consolectx "github.com/apache/dubbo-admin/pkg/console/context"
"github.com/apache/dubbo-admin/pkg/console/model"
"github.com/apache/dubbo-admin/pkg/console/service"
"github.com/apache/dubbo-admin/pkg/mcp/types"
"github.com/apache/dubbo-admin/pkg/mcp/registry"
"github.com/apache/dubbo-admin/pkg/mcp/types"
)

// DetailRegistrar 详情查询工具注册器
type DetailRegistrar struct{}

// RegisterTools 实现 ToolRegistrar 接口
func (r *DetailRegistrar) RegisterTools(reg *registry.Registry) {
// 获取服务详情
reg.Register(types.ToolDef{
Name: "get_service_detail",
Description: "获取服务详情,包括语言和方法列表",
InputSchema: types.InputSchema{
Type: "object",
Required: []string{"serviceName"},
Properties: map[string]types.PropertyDef{
"serviceName": {
Type: "string",
Description: "服务名称",
},
"version": {
Type: "string",
Description: "服务版本",
},
"group": {
Type: "string",
Description: "服务分组",
},
"mesh": {
Type: "string",
Description: "Mesh 名称,默认使用配置中的默认 mesh",
},
},
},
Handler: GetServiceDetail,
})

// 获取服务的实例列表
reg.Register(types.ToolDef{
Name: "get_service_instances",
Expand Down Expand Up @@ -229,6 +258,29 @@ func (r *DetailRegistrar) RegisterTools(reg *registry.Registry) {
})
}

// GetServiceDetail 获取服务详情
func GetServiceDetail(ctx consolectx.Context, args map[string]any) (*types.ToolResult, error) {
helper := NewArgsHelper(args)
serviceName := helper.GetString("serviceName", "")
if serviceName == "" {
return ErrorResult(fmt.Errorf("required parameter 'serviceName' is missing")), nil
}

req := &model.ServiceDetailReq{
ServiceName: serviceName,
Version: helper.GetString("version", ""),
Group: helper.GetString("group", ""),
Mesh: GetMeshArg(ctx, args),
}

detail, err := service.GetServiceDetail(ctx, req)
if err != nil {
return ErrorResult(err), nil
}

return JsonResult(detail)
}

// GetServiceInstances 获取服务的实例列表
func GetServiceInstances(ctx consolectx.Context, args map[string]any) (*types.ToolResult, error) {
helper := NewArgsHelper(args)
Expand Down Expand Up @@ -357,9 +409,9 @@ func GetApplicationInstances(ctx consolectx.Context, args map[string]any) (*type

instances := extractAppInstances(result)
return JsonResult(map[string]any{
"appName": appName,
"instances": instances,
"totalCount": int(result.PageInfo.Total),
"appName": appName,
"instances": instances,
"totalCount": int(result.PageInfo.Total),
})
}

Expand Down Expand Up @@ -444,14 +496,14 @@ func extractAppInstances(result *model.SearchPaginationResult) []any {
for _, inst := range instances {
if inst != nil {
resultSlice = append(resultSlice, map[string]any{
"name": inst.Name,
"ip": inst.IP,
"appName": inst.AppName,
"deployState": inst.DeployState,
"registerState": inst.RegisterState,
"workloadName": inst.WorkloadName,
"createTime": inst.CreateTime,
"registerTime": inst.RegisterTime,
"name": inst.Name,
"ip": inst.IP,
"appName": inst.AppName,
"deployState": inst.DeployState,
"registerState": inst.RegisterState,
"workloadName": inst.WorkloadName,
"createTime": inst.CreateTime,
"registerTime": inst.RegisterTime,
})
}
}
Expand Down
240 changes: 240 additions & 0 deletions pkg/mcp/tools/detail_tools_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,240 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package tools

import (
"context"
"encoding/json"
"testing"

meshapi "github.com/apache/dubbo-admin/api/mesh/v1alpha1"
"github.com/apache/dubbo-admin/pkg/config/app"
discoverycfg "github.com/apache/dubbo-admin/pkg/config/discovery"
enginecfg "github.com/apache/dubbo-admin/pkg/config/engine"
consolectx "github.com/apache/dubbo-admin/pkg/console/context"
"github.com/apache/dubbo-admin/pkg/console/counter"
"github.com/apache/dubbo-admin/pkg/core/lock"
"github.com/apache/dubbo-admin/pkg/core/manager"
meshresource "github.com/apache/dubbo-admin/pkg/core/resource/apis/mesh/v1alpha1"
coremodel "github.com/apache/dubbo-admin/pkg/core/resource/model"
"github.com/apache/dubbo-admin/pkg/core/store/index"
"github.com/apache/dubbo-admin/pkg/mcp/registry"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func TestGetServiceDetailSchema(t *testing.T) {
reg := registry.NewRegistry()
(&DetailRegistrar{}).RegisterTools(reg)

tool, ok := reg.Get("get_service_detail")
if !ok {
t.Fatal("Tool 'get_service_detail' not registered")
}
if len(tool.InputSchema.Required) != 1 || tool.InputSchema.Required[0] != "serviceName" {
t.Errorf("Expected serviceName to be required, got %v", tool.InputSchema.Required)
}
for _, prop := range []string{"serviceName", "version", "group", "mesh"} {
if _, ok := tool.InputSchema.Properties[prop]; !ok {
t.Errorf("Missing property: %s", prop)
}
}
}

func TestGetServiceDetailMissingServiceName(t *testing.T) {
result, err := GetServiceDetail(newToolTestContext(nil), map[string]any{})
if err != nil {
t.Fatalf("GetServiceDetail returned unexpected error: %v", err)
}
if !result.IsError {
t.Fatal("Expected error result")
}
if got := result.Content[0].Text; got != "required parameter 'serviceName' is missing" {
t.Fatalf("Expected missing parameter error, got %q", got)
}
}

func TestGetServiceDetailSuccess(t *testing.T) {
const (
mesh = "mesh1"
serviceName = "org.apache.demo.DemoService"
version = "1.0.0"
group = "demo"
)
serviceKey := coremodel.BuildResourceKey(mesh, meshresource.BuildServiceIdentityKey(serviceName, version, group))
resource := &meshresource.ServiceResource{
ObjectMeta: metav1.ObjectMeta{Name: meshresource.BuildServiceIdentityKey(serviceName, version, group)},
Mesh: mesh,
Spec: &meshapi.Service{
Name: serviceName,
Version: version,
Group: group,
Language: "java",
Methods: []string{"sayHello"},
},
}
ctx := newToolTestContext(map[coremodel.ResourceKind]map[string]coremodel.Resource{
meshresource.ServiceKind: {
serviceKey: resource,
},
})

result, err := GetServiceDetail(ctx, map[string]any{
"serviceName": serviceName,
"version": version,
"group": group,
"mesh": mesh,
})
if err != nil {
t.Fatalf("GetServiceDetail returned unexpected error: %v", err)
}
if result.IsError {
t.Fatalf("Expected success result, got %q", result.Content[0].Text)
}

var payload struct {
Language string `json:"language"`
Methods []string `json:"methods"`
}
if err := json.Unmarshal([]byte(result.Content[0].Text), &payload); err != nil {
t.Fatalf("Failed to unmarshal result: %v", err)
}
if payload.Language != "java" {
t.Fatalf("Expected language java, got %q", payload.Language)
}
if len(payload.Methods) != 1 || payload.Methods[0] != "sayHello" {
t.Fatalf("Expected methods [sayHello], got %v", payload.Methods)
}
}

func TestGetServiceDistributionRegisteredHandler(t *testing.T) {
reg := registry.NewRegistry()
(&ServiceRegistrar{}).RegisterTools(reg)

tool, ok := reg.Get("get_service_distribution")
if !ok {
t.Fatal("Tool 'get_service_distribution' not registered")
}
if tool.Handler == nil {
t.Fatal("Tool 'get_service_distribution' handler is nil")
}
result, err := tool.Handler(newToolTestContext(nil), map[string]any{"serviceName": "missing"})
if err != nil {
t.Fatalf("get_service_distribution handler returned unexpected error: %v", err)
}
if result.IsError {
t.Fatalf("Expected success result with empty distribution, got %q", result.Content[0].Text)
}

var payload struct {
ServiceName string `json:"serviceName"`
Distribution []any `json:"distribution"`
TotalApps int `json:"totalApps"`
}
if err := json.Unmarshal([]byte(result.Content[0].Text), &payload); err != nil {
t.Fatalf("Failed to unmarshal result: %v", err)
}
if payload.ServiceName != "missing" {
t.Fatalf("Expected serviceName missing, got %q", payload.ServiceName)
}
if len(payload.Distribution) != 0 || payload.TotalApps != 0 {
t.Fatalf("Expected empty distribution, got distribution=%v totalApps=%d", payload.Distribution, payload.TotalApps)
}
}

func newToolTestContext(resources map[coremodel.ResourceKind]map[string]coremodel.Resource) consolectx.Context {
return &toolTestContext{
config: app.AdminConfig{
Discovery: []*discoverycfg.Config{{ID: "mesh1"}},
Engine: &enginecfg.Config{Name: "engine1"},
},
resourceManager: &toolTestResourceManager{resources: resources},
}
}

type toolTestContext struct {
config app.AdminConfig
resourceManager manager.ResourceManager
}

func (c *toolTestContext) ResourceManager() manager.ResourceManager {
return c.resourceManager
}

func (c *toolTestContext) CounterManager() counter.CounterManager {
return nil
}

func (c *toolTestContext) Config() app.AdminConfig {
return c.config
}

func (c *toolTestContext) AppContext() context.Context {
return context.Background()
}

func (c *toolTestContext) LockManager() lock.Lock {
return nil
}

type toolTestResourceManager struct {
resources map[coremodel.ResourceKind]map[string]coremodel.Resource
}

func (m *toolTestResourceManager) GetByKey(rk coremodel.ResourceKind, key string) (coremodel.Resource, bool, error) {
byKind := m.resources[rk]
if byKind == nil {
return nil, false, nil
}
resource, ok := byKind[key]
return resource, ok, nil
}

func (m *toolTestResourceManager) GetByKeys(rk coremodel.ResourceKind, keys []string) ([]coremodel.Resource, error) {
byKind := m.resources[rk]
result := make([]coremodel.Resource, 0, len(keys))
for _, key := range keys {
if resource, ok := byKind[key]; ok {
result = append(result, resource)
}
}
return result, nil
}

func (m *toolTestResourceManager) ListByIndexes(coremodel.ResourceKind, []index.IndexCondition) ([]coremodel.Resource, error) {
return nil, nil
}

func (m *toolTestResourceManager) PageListByIndexes(coremodel.ResourceKind, []index.IndexCondition, coremodel.PageReq) (*coremodel.PageData[coremodel.Resource], error) {
return coremodel.NewPageData[coremodel.Resource](0, 0, 0, nil), nil
}

func (m *toolTestResourceManager) Add(coremodel.Resource) error {
return nil
}

func (m *toolTestResourceManager) Update(coremodel.Resource) error {
return nil
}

func (m *toolTestResourceManager) Upsert(coremodel.Resource) error {
return nil
}

func (m *toolTestResourceManager) DeleteByKey(coremodel.ResourceKind, string, string) error {
return nil
}
Loading