webmcp-cli 1.0.0 → 1.2.1

package/dist/core/constants.d.ts

@@ -0,0 +1,102 @@
+/**
+ * Constants for AgentReady CLI
+ */
+/**
+ * WebMCP HTML attributes
+ */
+export declare const WEBMCP_ATTRIBUTES: {
+    readonly TOOL_NAME: "toolname";
+    readonly TOOL_DESCRIPTION: "tooldescription";
+    readonly TOOL_AUTO_SUBMIT: "toolautosubmit";
+    readonly PARAM_TITLE: "toolparamtitle";
+    readonly PARAM_DESCRIPTION: "toolparamdescription";
+};
+/**
+ * WebMCP API methods
+ */
+export declare const WEBMCP_API: {
+    readonly REGISTER_TOOL: "registerTool";
+    readonly PROVIDE_CONTEXT: "provideContext";
+    readonly UNREGISTER_TOOL: "unregisterTool";
+    readonly CLEAR_CONTEXT: "clearContext";
+};
+/**
+ * WebMCP events
+ */
+export declare const WEBMCP_EVENTS: {
+    readonly TOOL_ACTIVATED: "toolactivated";
+    readonly TOOL_CANCEL: "toolcancel";
+};
+/**
+ * WebMCP CSS pseudo-classes
+ */
+export declare const WEBMCP_CSS: {
+    readonly TOOL_FORM_ACTIVE: ":tool-form-active";
+    readonly TOOL_SUBMIT_ACTIVE: ":tool-submit-active";
+};
+/**
+ * Grade thresholds
+ */
+export declare const GRADE_THRESHOLDS: {
+    readonly 'A+': 95;
+    readonly A: 85;
+    readonly 'B+': 80;
+    readonly B: 70;
+    readonly 'C+': 65;
+    readonly C: 55;
+    readonly D: 40;
+    readonly F: 0;
+};
+/**
+ * Default audit configuration
+ */
+export declare const DEFAULT_AUDIT_CONFIG: {
+    timeout: number;
+    visible: boolean;
+    noSimulation: boolean;
+    ci: boolean;
+    minScore: number;
+    promptsPerTool: number;
+    maxRounds: number;
+    maxCost: number;
+};
+/**
+ * Recommended tool name verbs (from spec)
+ */
+export declare const RECOMMENDED_VERBS: string[];
+/**
+ * Discouraged tool name verbs
+ */
+export declare const DISCOURAGED_VERBS: string[];
+/**
+ * Prompt injection patterns to detect
+ */
+export declare const INJECTION_PATTERNS: RegExp[];
+/**
+ * Sensitive parameter patterns (for over-parameterization detection)
+ */
+export declare const SENSITIVE_PARAM_PATTERNS: {
+    critical: RegExp[];
+    high: RegExp[];
+    medium: RegExp[];
+};
+/**
+ * Payment-related keywords
+ */
+export declare const PAYMENT_KEYWORDS: string[];
+/**
+ * Authentication-related keywords
+ */
+export declare const AUTH_KEYWORDS: string[];
+/**
+ * Input type to JSON Schema type mapping
+ */
+export declare const INPUT_TYPE_MAP: Record<string, string>;
+/**
+ * CLI package info
+ */
+export declare const CLI_INFO: {
+    name: string;
+    fullName: string;
+    description: string;
+};

package/dist/core/constants.js

