Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

10.8 KB
Raw Blame
// SiYuan - https://github.com/siyuan-note/siyuan
// Copyright (c) 2020-present, b3log.org
// SPDX-License-Identifier: AGPL-3.0-or-later

package mcp

import (
	"context"
	"encoding/json"
	"errors"
	"fmt"
	"net/http"
	"sync"

	"github.com/gin-gonic/gin"
	mcpsdk "github.com/modelcontextprotocol/go-sdk/mcp"
	"github.com/siyuan-note/logging"
	"github.com/siyuan-note/siyuan/kernel/mcp/tools"
	"github.com/siyuan-note/siyuan/kernel/model"
	"github.com/siyuan-note/siyuan/kernel/util"
)

const protocolVersion20260728 = "2026-07-28"

var (
	httpHandlerOnce          sync.Once
	httpHandler              http.Handler
	externalToolProjectionMu sync.RWMutex
	externalToolProjection   *toolProjection
)

type toolProjection struct {
	mu      sync.RWMutex
	server  *mcpsdk.Server
	allows  func(*tools.Tool) bool
	exposed map[string]*tools.Tool
}

func Serve(ginServer *gin.Engine) {
	handler := getHTTPHandler()

	// MCP 工具暴露任意工作区文件读写删、SQL、插件分发等管理级原语,必须要求管理员角色,
	// 否则 Publish 匿名模式注入的 RoleReader JWT 可经此链路越权调用全部工具。
	ginServer.POST("/mcp", model.CheckMCPAuth, model.CheckAdminRole, model.CheckReadonly, serveHTTP(handler))
	ginServer.GET("/mcp", model.CheckMCPAuth, model.CheckAdminRole, serveHTTP(handler))
	ginServer.DELETE("/mcp", model.CheckMCPAuth, model.CheckAdminRole, model.CheckReadonly, serveHTTP(handler))
}

func getHTTPHandler() http.Handler {
	httpHandlerOnce.Do(func() {
		server := newServer()
		projection := newToolProjection(server, externalMCPToolAllowed)
		externalToolProjectionMu.Lock()
		externalToolProjection = projection
		externalToolProjectionMu.Unlock()
		tools.ObserveRegistry(func(name string, tool *tools.Tool) {
			projection.sync(name, tool)
		})
		httpHandler = newHTTPHandler(server)
	})
	return httpHandler
}

func newToolProjection(server *mcpsdk.Server, allows func(*tools.Tool) bool) *toolProjection {
	return &toolProjection{server: server, allows: allows, exposed: map[string]*tools.Tool{}}
}

func (projection *toolProjection) sync(name string, tool *tools.Tool) {
	projection.mu.Lock()
	defer projection.mu.Unlock()

	current := projection.exposed[name]
	if tool == nil || !projection.allows(tool) {
		if current != nil {
			delete(projection.exposed, name)
			projection.server.RemoveTools(name)
		}
		return
	}
	if current == tool {
		return
	}
	if syncGuardedTool(projection.server, name, tool, func() bool {
		return projection.allowsCall(name, tool)
	}) {
		projection.exposed[name] = tool
	} else {
		delete(projection.exposed, name)
	}
}

func (projection *toolProjection) allowsCall(name string, tool *tools.Tool) bool {
	projection.mu.RLock()
	current := projection.exposed[name]
	projection.mu.RUnlock()
	return current == tool && projection.allows(tool)
}

func (projection *toolProjection) refresh() {
	allTools := tools.GetAllTools()
	registered := make(map[string]bool, len(allTools))
	for _, tool := range allTools {
		registered[tool.Name] = true
		projection.sync(tool.Name, tool)
	}

	projection.mu.RLock()
	exposedNames := make([]string, 0, len(projection.exposed))
	for name := range projection.exposed {
		if !registered[name] {
			exposedNames = append(exposedNames, name)
		}
	}
	projection.mu.RUnlock()
	for _, name := range exposedNames {
		projection.sync(name, nil)
	}
}

// RefreshToolExposure 根据当前配置刷新 SiYuan MCP 服务对外提供的能力。
func RefreshToolExposure() {
	externalToolProjectionMu.RLock()
	projection := externalToolProjection
	externalToolProjectionMu.RUnlock()
	if projection != nil {
		projection.refresh()
	}
}

