Enterprise-Knowledge-Base/internal/agent/tools/sequentialthinking.go

package tools

import (
	"context"
	"fmt"

	"github.com/Tencent/WeKnora/internal/logger"
	"github.com/Tencent/WeKnora/internal/types"
)

// SequentialThinkingTool implements a dynamic and reflective problem-solving tool
// This tool helps analyze problems through a flexible thinking process that can adapt and evolve
type SequentialThinkingTool struct {
	BaseTool
	thoughtHistory []ThoughtData
	branches       map[string][]ThoughtData
}

// ThoughtData represents a single thought in the sequential thinking process
type ThoughtData struct {
	Thought           string `json:"thought"`
	ThoughtNumber     int    `json:"thought_number"`
	TotalThoughts     int    `json:"total_thoughts"`
	IsRevision        bool   `json:"is_revision,omitempty"`
	RevisesThought    *int   `json:"revises_thought,omitempty"`
	BranchFromThought *int   `json:"branch_from_thought,omitempty"`
	BranchID          string `json:"branch_id,omitempty"`
	NeedsMoreThoughts bool   `json:"needs_more_thoughts,omitempty"`
	NextThoughtNeeded bool   `json:"next_thought_needed"`
}

// NewSequentialThinkingTool creates a new sequential thinking tool instance
func NewSequentialThinkingTool() *SequentialThinkingTool {
	description := `A detailed tool for dynamic and reflective problem-solving through thoughts.

This tool helps analyze problems through a flexible thinking process that can adapt and evolve.

Each thought can build on, question, or revise previous insights as understanding deepens.

## When to Use This Tool

- Breaking down complex problems into steps
- Planning and design with room for revision
- Analysis that might need course correction
- Problems where the full scope might not be clear initially
- Problems that require a multi-step solution
- Tasks that need to maintain context over multiple steps
- Situations where irrelevant information needs to be filtered out

## Key Features

- You can adjust total_thoughts up or down as you progress
- You can question or revise previous thoughts
- You can add more thoughts even after reaching what seemed like the end
- You can express uncertainty and explore alternative approaches
- Not every thought needs to build linearly - you can branch or backtrack
- Generates a solution hypothesis
- Verifies the hypothesis based on the Chain of Thought steps
- Repeats the process until satisfied
- Provides a correct answer

## Parameters Explained

- **thought**: Your current thinking step, which can include:
  * Regular analytical steps
  * Revisions of previous thoughts
  * Questions about previous decisions
  * Realizations about needing more analysis
  * Changes in approach
  * Hypothesis generation
  * Hypothesis verification

- **next_thought_needed**: True if you need more thinking, even if at what seemed like the end
- **thought_number**: Current number in sequence (can go beyond initial total if needed)
- **total_thoughts**: Current estimate of thoughts needed (can be adjusted up/down)
- **is_revision**: A boolean indicating if this thought revises previous thinking
- **revises_thought**: If is_revision is true, which thought number is being reconsidered
- **branch_from_thought**: If branching, which thought number is the branching point
- **branch_id**: Identifier for the current branch (if any)
- **needs_more_thoughts**: If reaching end but realizing more thoughts needed

## Best Practices

1. Start with an initial estimate of needed thoughts, but be ready to adjust
2. Feel free to question or revise previous thoughts
3. Don't hesitate to add more thoughts if needed, even at the "end"
4. Express uncertainty when present
5. Mark thoughts that revise previous thinking or branch into new paths
6. Ignore information that is irrelevant to the current step
7. Generate a solution hypothesis when appropriate
8. Verify the hypothesis based on the Chain of Thought steps
9. Repeat the process until satisfied with the solution
10. Provide a single, ideally correct answer as the final output
11. Only set next_thought_needed to false when truly done and a satisfactory answer is reached`

	return &SequentialThinkingTool{
		BaseTool:       NewBaseTool("thinking", description),
		thoughtHistory: make([]ThoughtData, 0),
		branches:       make(map[string][]ThoughtData),
	}
}

// Parameters returns the JSON schema for the tool's parameters
func (t *SequentialThinkingTool) Parameters() map[string]interface{} {
	return map[string]interface{}{
		"type": "object",
		"properties": map[string]interface{}{
			"thought": map[string]interface{}{
				"type":        "string",
				"description": "Your current thinking step",
			},
			"nextThoughtNeeded": map[string]interface{}{
				"type":        "boolean",
				"description": "Whether another thought step is needed",
			},
			"thoughtNumber": map[string]interface{}{
				"type":        "integer",
				"description": "Current thought number (numeric value, e.g., 1, 2, 3)",
				"minimum":     1,
			},
			"totalThoughts": map[string]interface{}{
				"type":        "integer",
				"description": "Estimated total thoughts needed (numeric value, e.g., 5, 10)",
				"minimum":     5,
			},
			"isRevision": map[string]interface{}{
				"type":        "boolean",
				"description": "Whether this revises previous thinking",
			},
			"revisesThought": map[string]interface{}{
				"type":        "integer",
				"description": "Which thought is being reconsidered",
				"minimum":     1,
			},
			"branchFromThought": map[string]interface{}{
				"type":        "integer",
				"description": "Branching point thought number",
				"minimum":     1,
			},
			"branchId": map[string]interface{}{
				"type":        "string",
				"description": "Branch identifier",
			},
			"needsMoreThoughts": map[string]interface{}{
				"type":        "boolean",
				"description": "If more thoughts are needed",
			},
		},
		"required": []string{"thought", "nextThoughtNeeded", "thoughtNumber", "totalThoughts"},
	}
}

