mirror of
https://github.com/siyuan-note/siyuan.git
synced 2026-06-29 23:35:53 +00:00
* 🎨 Enhance MCP tool management with registration, unregistration, and sanitization features * 🎨 Enhance MCP tool management with registration, unregistration, and sanitization features * 🎨 Improve registerTool function with enhanced argument validation and output schema support * 🎨 Enhance error handling and output schema in MCP tool registration * 🎨 Add state check in invokeMcpTool to prevent invocation when plugin is not running
226 lines
7.1 KiB
Go
226 lines
7.1 KiB
Go
// SiYuan - Refactor your thinking
|
|
// Copyright (c) 2020-present, b3log.org
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package plugin
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
|
|
"github.com/dop251/goja"
|
|
"github.com/samber/lo"
|
|
"github.com/siyuan-note/logging"
|
|
"github.com/siyuan-note/siyuan/kernel/mcp/tools"
|
|
"github.com/siyuan-note/siyuan/kernel/util"
|
|
)
|
|
|
|
// pluginToolName builds the fully-qualified MCP tool name for a plugin-local tool name.
|
|
// Pattern: plugin__<sanitized-plugin>__<sanitized-tool>
|
|
func pluginToolName(pluginName, toolName string) string {
|
|
return fmt.Sprintf("plugin__%s__%s", util.SanitizeName(pluginName), util.SanitizeName(toolName))
|
|
}
|
|
|
|
// injectMcp adds siyuan.mcp to the plugin JS sandbox.
|
|
func injectMcp(p *KernelPlugin, rt *goja.Runtime, siyuan *goja.Object) (err error) {
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
err = fmt.Errorf("injectMcp: %v", r)
|
|
}
|
|
}()
|
|
|
|
mcp := rt.NewObject()
|
|
|
|
// siyuan.mcp.registerTool(name, config, handler) → Promise<IRegisteredTool>
|
|
lo.Must0(mcp.Set("registerTool", rt.ToValue(func(call goja.FunctionCall, rt *goja.Runtime) goja.Value {
|
|
promise, resolve, reject := rt.NewPromise()
|
|
|
|
var name string
|
|
var title string
|
|
var description string
|
|
var inputSchema *tools.ToolSchema
|
|
var outputSchema *tools.ToolSchema
|
|
var handler goja.Callable
|
|
|
|
argErr := func() (err error) {
|
|
if len(call.Arguments) < 3 {
|
|
err = fmt.Errorf("registerTool requires 3 arguments: name, config, handler")
|
|
return
|
|
} else {
|
|
if s := call.Argument(0); goja.IsString(s) {
|
|
name = s.String()
|
|
} else {
|
|
err = fmt.Errorf("first argument must be a tool name string")
|
|
return
|
|
}
|
|
|
|
if c := call.Argument(1); isJsValueNotNull(c) {
|
|
configObj := c.ToObject(rt)
|
|
if configObj != nil {
|
|
if titleValue := configObj.Get("title"); goja.IsString(titleValue) {
|
|
title = titleValue.String()
|
|
}
|
|
if descriptionValue := configObj.Get("description"); goja.IsString(descriptionValue) {
|
|
description = descriptionValue.String()
|
|
} else {
|
|
err = fmt.Errorf("config.description is required and must be a string")
|
|
return
|
|
}
|
|
if inputSchemaValue := configObj.Get("inputSchema"); isJsValueNotNull(inputSchemaValue) {
|
|
if inputSchema, err = jsSchemaToGoSchema(rt, inputSchemaValue); err != nil {
|
|
return
|
|
}
|
|
} else {
|
|
err = fmt.Errorf("config.inputSchema is required")
|
|
return
|
|
}
|
|
if outputSchemaValue := configObj.Get("outputSchema"); isJsValueNotNull(outputSchemaValue) {
|
|
if outputSchema, err = jsSchemaToGoSchema(rt, outputSchemaValue); err != nil {
|
|
return
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
err = fmt.Errorf("second argument must be a config object")
|
|
return
|
|
}
|
|
if fn, ok := goja.AssertFunction(call.Argument(2)); ok {
|
|
handler = fn
|
|
} else {
|
|
err = fmt.Errorf("third argument must be a handler function")
|
|
return
|
|
}
|
|
return
|
|
}
|
|
}()
|
|
|
|
runErr := p.worker.Run(func(rt *goja.Runtime) (result any, err error) {
|
|
if argErr != nil {
|
|
err = argErr
|
|
return
|
|
}
|
|
|
|
fullToolName := pluginToolName(p.Name, name)
|
|
|
|
tool := &tools.Tool{
|
|
Name: fullToolName,
|
|
Title: title,
|
|
Description: description,
|
|
InputSchema: *inputSchema,
|
|
OutputSchema: outputSchema,
|
|
Handler: func(args map[string]interface{}) (tools.CallToolResult, error) {
|
|
return p.invokeMcpTool(handler, args)
|
|
},
|
|
}
|
|
|
|
p.registerMcpTool(name, tool)
|
|
|
|
result = map[string]any{
|
|
"name": fullToolName,
|
|
"title": title,
|
|
"description": description,
|
|
"inputSchema": inputSchema,
|
|
"outputSchema": outputSchema,
|
|
}
|
|
return
|
|
}, func(rt *goja.Runtime, result any, err error) {
|
|
if lo.IsNil(err) {
|
|
if resolveErr := resolve(result); resolveErr != nil {
|
|
logging.LogErrorf("[plugin:%s] siyuan.mcp.registerTool resolve: %v", p.Name, resolveErr)
|
|
}
|
|
} else {
|
|
if rejectErr := reject(rt.NewGoError(err)); rejectErr != nil {
|
|
logging.LogErrorf("[plugin:%s] siyuan.mcp.registerTool reject: %v", p.Name, rejectErr)
|
|
}
|
|
}
|
|
})
|
|
if runErr != nil {
|
|
logging.LogErrorf("[plugin:%s] siyuan.mcp.registerTool worker run: %v", p.Name, runErr)
|
|
if rejectErr := reject(rt.NewGoError(runErr)); rejectErr != nil {
|
|
logging.LogErrorf("[plugin:%s] siyuan.mcp.registerTool reject on run error: %v", p.Name, rejectErr)
|
|
}
|
|
}
|
|
|
|
return rt.ToValue(promise)
|
|
})))
|
|
|
|
// siyuan.mcp.unregisterTool(name) → Promise<void>
|
|
lo.Must0(mcp.Set("unregisterTool", rt.ToValue(func(call goja.FunctionCall, rt *goja.Runtime) goja.Value {
|
|
promise, resolve, reject := rt.NewPromise()
|
|
|
|
var argErr error
|
|
var toolName string
|
|
|
|
if len(call.Arguments) < 1 {
|
|
argErr = fmt.Errorf("unregisterTool requires 1 argument: name")
|
|
} else if s := call.Argument(0); goja.IsString(s) {
|
|
toolName = s.String()
|
|
} else {
|
|
argErr = fmt.Errorf("first argument must be a tool name string")
|
|
}
|
|
|
|
if argErr != nil {
|
|
_ = reject(rt.NewGoError(argErr))
|
|
return rt.ToValue(promise)
|
|
}
|
|
|
|
runErr := p.worker.Run(func(rt *goja.Runtime) (result any, err error) {
|
|
p.unregisterMcpTool(toolName)
|
|
return
|
|
}, func(workerRT *goja.Runtime, result any, err error) {
|
|
if lo.IsNil(err) {
|
|
if resolveErr := resolve(result); resolveErr != nil {
|
|
logging.LogErrorf("[plugin:%s] siyuan.mcp.unregisterTool resolve: %v", p.Name, resolveErr)
|
|
}
|
|
} else {
|
|
if rejectErr := reject(workerRT.NewGoError(err)); rejectErr != nil {
|
|
logging.LogErrorf("[plugin:%s] siyuan.mcp.unregisterTool reject: %v", p.Name, rejectErr)
|
|
}
|
|
}
|
|
})
|
|
if runErr != nil {
|
|
logging.LogErrorf("[plugin:%s] siyuan.mcp.unregisterTool worker run: %v", p.Name, runErr)
|
|
if rejectErr := reject(rt.NewGoError(runErr)); rejectErr != nil {
|
|
logging.LogErrorf("[plugin:%s] siyuan.mcp.unregisterTool reject on run error: %v", p.Name, rejectErr)
|
|
}
|
|
}
|
|
|
|
return rt.ToValue(promise)
|
|
})))
|
|
|
|
lo.Must0(ObjectFreeze(rt, mcp))
|
|
lo.Must0(siyuan.Set("mcp", mcp))
|
|
return
|
|
}
|
|
|
|
// jsSchemaToGoSchema converts a JavaScript value representing a tool schema into a Go ToolSchema struct.
|
|
func jsSchemaToGoSchema(rt *goja.Runtime, value goja.Value) (toolSchema *tools.ToolSchema, err error) {
|
|
schemaJson, marshalErr := value.ToObject(rt).MarshalJSON()
|
|
if marshalErr != nil {
|
|
err = fmt.Errorf("failed to serialize inputSchema: %v", marshalErr)
|
|
return
|
|
}
|
|
|
|
schema := &tools.ToolSchema{}
|
|
unmarshalErr := json.Unmarshal(schemaJson, schema)
|
|
if unmarshalErr != nil {
|
|
err = fmt.Errorf("invalid json schema: %v", unmarshalErr)
|
|
return
|
|
}
|
|
|
|
toolSchema = schema
|
|
return
|
|
}
|