func externalMCPToolAllowed(tool *tools.Tool) bool {
	confAIReadSnapshot := model.Conf.LoadAI()

	if tool == nil || tool.AgentOnly || tool.Source == "mcp" || tool.Runtime == "mcp" {
		return false
	}
	if model.Conf == nil || confAIReadSnapshot == nil || confAIReadSnapshot.MCP == nil {
		return true
	}
	return confAIReadSnapshot.MCP.ExposurePolicy.Allows(tools.CapabilityIDForTool(tool))
}

func newServer() *mcpsdk.Server {
	server := mcpsdk.NewServer(&mcpsdk.Implementation{
		Name:    "SiYuan",
		Version: util.Ver,
	}, &mcpsdk.ServerOptions{
		Capabilities: &mcpsdk.ServerCapabilities{},
	})
	server.AddReceivingMiddleware(privateCacheMiddleware())
	return server
}

func privateCacheMiddleware() mcpsdk.Middleware {
	return func(next mcpsdk.MethodHandler) mcpsdk.MethodHandler {
		return func(ctx context.Context, method string, request mcpsdk.Request) (mcpsdk.Result, error) {
			result, err := next(ctx, method, request)
			if err != nil {
				return result, err
			}
			// SDK results may hold typed nil pointers, which still match the type switch.
			switch cacheable := result.(type) {
			case *mcpsdk.DiscoverResult:
				if cacheable != nil {
					cacheable.CacheScope = "private"
				}
			case *mcpsdk.ListToolsResult:
				if cacheable != nil {
					cacheable.CacheScope = "private"
				}
			case *mcpsdk.ListPromptsResult:
				if cacheable != nil {
					cacheable.CacheScope = "private"
				}
			case *mcpsdk.ListResourcesResult:
				if cacheable != nil {
					cacheable.CacheScope = "private"
				}
			case *mcpsdk.ListResourceTemplatesResult:
				if cacheable != nil {
					cacheable.CacheScope = "private"
				}
			case *mcpsdk.ReadResourceResult:
				if cacheable != nil {
					cacheable.CacheScope = "private"
				}
			}
			return result, err
		}
	}
}

func newHTTPHandler(server *mcpsdk.Server) http.Handler {
	getServer := func(*http.Request) *mcpsdk.Server {
		return server
	}
	modern := mcpsdk.NewStreamableHTTPHandler(getServer, &mcpsdk.StreamableHTTPOptions{
		Stateless:                    true,
		JSONResponse:                 true,
		DisableLocalhostProtection:   true,
		PropagateRequestCancellation: true,
	})
	legacy := mcpsdk.NewStreamableHTTPHandler(getServer, &mcpsdk.StreamableHTTPOptions{
		JSONResponse:               true,
		DisableLocalhostProtection: true,
	})

	handler := http.HandlerFunc(func(writer http.ResponseWriter, request *http.Request) {
		if isModernRequest(request) {
			modern.ServeHTTP(writer, request)
			return
		}
		legacy.ServeHTTP(writer, request)
	})
	return http.NewCrossOriginProtection().Handler(handler)
}

func isModernRequest(request *http.Request) bool {
	version := request.Header.Get("MCP-Protocol-Version")
	return version >= protocolVersion20260728
}

func serveHTTP(handler http.Handler) gin.HandlerFunc {
	scopedHandler := withEncryptedBoxOperationScope(handler)
	return func(ginContext *gin.Context) {
		scopedHandler.ServeHTTP(ginContext.Writer, ginContext.Request)
	}
}

func syncTool(server *mcpsdk.Server, name string, tool *tools.Tool) {
	syncGuardedTool(server, name, tool, nil)
}

