mirror of
https://github.com/coder/coder.git
synced 2026-06-05 14:08:20 +00:00
Michael Suchacz
19e86628da
Adds a `propose_plan` tool that presents a workspace markdown file as a dedicated plan card in the agent UI. The workflow is: the agent uses `write_file`/`edit_files` to build a plan file (e.g. `/home/coder/PLAN.md`), then calls `propose_plan(path)` to present it. The backend reads the file via `ReadFile` and the frontend renders it as an expanded markdown preview card. **Backend** (`coderd/x/chatd/chattool/proposeplan.go`): new tool registered as root-chat-only. Validates `.md` suffix, requires an absolute path, reads raw file content from the workspace agent. Includes 1 MiB size cap. **Frontend** (`site/src/components/ai-elements/tool/`): dedicated `ProposePlanTool` component with `ToolCollapsible` + `ScrollArea` + `Response` markdown renderer, expanded by default. Custom icon (`ClipboardListIcon`) and filename-based label. **System prompt** (`coderd/x/chatd/prompt.go`): added `<planning>` section guiding the agent to research → write plan file → iterate → call `propose_plan`.
93 lines
2.9 KiB
Go
93 lines
2.9 KiB
Go
package chattool
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"charm.land/fantasy"
|
|
"github.com/google/uuid"
|
|
|
|
"github.com/coder/coder/v2/codersdk/workspacesdk"
|
|
)
|
|
|
|
const maxProposePlanSize = 32 * 1024 // 32 KiB
|
|
|
|
// ProposePlanOptions configures the propose_plan tool.
|
|
type ProposePlanOptions struct {
|
|
GetWorkspaceConn func(context.Context) (workspacesdk.AgentConn, error)
|
|
StoreFile func(ctx context.Context, name string, mediaType string, data []byte) (uuid.UUID, error)
|
|
}
|
|
|
|
// ProposePlanArgs are the arguments for the propose_plan tool.
|
|
type ProposePlanArgs struct {
|
|
Path string `json:"path"`
|
|
}
|
|
|
|
// ProposePlan returns a tool that presents a Markdown plan file from the
|
|
// workspace for user review.
|
|
func ProposePlan(options ProposePlanOptions) fantasy.AgentTool {
|
|
return fantasy.NewAgentTool(
|
|
"propose_plan",
|
|
"Present a Markdown plan file from the workspace for user review. "+
|
|
"The file must already exist with a .md extension — use write_file to create it or edit_files to refine it before calling this tool. "+
|
|
"Pass the absolute file path (e.g. /home/coder/PLAN.md). The tool reads the content from the workspace.",
|
|
func(ctx context.Context, args ProposePlanArgs, _ fantasy.ToolCall) (fantasy.ToolResponse, error) {
|
|
if options.GetWorkspaceConn == nil {
|
|
return fantasy.NewTextErrorResponse("workspace connection resolver is not configured"), nil
|
|
}
|
|
if options.StoreFile == nil {
|
|
return fantasy.NewTextErrorResponse("file storage is not configured"), nil
|
|
}
|
|
conn, err := options.GetWorkspaceConn(ctx)
|
|
if err != nil {
|
|
return fantasy.NewTextErrorResponse(err.Error()), nil
|
|
}
|
|
return executeProposePlanTool(ctx, conn, args, options.StoreFile)
|
|
},
|
|
)
|
|
}
|
|
|
|
func executeProposePlanTool(
|
|
ctx context.Context,
|
|
conn workspacesdk.AgentConn,
|
|
args ProposePlanArgs,
|
|
storeFile func(ctx context.Context, name string, mediaType string, data []byte) (uuid.UUID, error),
|
|
) (fantasy.ToolResponse, error) {
|
|
path := strings.TrimSpace(args.Path)
|
|
if path == "" {
|
|
return fantasy.NewTextErrorResponse("path is required (use an absolute path, e.g. /home/coder/PLAN.md)"), nil
|
|
}
|
|
if !strings.HasSuffix(path, ".md") {
|
|
return fantasy.NewTextErrorResponse("path must end with .md"), nil
|
|
}
|
|
|
|
rc, _, err := conn.ReadFile(ctx, path, 0, maxProposePlanSize+1)
|
|
if err != nil {
|
|
return fantasy.NewTextErrorResponse(err.Error()), nil
|
|
}
|
|
defer rc.Close()
|
|
|
|
data, err := io.ReadAll(rc)
|
|
if err != nil {
|
|
return fantasy.NewTextErrorResponse(err.Error()), nil
|
|
}
|
|
if int64(len(data)) > maxProposePlanSize {
|
|
return fantasy.NewTextErrorResponse("plan file exceeds 32 KiB size limit"), nil
|
|
}
|
|
|
|
fileID, err := storeFile(ctx, filepath.Base(path), "text/markdown", data)
|
|
if err != nil {
|
|
return fantasy.NewTextErrorResponse("failed to store plan file: " + err.Error()), nil
|
|
}
|
|
|
|
return toolResponse(map[string]any{
|
|
"ok": true,
|
|
"path": path,
|
|
"kind": "plan",
|
|
"file_id": fileID.String(),
|
|
"media_type": "text/markdown",
|
|
}), nil
|
|
}
|