Skip to content

Commit e50a8cc

Browse files
committed
feat: enhance tool descriptions for better Smithery.ai marketplace visibility
🔧 Tool Description Improvements: - list_workflows: Detailed explanation of workflow overview capabilities - create_workflow: Comprehensive description of programmatic workflow creation - get_workflow: Clear explanation of workflow inspection functionality - execute_workflow: Detailed manual execution trigger description - update_workflow: Explanation of partial update capabilities - activate_workflow: Clear description of workflow enablement process - deactivate_workflow: Detailed explanation of workflow suspension - delete_workflow: Warning about permanent deletion with use cases 📈 Benefits: - Better tool discovery in Smithery.ai marketplace - Clearer user understanding of each tool's purpose - More informative tool playground experience - Enhanced documentation for AI assistant integration These enhanced descriptions will be reflected on the Smithery.ai server page at https://smithery.ai/server/@makafeli/n8n-workflow-builder after redeployment.
1 parent 0079f52 commit e50a8cc

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/index.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export default function ({ config }: { config: z.infer<typeof configSchema> }) {
2727
// Register workflow management tools using modern MCP SDK 1.17.0 API
2828
server.tool(
2929
"list_workflows",
30-
"List all workflows from n8n instance",
30+
"List all workflows from your n8n instance. Returns a comprehensive list of all workflows with their IDs, names, status (active/inactive), creation dates, and basic metadata. Perfect for getting an overview of your automation landscape.",
3131
{},
3232
async () => {
3333
try {
@@ -52,7 +52,7 @@ export default function ({ config }: { config: z.infer<typeof configSchema> }) {
5252

5353
server.tool(
5454
"create_workflow",
55-
"Create a new workflow in n8n",
55+
"Create a new workflow in n8n with custom nodes, connections, and settings. Build complex automation workflows programmatically by defining nodes (triggers, actions, conditions) and their relationships. Supports all n8n node types and advanced workflow configurations.",
5656
{
5757
workflow: z.object({
5858
name: z.string().describe("Name of the workflow"),
@@ -85,7 +85,7 @@ export default function ({ config }: { config: z.infer<typeof configSchema> }) {
8585

8686
server.tool(
8787
"get_workflow",
88-
"Get a workflow by ID",
88+
"Retrieve detailed information about a specific workflow by its ID. Returns complete workflow configuration including all nodes, connections, settings, triggers, and metadata. Essential for inspecting workflow structure before making modifications.",
8989
{
9090
id: z.string().describe("Workflow ID")
9191
},
@@ -112,7 +112,7 @@ export default function ({ config }: { config: z.infer<typeof configSchema> }) {
112112

113113
server.tool(
114114
"execute_workflow",
115-
"Execute a workflow by ID",
115+
"Trigger immediate execution of a workflow by its ID. Starts the workflow manually regardless of its normal triggers (webhooks, schedules, etc.). Returns execution details including status, start time, and any immediate results or errors.",
116116
{
117117
id: z.string().describe("Workflow ID")
118118
},
@@ -139,7 +139,7 @@ export default function ({ config }: { config: z.infer<typeof configSchema> }) {
139139

140140
server.tool(
141141
"update_workflow",
142-
"Update an existing workflow by ID",
142+
"Modify an existing workflow by updating its configuration, nodes, connections, or settings. Supports partial updates - you can change specific aspects without affecting the entire workflow. Perfect for iterative workflow development and maintenance.",
143143
{
144144
id: z.string().describe("Workflow ID"),
145145
workflow: z.object({
@@ -173,7 +173,7 @@ export default function ({ config }: { config: z.infer<typeof configSchema> }) {
173173

174174
server.tool(
175175
"activate_workflow",
176-
"Activate a workflow by ID",
176+
"Enable a workflow to start processing triggers and executing automatically. Once activated, the workflow will respond to its configured triggers (webhooks, schedules, file changes, etc.) and run according to its automation logic.",
177177
{
178178
id: z.string().describe("Workflow ID")
179179
},
@@ -200,7 +200,7 @@ export default function ({ config }: { config: z.infer<typeof configSchema> }) {
200200

201201
server.tool(
202202
"deactivate_workflow",
203-
"Deactivate a workflow by ID",
203+
"Disable a workflow to stop it from processing triggers and executing automatically. The workflow will remain in your n8n instance but won't respond to triggers until reactivated. Useful for maintenance, debugging, or temporary suspension.",
204204
{
205205
id: z.string().describe("Workflow ID")
206206
},
@@ -227,7 +227,7 @@ export default function ({ config }: { config: z.infer<typeof configSchema> }) {
227227

228228
server.tool(
229229
"delete_workflow",
230-
"Delete a workflow by ID",
230+
"Permanently remove a workflow from your n8n instance. This action cannot be undone - the workflow, its configuration, nodes, and execution history will be completely deleted. Use with caution for cleanup and workflow lifecycle management.",
231231
{
232232
id: z.string().describe("Workflow ID")
233233
},

0 commit comments

Comments
 (0)