// Execute executes the sequential thinking tool
func (t *SequentialThinkingTool) Execute(ctx context.Context, args map[string]interface{}) (*types.ToolResult, error) {
	logger.Infof(ctx, "[Tool][SequentialThinking] Execute started")

	// Validate and parse input
	thoughtData, err := t.validateThoughtData(args)
	if err != nil {
		logger.Errorf(ctx, "[Tool][SequentialThinking] Validation failed: %v", err)
		return &types.ToolResult{
			Success: false,
			Error:   fmt.Sprintf("Validation failed: %v", err),
		}, err
	}

	// Adjust totalThoughts if thoughtNumber exceeds it
	if thoughtData.ThoughtNumber > thoughtData.TotalThoughts {
		thoughtData.TotalThoughts = thoughtData.ThoughtNumber
	}

	// Add to thought history
	t.thoughtHistory = append(t.thoughtHistory, thoughtData)

	// Handle branching
	if thoughtData.BranchFromThought != nil && thoughtData.BranchID != "" {
		if t.branches[thoughtData.BranchID] == nil {
			t.branches[thoughtData.BranchID] = make([]ThoughtData, 0)
		}
		t.branches[thoughtData.BranchID] = append(t.branches[thoughtData.BranchID], thoughtData)
	}

	logger.Debugf(ctx, "[Tool][SequentialThinking] %s", thoughtData.Thought)

	// Prepare response data
	branchKeys := make([]string, 0, len(t.branches))
	for k := range t.branches {
		branchKeys = append(branchKeys, k)
	}

	incomplete := thoughtData.NextThoughtNeeded || thoughtData.NeedsMoreThoughts || thoughtData.ThoughtNumber < thoughtData.TotalThoughts

	responseData := map[string]interface{}{
		"thought_number":         thoughtData.ThoughtNumber,
		"total_thoughts":         thoughtData.TotalThoughts,
		"next_thought_needed":    thoughtData.NextThoughtNeeded,
		"branches":               branchKeys,
		"thought_history_length": len(t.thoughtHistory),
		"display_type":           "thinking",
		"thought":                thoughtData.Thought,
		"incomplete_steps":       incomplete,
	}

	logger.Infof(ctx, "[Tool][SequentialThinking] Execute completed - Thought %d/%d", thoughtData.ThoughtNumber, thoughtData.TotalThoughts)

	outputMsg := "Thought process recorded"
	if incomplete {
		outputMsg = "Thought process recorded - unfinished steps remain, continue exploring and calling tools"
	}

	return &types.ToolResult{
		Success: true,
		Output:  outputMsg,
		Data:    responseData,
	}, nil
}

// validateThoughtData validates and parses the input arguments
func (t *SequentialThinkingTool) validateThoughtData(input map[string]interface{}) (ThoughtData, error) {
	var data ThoughtData

	// Validate thought (required)
	thought, ok := input["thought"].(string)
	if !ok || thought == "" {
		return data, fmt.Errorf("invalid thought: must be a non-empty string")
	}
	data.Thought = thought

	// Validate thoughtNumber (required)
	thoughtNumber, ok := input["thoughtNumber"].(float64)
	if !ok {
		// Try int type
		if num, ok := input["thoughtNumber"].(int); ok {
			data.ThoughtNumber = num
		} else {
			return data, fmt.Errorf("invalid thoughtNumber: must be a number")
		}
	} else {
		data.ThoughtNumber = int(thoughtNumber)
	}
	if data.ThoughtNumber < 1 {
		return data, fmt.Errorf("invalid thoughtNumber: must be >= 1")
	}

	// Validate totalThoughts (required)
	totalThoughts, ok := input["totalThoughts"].(float64)
	if !ok {
		// Try int type
		if num, ok := input["totalThoughts"].(int); ok {
			data.TotalThoughts = num
		} else {
			return data, fmt.Errorf("invalid totalThoughts: must be a number")
		}
	} else {
		data.TotalThoughts = int(totalThoughts)
	}
	if data.TotalThoughts < 1 {
		return data, fmt.Errorf("invalid totalThoughts: must be >= 1")
	}

	// Validate nextThoughtNeeded (required)
	nextThoughtNeeded, ok := input["nextThoughtNeeded"].(bool)
	if !ok {
		return data, fmt.Errorf("invalid nextThoughtNeeded: must be a boolean")
	}
	data.NextThoughtNeeded = nextThoughtNeeded

	// Optional fields
	if isRevision, ok := input["isRevision"].(bool); ok {
		data.IsRevision = isRevision
	}

	if revisesThought, ok := input["revisesThought"].(float64); ok {
		num := int(revisesThought)
		data.RevisesThought = &num
	} else if revisesThought, ok := input["revisesThought"].(int); ok {
		data.RevisesThought = &revisesThought
	}

	if branchFromThought, ok := input["branchFromThought"].(float64); ok {
		num := int(branchFromThought)
		data.BranchFromThought = &num
	} else if branchFromThought, ok := input["branchFromThought"].(int); ok {
		data.BranchFromThought = &branchFromThought
	}

	if branchID, ok := input["branchId"].(string); ok {
		data.BranchID = branchID
	}

	if needsMoreThoughts, ok := input["needsMoreThoughts"].(bool); ok {
		data.NeedsMoreThoughts = needsMoreThoughts
	}

	return data, nil
}