Files
spark-mcp/internal/mcp/tools/spark_submit.go
T
tao.chenandClaude 4af166ea48 tools: spark_submit 记录拼装命令到 per-tool log
之前 d.Logger.Debug("spark_submit.built", "argv", cmd) 在 spark-submit
执行前 log 一次, 但 LOG_LEVEL=info 默认看不到, 拼装结果只活在
运行时 stack. 现在把 binary + argv 合并进 callLog.WithResult 写入
per-tool 文件 (data/logs/tools/<ts>_spark_submit_<id>.log), 每次
执行都在 tail -f 的现场能 grep 出来.

   tail -f data/logs/tools/*.log | grep -A1 '"argv"'
   -> 看每次实际传给 spark-submit 的 argv, 含 script_path 在最后

保留 Debug 调用: verbose 模式下用 base.Logger 直接看到完整 argv 跟
cluster_id, 不依赖 file tail.

两份记录 (Debug + WithResult) 字段一致, 都是 binary + argv, 排查
spark-submit 行为时可以交叉对照.

测试:
  - 已有 TestSparkSubmit_StructuredCommand 跑通, argv 字段被
    JSON marshal 进 resultRaw, 不需要新增测试
  - go test ./... 全绿

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-14 10:51:03 +08:00

309 lines
10 KiB
Go

package tools
import (
"context"
"fmt"
"log/slog"
"sort"
"strconv"
"github.com/mark3labs/mcp-go/mcp"
"spark-mcp-go/internal/executor"
)
const SparkSubmitName = "spark_submit"
// NewSparkSubmitTool returns the schema for the spark_submit MCP Tool.
func NewSparkSubmitTool() mcp.Tool {
return mcp.NewTool(SparkSubmitName,
mcp.WithDescription("Submit a Spark application to a configured cluster. The command is built in this order: --master, --queue, --executor-memory, --executor-cores, --num-executors, then --conf per spark_conf entry, then --flag value per extra_args entry, then script_path last. For script_path, pass the `path` field returned by upload_file (do not construct your own path). Returns {app_id, exit_code, stdout_tail, stderr_tail, duration_ms}. Binary is invoked as a child process — no shell, no command injection."),
mcp.WithString("cluster_id",
mcp.Required(),
mcp.Description("ID of the configured cluster (from list_clusters)"),
),
mcp.WithString("master",
mcp.Required(),
mcp.Description("Spark master URL, e.g. yarn, k8s://https://..."),
),
mcp.WithString("deploy_mode",
mcp.Required(),
mcp.Description("Required for forward compatibility; not currently emitted in the command by the builder (matches Python reference)."),
mcp.Enum("client", "cluster"),
),
mcp.WithString("script_path",
mcp.Required(),
mcp.Description("Absolute path to the script. Pass the `path` field returned by upload_file — do not construct your own path. The script is always the last argv element. Paths not minted by upload_file on this server are rejected."),
),
mcp.WithString("queue",
mcp.Required(),
mcp.Description("YARN queue name"),
),
mcp.WithString("executor_memory",
mcp.Required(),
mcp.Description("e.g. 4G"),
),
mcp.WithNumber("executor_cores",
mcp.Required(),
mcp.Description("Cores per executor (integer)"),
),
mcp.WithNumber("num_executors",
mcp.Required(),
mcp.Description("Static executor count (integer)"),
),
mcp.WithObject("spark_conf",
mcp.Description("Map of key=value pairs, each emitted as --conf key=value"),
mcp.AdditionalProperties(map[string]any{"type": "string"}),
),
mcp.WithObject("extra_args",
mcp.Description("Map of flag -> value, each emitted as --flag value"),
mcp.AdditionalProperties(map[string]any{"type": "string"}),
),
)
}
// SparkSubmitHandler runs spark-submit against the requested cluster.
func (d *Deps) SparkSubmitHandler(ctx context.Context, req mcp.CallToolRequest) (*mcp.CallToolResult, error) {
args := req.GetArguments()
clusterID, err := req.RequireString("cluster_id")
if err != nil {
return errResult("spark_submit: " + err.Error()), nil
}
master, err := requireNonEmptyString(args, "master")
if err != nil {
return errResult("spark_submit: " + err.Error()), nil
}
deployMode, err := req.RequireString("deploy_mode")
if err != nil {
return errResult("spark_submit: " + err.Error()), nil
}
scriptPath, err := req.RequireString("script_path")
if err != nil {
return errResult("spark_submit: " + err.Error()), nil
}
queue, err := requireNonEmptyString(args, "queue")
if err != nil {
return errResult("spark_submit: " + err.Error()), nil
}
executorMemory, err := requireNonEmptyString(args, "executor_memory")
if err != nil {
return errResult("spark_submit: " + err.Error()), nil
}
// Reject paths that didn't come through upload_file on this server.
// Cluster-local paths and arbitrary host paths are unreachable from the MCP
// server's spark-submit, so we fail fast with a clear message rather than
// letting spark-submit produce a confusing FileNotFoundException later.
// Placed after all required-string parses so error messages surface in
// field order (cluster_id, master, ..., script_path, queue, ...).
if _, err := d.UploadStore.Validate(scriptPath); err != nil {
if d.Logger != nil {
d.Logger.Warn("spark_submit.unminted_path_rejected", slog.String("path", scriptPath), slog.String("err", err.Error()))
}
return errResult(fmt.Sprintf("spark_submit: script_path %q is not from upload_file on this server; upload the file first via upload_file and pass back the path field", scriptPath)), nil
}
// deploy_mode is required for forward compatibility but the builder does not
// emit --deploy-mode, matching the Python reference's actual behavior. If the
// Go side needs --deploy-mode later, add it here and document the divergence.
if deployMode != "client" && deployMode != "cluster" {
return errResult("spark_submit: deploy_mode must be client or cluster"), nil
}
sparkConf, err := parseStringMap(args, "spark_conf")
if err != nil {
return errResult("spark_submit: " + err.Error()), nil
}
extraArgs, err := parseStringMap(args, "extra_args")
if err != nil {
return errResult("spark_submit: " + err.Error()), nil
}
executorCores, err := requireNonNegativeInt(args, "executor_cores")
if err != nil {
return errResult("spark_submit: " + err.Error()), nil
}
numExecutors, err := requireNonNegativeInt(args, "num_executors")
if err != nil {
return errResult("spark_submit: " + err.Error()), nil
}
callLog := startToolCall(ctx, d.Logger, SparkSubmitName, map[string]any{
"cluster_id": clusterID,
"master": master,
"deploy_mode": deployMode,
"script_path": scriptPath,
"queue": queue,
"executor_memory": executorMemory,
"executor_cores": executorCores,
"num_executors": numExecutors,
"spark_conf": sparkConf,
"extra_args": extraArgs,
})
defer callLog.End()
cl, err := d.ClusterRepo.Get(ctx, clusterID)
if err != nil {
callLog.WithError(err)
return errResult("spark_submit: cluster " + clusterID + ": " + err.Error()), nil
}
binary := cl.SparkSubmitExecuteBin
cmd := buildSparkSubmitCommand(SparkSubmitCommandOpts{
Master: master,
Queue: queue,
ExecutorMemory: executorMemory,
ExecutorCores: executorCores,
NumExecutors: numExecutors,
SparkConf: sparkConf,
ExtraArgs: extraArgs,
ScriptPath: scriptPath,
})
if d.Logger != nil {
d.Logger.Debug("spark_submit.built", "cluster_id", clusterID, "argv", cmd)
}
result, err := executor.Run(ctx, executor.SparkSubmitOpts{
Binary: binary,
Args: cmd,
Timeout: d.SparkSubmitTimeout,
})
if err != nil {
callLog.WithError(err)
// Even on error, result carries ExitCode/Stderr for the LLM.
if result != nil {
callLog.WithResult(map[string]any{
"binary": binary,
"argv": cmd,
"app_id": result.AppID,
"exit_code": result.ExitCode,
"duration_ms": result.DurationMS,
})
return textResult(encodeJSON(map[string]any{
"app_id": result.AppID,
"exit_code": result.ExitCode,
"stdout_tail": result.StdoutTail,
"stderr_tail": result.StderrTail,
"duration_ms": result.DurationMS,
"error": err.Error(),
})), nil
}
return errResult("spark_submit: " + err.Error()), nil
}
callLog.WithResult(map[string]any{
"binary": binary,
"argv": cmd,
"app_id": result.AppID,
"exit_code": result.ExitCode,
"duration_ms": result.DurationMS,
})
return textResult(encodeJSON(result)), nil
}
// SparkSubmitCommandOpts holds the structured arguments used to build the
// spark-submit argv. The returned argv does NOT include the binary itself.
type SparkSubmitCommandOpts struct {
Master string
Queue string
ExecutorMemory string
ExecutorCores int
NumExecutors int
SparkConf map[string]string
ExtraArgs map[string]string
ScriptPath string
}
// buildSparkSubmitCommand builds the post-binary argv for spark-submit.
// DefaultSubmitArgs is no longer prepended; the field is currently unused at
// runtime but kept for backward compatibility with the admin API. Removal is
// a separate follow-up.
func buildSparkSubmitCommand(opts SparkSubmitCommandOpts) []string {
cmd := []string{"--master", opts.Master}
cmd = append(cmd, "--queue", opts.Queue)
cmd = append(cmd, "--executor-memory", opts.ExecutorMemory)
cmd = append(cmd, "--executor-cores", strconv.Itoa(opts.ExecutorCores))
cmd = append(cmd, "--num-executors", strconv.Itoa(opts.NumExecutors))
for _, k := range sortedStringKeys(opts.SparkConf) {
cmd = append(cmd, "--conf", k+"="+opts.SparkConf[k])
}
for _, k := range sortedStringKeys(opts.ExtraArgs) {
cmd = append(cmd, "--"+k, opts.ExtraArgs[k])
}
cmd = append(cmd, opts.ScriptPath)
return cmd
}
// requireNonNegativeInt extracts an integer parameter from the request and
// rejects negative or non-integer values.
func requireNonNegativeInt(args map[string]any, key string) (int, error) {
v, ok := args[key]
if !ok || v == nil {
return 0, fmt.Errorf("%s is required", key)
}
switch n := v.(type) {
case int:
if n < 0 {
return 0, fmt.Errorf("%s must be a non-negative integer", key)
}
return n, nil
case float64:
ni := int(n)
if n < 0 || float64(ni) != n {
return 0, fmt.Errorf("%s must be a non-negative integer", key)
}
return ni, nil
default:
return 0, fmt.Errorf("%s must be a number", key)
}
}
// parseStringMap extracts an optional object whose values are strings.
func parseStringMap(args map[string]any, key string) (map[string]string, error) {
out := make(map[string]string)
v, ok := args[key]
if !ok || v == nil {
return out, nil
}
m, ok := v.(map[string]any)
if !ok {
return nil, fmt.Errorf("%s must be an object", key)
}
for k, val := range m {
s, ok := val.(string)
if !ok {
return nil, fmt.Errorf("%s[%q] must be a string", key, k)
}
out[k] = s
}
return out, nil
}
// sortedStringKeys returns the keys of m in deterministic order.
func sortedStringKeys(m map[string]string) []string {
keys := make([]string, 0, len(m))
for k := range m {
keys = append(keys, k)
}
sort.Strings(keys)
return keys
}
// requireNonEmptyString extracts a required string parameter and rejects empty
// values. MCP's RequireString already enforces presence/type; this enforces
// that the field is not blank.
func requireNonEmptyString(args map[string]any, key string) (string, error) {
s, ok := args[key].(string)
if !ok {
return "", fmt.Errorf("%s is required", key)
}
if s == "" {
return "", fmt.Errorf("%s is required", key)
}
return s, nil
}