5d2096fb5d
Implements a comprehensive suite of AI SDK v6 tools across multiple categories: - Research (5): page-brief, compare-pages, source-credibility, claim-checklist, timeline-from-text - Web (10): fetch-text, links-catalog, extract-meta, extract-json-ld, redirect-trace, sitemap-read, rss-read, table-extract, robots-policy, url-normalize - Data (15): csv-parse, csv-stringify, json-repair, json-schema-validate, yaml-parse, yaml-stringify, text-chunk, normalize-whitespace, dedupe-by-key, pivot, rows-filter, rows-sort, rows-group-aggregate, rows-join, schema-infer - Doc (12): toc-generate, glossary-build, faq-from-text, executive-brief, decision-record-adr, prd-outline, acceptance-criteria, style-rewrite - Eng (12): diff-text-unified, env-var-docs-generate, dependency-audit-lite, conventional-commit-suggest, markdown-lint-basic, test-case-generate, stacktrace-parse, release-notes, changelog-entry, release-checklist - Security (7): redact-secrets, secret-scan-text, url-risk-heuristic, csp-compose, hardening-checklist-web, access-control-matrix, data-classification-heuristic - Stats (9): effect-size-suite, bootstrap-ci, permutation-test, multiple-testing-adjust, linear-regression-ols, logistic-regression, time-series-decompose-lite, anomaly-detect-mad - Ops (7): slo-draft, runbook-draft, postmortem-draft, postmortem-action-extractor, error-log-triage, coverage-tracker, monitoring-gap-analysis - Agent (15): prompt-to-workflow-skeleton, workflow-validate-io, workflow-explain, workflow-cost-estimate, tool-call-accuracy-score, eval-fixture-build, guardrail-policy-draft, workflow-auto-repair, tool-selection-plan, novelty-score-workflow, workflow-variant-generate, config-normalize, recipe-* - Utility (8): base64-encode, base64-decode, hash-text, regex-extract, template-render, date-parse, json-path-query, url-parse - HTML (3): html-sanitize, html-to-markdown, markdown-to-html All tools follow AI SDK v6 pattern with tool() and jsonSchema<T>(). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
3.3 KiB
3.3 KiB
@tpmjs/tools-workflow-explain
Explains what a workflow does in plain language. Analyzes workflow steps and generates human-readable explanations with complexity assessments.
Installation
npm install @tpmjs/tools-workflow-explain
Usage
import { workflowExplainTool } from '@tpmjs/tools-workflow-explain';
const result = await workflowExplainTool.execute({
workflow: {
name: 'User Onboarding',
description: 'Onboards new users to the platform',
steps: [
{
tool: 'validateEmail',
inputs: { email: 'string' },
outputs: { isValid: 'boolean' },
description: 'Validates user email address',
},
{
tool: 'createAccount',
inputs: { email: 'string', password: 'string' },
outputs: { userId: 'string', accountId: 'string' },
},
{
tool: 'sendWelcomeEmail',
inputs: { userId: 'string', email: 'string' },
outputs: { sent: 'boolean' },
},
],
},
});
console.log(result);
// {
// explanation: 'This workflow "User Onboarding" onboards new users...',
// stepSummaries: [
// {
// stepNumber: 1,
// tool: 'validateEmail',
// action: 'Validates user email address',
// inputSummary: 'using email',
// outputSummary: 'producing isValid'
// },
// ...
// ],
// complexity: 'simple',
// metrics: {
// totalSteps: 3,
// uniqueTools: 3,
// estimatedDuration: '< 1 minute',
// hasConditionals: false,
// hasLoops: false
// }
// }
Features
- Plain Language: Converts technical workflow definitions into readable explanations
- Step Analysis: Breaks down each step with action descriptions and I/O summaries
- Complexity Assessment: Automatically categorizes workflows as simple, moderate, complex, or very-complex
- Pattern Detection: Identifies conditionals, loops, and other advanced patterns
- Duration Estimation: Estimates workflow execution time based on step count
Input Schema
{
workflow: {
name: string; // Workflow name
steps: Array<{ // Workflow steps
tool: string; // Tool name
inputs?: object; // Input parameters
outputs?: object; // Output values
description?: string; // Optional step description
}>;
description?: string; // Optional workflow description
metadata?: object; // Optional metadata
};
}
Output Schema
{
explanation: string; // Overall workflow explanation
stepSummaries: Array<{ // Summary for each step
stepNumber: number;
tool: string;
action: string; // What the step does
inputSummary: string; // Human-readable input summary
outputSummary: string; // Human-readable output summary
}>;
complexity: 'simple' | 'moderate' | 'complex' | 'very-complex';
metrics: {
totalSteps: number;
uniqueTools: number;
estimatedDuration: string;
hasConditionals: boolean;
hasLoops: boolean;
};
}
Complexity Levels
- Simple: 1-3 steps, no conditionals or loops
- Moderate: 4-7 steps, up to 5 unique tools
- Complex: 8-15 steps or has conditionals/loops
- Very Complex: 15+ steps
License
MIT