Function CreateWorkspace

coderd/x/chatd/chattool/createworkspace.go:89–348

CreateWorkspace returns a tool that creates a new workspace from a template. The tool is idempotent: if the chat already has a workspace that is building or running, it returns the existing workspace instead of creating a new one. A mutex prevents parallel calls from creating duplicate workspaces. d

(db database.Store, organizationID, chatID uuid.UUID, options CreateWorkspaceOptions)

// calls from creating duplicate workspaces.
// db must not be nil and chatID must not be uuid.Nil.
func CreateWorkspace(db database.Store, organizationID, chatID uuid.UUID, options CreateWorkspaceOptions) fantasy.AgentTool {
	return fantasy.NewAgentTool(
		"create_workspace",
		"Create a new workspace from a template only when workspace-backed "+
			"file inspection, command execution, or file editing is required, "+
			"or when the user explicitly asks for one. Do not use this as a "+
			"default first step for requests answerable from conversation "+
			"context, provider tools, or external MCP tools. Requires a "+
			"template_id (from list_templates). Optionally provide "+
			"a name and parameter values (from read_template). "+
			"If no name is given, one will be generated. "+
			"Provide a preset_id (from read_template) to apply "+
			"preset parameters and potentially claim a prebuilt "+
			"workspace for faster startup. "+
			"This tool is idempotent. If the chat already has a "+
			"workspace that is building or running, the existing "+
			"workspace is returned.",
		func(ctx context.Context, args createWorkspaceArgs, _ fantasy.ToolCall) (fantasy.ToolResponse, error) {
			if options.CreateFn == nil {
				return fantasy.NewTextErrorResponse("workspace creator is not configured"), nil
			}

			templateIDStr := strings.TrimSpace(args.TemplateID)
			if templateIDStr == "" {
				return fantasy.NewTextErrorResponse("template_id is required; use list_templates to find one"), nil
			}
			templateID, err := uuid.Parse(templateIDStr)
			if err != nil {
				return fantasy.NewTextErrorResponse(
					xerrors.Errorf("invalid template_id: %w", err).Error(),
				), nil
			}

			if !isTemplateAllowed(options.AllowedTemplateIDs, templateID) {
				return fantasy.NewTextErrorResponse("template not available for chat workspaces; use list_templates to find allowed templates"), nil
			}

			// Serialize workspace creation to prevent parallel
			// tool calls from creating duplicate workspaces.
			if options.WorkspaceMu != nil {
				options.WorkspaceMu.Lock()
				defer options.WorkspaceMu.Unlock()
			}

			ownerID := options.OwnerID

			// Check for an existing workspace on the chat.
			check := options.checkExistingWorkspace(ctx, db, chatID)
			if check.BuildErr != nil {
				return buildFailureToolResponse(
					ctx,
					options.Logger,
					db,
					ownerID,
					organizationID,
					check.BuildAction,
					check.BuildID,
					check.BuildErr,