Skip to navigation

Review and Approve Plans

Read a ToolSmith plan, ask for changes, and approve it to start the build.
View as Markdown

When you ask ToolSmith to build a plugin, it proposes a plan first. ToolSmith does not create or change anything until you approve the plan, so you can review it and ask for changes. Edits and fixes to an existing plugin use the same kind of plan.

The same prompt can produce different plans, so yours might differ from the examples here.

What a plan contains

The plan card in the chat offers Modify plan and Approve plan, or Approve when the plan has no external actions. The full plan is in the Artifacts panel under Plan. It shows a summary, a status badge, and numbered phases with their steps.

Scroll the Plan view to read each phase and its steps.

Plan status

The badge next to the timestamp shows where the plan stands:

BadgeWhat it means
AWAITING APPROVALThe plan is waiting for you to approve or change it.
PLANNINGToolSmith is revising the plan, for example after you ask for a change.
EXECUTINGYou approved the plan, and ToolSmith is carrying it out.
COMPLETEDToolSmith has finished the plan.

External actions

External actions are requests that ToolSmith sends to a connected system, such as your ServiceNow instance, while it builds and tests the plugin. Some only read data. Others can send or change data.

Each step that includes one has an External action tag. As the plan card says, “Approving this plan also approves and executes all external actions.”

Use a test or non-production environment. Before you approve, read each step tagged External action. To skip one, change the plan and ask ToolSmith to remove it.

Reused and new assets

ToolSmith always tries to reuse suitable assets you already have, especially connectors. If reusing an asset means changing it, ToolSmith might ask first, for example “May I update the existing entities for this use case?” The plan says which assets it will create, reuse, or change. To steer this, use your prompt:

  • To get new assets instead, ask for them, for example Create a new ServiceNow connector, and don't reuse existing assets.
  • To have ToolSmith use a specific asset, or leave one alone, name it.

A step can describe an existing asset without naming it. ToolSmith’s planning notes in the chat, above the plan card, name it.

If the plan changes an asset that other plugins use, test those plugins after the build. In Tool Studio, the asset’s Related assets lists them under Parent Assets.

For more on prompts, see Write effective prompts.

Check the plan before you approve

Read every phase and step, and check these points:

  • Rules. Every condition, filter, limit, and exception you asked for is in the plan.
  • Assets. The plan creates, reuses, or changes only the assets you expect.
  • Connectors. Each system uses the connector you expect, existing or new.
  • Tests. The test steps cover the behavior you care about, such as your filters and limits.
  • External actions. You are willing to run each one against the connected system.
  • Access. A new plugin is available only to you or the people you select. To widen access later, update its launch permissions.

If anything is missing or wrong, change the plan.

Change the plan

Describe the result you want in plain language. You do not need to name the step that changes. ToolSmith still builds nothing until you approve the revised plan.

1

Select Modify plan

On the plan card, select Modify plan. ToolSmith asks, “What changes should I make to the plan?”

2

Describe the change

Type the change in the message box and send it, for example Show at most 10 incidents.

3

Review the revised plan

The badge reads PLANNING until ToolSmith posts a new plan card. Check that it includes your change. If not, select Modify plan again.

Select Modify plan, describe the change, and review the revised plan.

Approve the plan

When the plan is right, select Approve plan (or Approve) on the plan card. The badge changes to EXECUTING, and ToolSmith starts the build.

Approving a plan that creates a ServiceNow connector starts the build with a credentials request.

After you approve

  • Credentials. If a new connector needs credentials, enter them only in the secure form ToolSmith shows, never in the chat. See Configure credentials securely.
  • Progress. ToolSmith reports progress in the chat, and the Plan view shows each phase’s progress.
  • Failed steps. If a step fails, ToolSmith can revise the plan. Check the new plan as carefully as the first.
  • Leaving the chat. You can leave and come back. ToolSmith keeps working until it needs you.
  • The result. When the badge reads COMPLETED, select Assets in the Artifacts panel, compare the assets with the plan, and test the plugin.

Related documentation