func syncGuardedTool(server *mcpsdk.Server, name string, tool *tools.Tool, allowed func() bool) (synced bool) {
	if tool == nil {
		server.RemoveTools(name)
		return true
	}
	validator, err := tools.CompileToolValidator(tool)
	if err != nil {
		server.RemoveTools(name)
		logging.LogWarnf("mcp: skip invalid server tool [%s]: %v", name, err)
		return false
	}
	defer func() {
		if recovered := recover(); recovered != nil {
			server.RemoveTools(name)
			logging.LogWarnf("mcp: skip invalid server tool [%s]: %v", name, recovered)
			synced = false
		}
	}()

	sdkTool := &mcpsdk.Tool{
		Name:        name,
		Title:       tool.Title,
		Description: tool.Description,
		InputSchema: tool.InputSchema,
	}
	if tool.OutputSchema != nil {
		sdkTool.OutputSchema = tool.OutputSchema
	}
	if tool.ReadOnlyHint {
		sdkTool.Annotations = &mcpsdk.ToolAnnotations{ReadOnlyHint: true}
	}

	server.AddTool(sdkTool, func(ctx context.Context, request *mcpsdk.CallToolRequest) (*mcpsdk.CallToolResult, error) {
		if allowed != nil && !allowed() {
			return toolErrorResult("MCP capability is disabled or no longer available"), nil
		}
		arguments := map[string]any{}
		if len(request.Params.Arguments) > 0 {
			if err := json.Unmarshal(request.Params.Arguments, &arguments); err != nil {
				return nil, fmt.Errorf("invalid tool arguments: %w", err)
			}
		}
		if arguments == nil {
			arguments = map[string]any{}
		}
		if err := validator.ValidateInputContext(ctx, arguments); err != nil {
			return toolErrorResult(fmt.Sprintf("invalid tool arguments: %v", err)), nil
		}
		releaseBoxLeases := func() {}
		if tool.BoxLeaseResolver != nil {
			leaseContext, contextErr := requestOperationContext(ctx, request)
			if contextErr != nil {
				logging.LogWarnf("mcp: acquire request operation scope for tool [%s] failed: %v", name, contextErr)
				return toolErrorResult(contextErr.Error()), nil
			}
			releaseBoxLeases, err = model.AcquireEncryptedBoxOperations(leaseContext, tool.BoxLeaseResolver(arguments))
			if err != nil {
				if errors.Is(err, model.ErrEncryptedBoxNotUnlocked) {
					return toolErrorResult("encrypted notebook is locked, please unlock it first"), nil
				}
				logging.LogWarnf("mcp: acquire encrypted notebook operations for tool [%s] failed: %v", name, err)
				return toolErrorResult(err.Error()), nil
			}
		}
		defer releaseBoxLeases()

		var (
			result tools.CallToolResult
			err    error
		)
		if tool.ContextHandler != nil {
			result, err = tool.ContextHandler(ctx, arguments)
		} else if tool.Handler != nil {
			result, err = tool.Handler(arguments)
		} else {
			err = fmt.Errorf("tool handler is not configured")
		}
		if err != nil {
			return toolErrorResult(err.Error()), nil
		}
		if err = validator.ValidateOutputContext(ctx, result); err != nil {
			return toolErrorResult(fmt.Sprintf(
				"invalid tool output after execution; execution result may have side effects and must not be retried automatically: %v",
				err)), nil
		}

		content := make([]mcpsdk.Content, 0, len(result.Content))
		for _, item := range result.Content {
			converted, convertErr := convertContentItem(item)
			if convertErr != nil {
				return toolErrorResult(fmt.Sprintf(
					"invalid tool content after execution; execution result may have side effects and must not be retried automatically: %v",
					convertErr)), nil
			}
			content = append(content, converted)
		}
		structuredContent := result.StructuredContent
		if result.HasStructuredContent() && structuredContent == nil {
			structuredContent = json.RawMessage("null")
		}
		return &mcpsdk.CallToolResult{
			Content:           content,
			StructuredContent: structuredContent,
			IsError:           result.IsError,
		}, nil
	})
	return true
}

func convertContentItem(item tools.ContentItem) (mcpsdk.Content, error) {
	data, err := json.Marshal(item)
	if err != nil {
		return nil, err
	}
	wrapped := append([]byte(`{"content":[`), data...)
	wrapped = append(wrapped, []byte(`]}`)...)
	var result mcpsdk.CallToolResult
	if err = json.Unmarshal(wrapped, &result); err != nil {
		return nil, err
	}
	if len(result.Content) != 1 {
		return nil, fmt.Errorf("expected one content item, got %d", len(result.Content))
	}
	return result.Content[0], nil
}

func toolErrorResult(message string) *mcpsdk.CallToolResult {
	return &mcpsdk.CallToolResult{
		Content: []mcpsdk.Content{&mcpsdk.TextContent{Text: message}},
		IsError: true,
	}
}