@@ -0,0 +1,214 @@
+/**
+ * Constants for AgentReady CLI
+ */
+/**
+ * WebMCP HTML attributes
+ */
+export const WEBMCP_ATTRIBUTES = {
+    // Form-level attributes
+    TOOL_NAME: 'toolname',
+    TOOL_DESCRIPTION: 'tooldescription',
+    TOOL_AUTO_SUBMIT: 'toolautosubmit',
+    // Input-level attributes
+    PARAM_TITLE: 'toolparamtitle',
+    PARAM_DESCRIPTION: 'toolparamdescription',
+};
+/**
+ * WebMCP API methods
+ */
+export const WEBMCP_API = {
+    REGISTER_TOOL: 'registerTool',
+    PROVIDE_CONTEXT: 'provideContext',
+    UNREGISTER_TOOL: 'unregisterTool',
+    CLEAR_CONTEXT: 'clearContext',
+};
+/**
+ * WebMCP events
+ */
+export const WEBMCP_EVENTS = {
+    TOOL_ACTIVATED: 'toolactivated',
+    TOOL_CANCEL: 'toolcancel',
+};
+/**
+ * WebMCP CSS pseudo-classes
+ */
+export const WEBMCP_CSS = {
+    TOOL_FORM_ACTIVE: ':tool-form-active',
+    TOOL_SUBMIT_ACTIVE: ':tool-submit-active',
+};
+/**
+ * Grade thresholds
+ */
+export const GRADE_THRESHOLDS = {
+    'A+': 95,
+    'A': 85,
+    'B+': 80,
+    'B': 70,
+    'C+': 65,
+    'C': 55,
+    'D': 40,
+    'F': 0,
+};
+/**
+ * Default audit configuration
+ */
+export const DEFAULT_AUDIT_CONFIG = {
+    timeout: 30000,
+    visible: false,
+    noSimulation: false, // Enable simulation by default when API key available
+    ci: false,
+    minScore: 60,
+    // Simulation defaults
+    promptsPerTool: 10,
+    maxRounds: 5,
+    maxCost: 2.0,
+};
+/**
+ * Recommended tool name verbs (from spec)
+ */
+export const RECOMMENDED_VERBS = [
+    'search',
+    'create',
+    'delete',
+    'update',
+    'get',
+    'list',
+    'submit',
+    'book',
+    'filter',
+    'add',
+    'remove',
+    'find',
+    'check',
+    'calculate',
+    'validate',
+    'send',
+    'fetch',
+    'load',
+    'save',
+    'cancel',
+    'confirm',
+    'select',
+    'set',
+    'clear',
+];
+/**
+ * Discouraged tool name verbs
+ */
+export const DISCOURAGED_VERBS = [
+    'handle',
+    'process',
+    'do',
+    'manage',
+    'run',
+    'execute',
+    'perform',
+];
+/**
+ * Prompt injection patterns to detect
+ */
+export const INJECTION_PATTERNS = [
+    /SYSTEM\s*:/i,
+    /IGNORE\s*(ALL\s*)?PREVIOUS/i,
+    /<important>/i,
+    /---\s*END/i,
+    /\[INST\]/i,
+    /\[\/INST\]/i,
+    /<\|im_start\|>/i,
+    /<\|im_end\|>/i,
+    /\{\{.*\}\}/,
+    /base64[:\s]/i,
+];
+/**
+ * Sensitive parameter patterns (for over-parameterization detection)
+ */
+export const SENSITIVE_PARAM_PATTERNS = {
+    critical: [
+        /^(ssn|social.?security|tax.?id)$/i,
+        /^(credit.?card|card.?number|cvv|cvc|ccv)$/i,
+        /^(bank.?account|routing.?number|iban|swift)$/i,
+        /^(password|passwd|pwd|secret)$/i,
+    ],
+    high: [
+        /^(email|e-mail|phone|mobile|cell)$/i,
+        /^(address|street|city|state|zip|postal)$/i,
+        /^(birth.?date|dob|age)$/i,
+        /^(full.?name|first.?name|last.?name|surname)$/i,
+    ],
+    medium: [
+        /^(username|user.?id|account.?id)$/i,
+        /^(ip.?address|device.?id|fingerprint)$/i,
+        /^(gender|sex|race|ethnicity)$/i,
+    ],
+};
+/**
+ * Payment-related keywords
+ */
+export const PAYMENT_KEYWORDS = [
+    'checkout',
+    'payment',
+    'pay',
+    'purchase',
+    'buy',
+    'order',
+    'transaction',
+    'billing',
+    'invoice',
+    'card',
+    'credit',
+    'debit',
+];
+/**
+ * Authentication-related keywords
+ */
+export const AUTH_KEYWORDS = [
+    'login',
+    'signin',
+    'sign-in',
+    'sign_in',
+    'logout',
+    'signout',
+    'sign-out',
+    'register',
+    'signup',
+    'sign-up',
+    'password',
+    'authentication',
+    'auth',
+    'session',
+    'token',
+];
+/**
+ * Input type to JSON Schema type mapping
+ */
+export const INPUT_TYPE_MAP = {
+    text: 'string',
+    email: 'string', // format: email
+    url: 'string', // format: uri
+    tel: 'string',
+    password: 'string',
+    search: 'string',
+    number: 'number',
+    range: 'number',
+    date: 'string', // format: date
+    'datetime-local': 'string', // format: date-time
+    time: 'string', // format: time
+    month: 'string',
+    week: 'string',
+    color: 'string',
+    checkbox: 'boolean',
+    radio: 'string', // enum
+    file: 'string', // format: binary
+    hidden: 'string',
+    textarea: 'string',
+    select: 'string', // enum if has options
+};
+/**
+ * CLI package info
+ */
+export const CLI_INFO = {
+    name: 'webmcp',
+    fullName: 'webmcp-cli',
+    description: 'Audit any website for AI agent readiness (WebMCP)',
+};
+//# sourceMappingURL=constants.js.map

package/dist/core/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/core/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,wBAAwB;IACxB,SAAS,EAAE,UAAU;IACrB,gBAAgB,EAAE,iBAAiB;IACnC,gBAAgB,EAAE,gBAAgB;IAElC,yBAAyB;IACzB,WAAW,EAAE,gBAAgB;IAC7B,iBAAiB,EAAE,sBAAsB;CACjC,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,aAAa,EAAE,cAAc;IAC7B,eAAe,EAAE,gBAAgB;IACjC,eAAe,EAAE,gBAAgB;IACjC,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,cAAc,EAAE,eAAe;IAC/B,WAAW,EAAE,YAAY;CACjB,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,gBAAgB,EAAE,mBAAmB;IACrC,kBAAkB,EAAE,qBAAqB;CACjC,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,IAAI,EAAE,EAAE;IACR,GAAG,EAAE,EAAE;IACP,IAAI,EAAE,EAAE;IACR,GAAG,EAAE,EAAE;IACP,IAAI,EAAE,EAAE;IACR,GAAG,EAAE,EAAE;IACP,GAAG,EAAE,EAAE;IACP,GAAG,EAAE,CAAC;CACE,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,KAAK;IACd,YAAY,EAAE,KAAK,EAAE,sDAAsD;IAC3E,EAAE,EAAE,KAAK;IACT,QAAQ,EAAE,EAAE;IACZ,sBAAsB;IACtB,cAAc,EAAE,EAAE;IAClB,SAAS,EAAE,CAAC;IACZ,OAAO,EAAE,GAAG;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,KAAK;IACL,MAAM;IACN,QAAQ;IACR,MAAM;IACN,QAAQ;IACR,KAAK;IACL,QAAQ;IACR,MAAM;IACN,OAAO;IACP,WAAW;IACX,UAAU;IACV,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,KAAK;IACL,OAAO;CACR,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ;IACR,SAAS;IACT,IAAI;IACJ,QAAQ;IACR,KAAK;IACL,SAAS;IACT,SAAS;CACV,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,aAAa;IACb,6BAA6B;IAC7B,cAAc;IACd,YAAY;IACZ,WAAW;IACX,aAAa;IACb,iBAAiB;IACjB,eAAe;IACf,YAAY;IACZ,cAAc;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,QAAQ,EAAE;QACR,mCAAmC;QACnC,4CAA4C;QAC5C,+CAA+C;QAC/C,iCAAiC;KAClC;IACD,IAAI,EAAE;QACJ,qCAAqC;QACrC,2CAA2C;QAC3C,0BAA0B;QAC1B,gDAAgD;KACjD;IACD,MAAM,EAAE;QACN,oCAAoC;QACpC,yCAAyC;QACzC,gCAAgC;KACjC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,UAAU;IACV,SAAS;IACT,KAAK;IACL,UAAU;IACV,KAAK;IACL,OAAO;IACP,aAAa;IACb,SAAS;IACT,SAAS;IACT,MAAM;IACN,QAAQ;IACR,OAAO;CACR,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO;IACP,QAAQ;IACR,SAAS;IACT,SAAS;IACT,QAAQ;IACR,SAAS;IACT,UAAU;IACV,UAAU;IACV,QAAQ;IACR,SAAS;IACT,UAAU;IACV,gBAAgB;IAChB,MAAM;IACN,SAAS;IACT,OAAO;CACR,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAA2B;IACpD,IAAI,EAAE,QAAQ;IACd,KAAK,EAAE,QAAQ,EAAE,gBAAgB;IACjC,GAAG,EAAE,QAAQ,EAAE,cAAc;IAC7B,GAAG,EAAE,QAAQ;IACb,QAAQ,EAAE,QAAQ;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,QAAQ;IACf,IAAI,EAAE,QAAQ,EAAE,eAAe;IAC/B,gBAAgB,EAAE,QAAQ,EAAE,oBAAoB;IAChD,IAAI,EAAE,QAAQ,EAAE,eAAe;IAC/B,KAAK,EAAE,QAAQ;IACf,IAAI,EAAE,QAAQ;IACd,KAAK,EAAE,QAAQ;IACf,QAAQ,EAAE,SAAS;IACnB,KAAK,EAAE,QAAQ,EAAE,OAAO;IACxB,IAAI,EAAE,QAAQ,EAAE,iBAAiB;IACjC,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,QAAQ;IAClB,MAAM,EAAE,QAAQ,EAAE,sBAAsB;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,YAAY;IACtB,WAAW,EAAE,mDAAmD;CACjE,CAAC"}

package/dist/core/types/audit.d.ts

@@ -0,0 +1,260 @@
+/**
+ * Audit Result Types
+ */
+import type { DetectedTool, UnregisteredForm } from './tool.js';
+import type { RuleResult, Finding } from './rule.js';
+/**
+ * Grade letters from A+ to F
+ */
+export type Grade = 'A+' | 'A' | 'B+' | 'B' | 'C+' | 'C' | 'D' | 'F';
+/**
+ * Information about a crawled page
+ */
+export interface PageInfo {
+    /**
+     * URL of the page
+     */
+    url: string;
+    /**
+     * Page title
+     */
+    title: string;
+    /**
+     * HTTP status code
+     */
+    statusCode: number;
+    /**
+     * Time taken to load the page (ms)
+     */
+    loadTime: number;
+    /**
+     * Whether WebMCP is supported on this page
+     */
+    hasWebMCP: boolean;
+    /**
+     * Number of tools found on this page
+     */
+    toolCount: number;
+    /**
+     * Number of forms found on this page
+     */
+    formCount: number;
+    /**
+     * Number of unregistered forms (opportunities)
+     */
+    opportunityCount: number;
+    /**
+     * Crawl depth from the starting URL
+     */
+    depth: number;
+    /**
+     * Screenshot path (if captured)
+     */
+    screenshotPath?: string;
+}
+/**
+ * Score breakdown by category
+ */
+export interface CategoryScore {
+    /**
+     * Category name
+     */
+    name: string;
+    /**
+     * Category ID
+     */
+    id: 'implementation' | 'description' | 'schema' | 'security' | 'best-practices' | 'coverage';
+    /**
+     * Score achieved in this category
+     */
+    score: number;
+    /**
+     * Maximum possible score in this category
+     */
+    maxScore: number;
+    /**
+     * Percentage (0-100)
+     */
+    percentage: number;
+}
+/**
+ * Overall score and grade
+ */
+export interface ScoreSummary {
+    /**
+     * Total score (0-100)
+     */
+    total: number;
+    /**
+     * Letter grade
+     */
+    grade: Grade;
+    /**
+     * Score breakdown by category
+     */
+    categories: CategoryScore[];
+    /**
+     * Issue counts by severity
+     */
+    issueCount: {
+        critical: number;
+        warning: number;
+        info: number;
+    };
+}
+/**
+ * Recommendation for improvement
+ */
+export interface Recommendation {
+    /**
+     * Priority order (1 = highest)
+     */
+    priority: number;
+    /**
+     * Action to take
+     */
+    action: string;
+    /**
+     * Expected score improvement
+     */
+    scoreImpact: number;
+    /**
+     * Effort required
+     */
+    effort: 'low' | 'medium' | 'high';
+    /**
+     * Related rule ID
+     */
+    ruleId: string;
+    /**
+     * Affected tools (if any)
+     */
+    affectedTools?: string[];
+}
+/**
+ * Complete audit result
+ */
+export interface AuditResult {
+    /**
+     * Unique audit ID
+     */
+    id: string;
+    /**
+     * Audited URL
+     */
+    url: string;
+    /**
+     * Timestamp when the audit started
+     */
+    startedAt: Date;
+    /**
+     * Timestamp when the audit completed
+     */
+    completedAt: Date;
+    /**
+     * Total duration (ms)
+     */
+    duration: number;
+    /**
+     * CLI version used
+     */
+    cliVersion: string;
+    /**
+     * Score summary
+     */
+    score: ScoreSummary;
+    /**
+     * All detected tools (imperative + declarative)
+     */
+    tools: DetectedTool[];
+    /**
+     * Unregistered forms (opportunities)
+     */
+    opportunities: UnregisteredForm[];
+    /**
+     * Pages crawled
+     */
+    pages: PageInfo[];
+    /**
+     * All rule results
+     */
+    ruleResults: Map<string, RuleResult>;
+    /**
+     * All findings (issues)
+     */
+    findings: Finding[];
+    /**
+     * Top recommendations
+     */
+    recommendations: Recommendation[];
+    /**
+     * Whether WebMCP is supported at all
+     */
+    hasWebMCP: boolean;
+    /**
+     * Browser used for the audit
+     */
+    browser: {
+        name: string;
+        version: string;
+    };
+    /**
+     * Audit configuration used
+     */
+    config: AuditConfig;
+}
+/**
+ * Configuration for an audit run
+ */
+export interface AuditConfig {
+    /**
+     * Per-page timeout (ms)
+     */
+    timeout: number;
+    /**
+     * Whether to run in visible (non-headless) mode
+     */
+    visible: boolean;
+    /**
+     * Whether to skip LLM prompt simulation
+     */
+    noSimulation: boolean;
+    /**
+     * LLM model for simulation
+     */
+    model?: string;
+    /**
+     * Whether running in CI mode
+     */
+    ci: boolean;
+    /**
+     * Minimum score for CI mode
+     */
+    minScore: number;
+    /**
+     * Number of test prompts per tool for simulation
+     */
+    promptsPerTool: number;
+    /**
+     * Maximum conversation rounds for simulation
+     */
+    maxRounds: number;
+    /**
+     * Maximum cost in USD for simulation
+     */
+    maxCost: number;
+}
+/**
+ * Options passed to the audit command
+ */
+export interface AuditOptions {
+    timeout?: string;
+    visible?: boolean;
+    noSimulation?: boolean;
+    model?: string;
+    ci?: boolean;
+    minScore?: string;
+    promptsPerTool?: string;
+    maxRounds?: string;
+    maxCost?: string;
+}

package/dist/core/types/audit.js

@@ -0,0 +1,5 @@
+/**
+ * Audit Result Types
+ */
+export {};
+//# sourceMappingURL=audit.js.map

package/dist/core/types/audit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit.js","sourceRoot":"","sources":["../../../src/core/types/audit.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/core/types/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Core Types
+ */
+export * from './tool.js';
+export * from './audit.js';
+export * from './rule.js';

package/dist/core/types/index.js

@@ -0,0 +1,7 @@
+/**
+ * Core Types
+ */
+export * from './tool.js';
+export * from './audit.js';
+export * from './rule.js';
+//# sourceMappingURL=index.js.map

package/dist/core/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/core/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}