@syrin/cli 1.3.0

package/dist/config/syrin.template.yaml

@@ -0,0 +1,127 @@
+# Syrin Configuration File
+# ========================
+# This file configures your Syrin runtime environment.
+# For detailed documentation, visit: https://github.com/syrin-labs/cli
+
+# Configuration Version
+# The version of this configuration schema.
+version: "{{VERSION}}"
+
+# Project Configuration
+# ---------------------
+# Project name: A unique identifier for your MCP server project
+project_name: "{{PROJECT_NAME}}"
+
+# Agent name: The name of your AI agent that will interact with the MCP server
+agent_name: "{{AGENT_NAME}}"
+
+# Transport Configuration
+# -----------------------
+# Transport type: How Syrin communicates with your MCP server
+#   - "stdio": Communicate via standard input/output (spawns the MCP server process)
+#   - "http":  Communicate via HTTP (connects to a running MCP server)
+transport: "{{TRANSPORT}}"
+
+{{#IF_HTTP}}
+# MCP Server URL (required for http transport)
+# The HTTP endpoint where your MCP server is running
+# Example: "http://localhost:8000/mcp"
+mcp_url: "{{MCP_URL}}"
+{{/IF_HTTP}}
+{{#IF_STDIO}}
+# MCP Server URL (not used for stdio transport)
+# Uncomment and configure if you switch to http transport
+# mcp_url: "http://localhost:8000/mcp"
+{{/IF_STDIO}}
+
+# Script Configuration
+# --------------------
+# Command to run your MCP server
+# For stdio transport, this is required
+# Use --run-script flag in dev mode to spawn the server internally
+{{#IF_SCRIPT}}
+script: "{{SCRIPT}}"
+{{/IF_SCRIPT}}
+{{#IF_NO_SCRIPT}}
+# script: "python3 server.py"
+{{/IF_NO_SCRIPT}}
+
+# LLM Provider Configuration
+# ---------------------------
+# Configure one or more LLM providers for Syrin to use.
+# API keys and model names can be set as:
+#   - Environment variable names (recommended for security)
+#   - Direct values (not recommended for production)
+# At least one provider must be marked as default: true
+
+llm:
+{{#LLM_PROVIDERS}}
+  # {{PROVIDER_NAME}} Provider
+  {{PROVIDER_NAME}}:
+{{#IF_OLLAMA}}
+    # Model name: Required for Ollama (e.g., "llama2", "mistral", "codellama")
+    # Can be set as environment variable name or direct value
+    # Example: "OLLAMA_MODEL_NAME" (reads from process.env.OLLAMA_MODEL_NAME)
+    # Or: "llama2" (direct value)
+    MODEL_NAME: "{{MODEL_NAME}}"
+{{/IF_OLLAMA}}
+{{#IF_CLOUD_PROVIDER}}
+    # API key: Set as environment variable name or direct value
+    # Example: "{{PROVIDER_NAME_UPPER}}_API_KEY" (reads from process.env.{{PROVIDER_NAME_UPPER}}_API_KEY)
+    # Or: "sk-..." (direct value, not recommended)
+    API_KEY: "{{API_KEY}}"
+
+    # Model name: Set as environment variable name or direct value
+    # Example: "{{PROVIDER_NAME_UPPER}}_MODEL_NAME" (reads from process.env.{{PROVIDER_NAME_UPPER}}_MODEL_NAME)
+    # Or: "gpt-4" (direct value)
+    MODEL_NAME: "{{MODEL_NAME}}"
+{{/IF_CLOUD_PROVIDER}}
+{{#IF_DEFAULT}}
+    # Set as default LLM provider
+    default: true
+{{/IF_DEFAULT}}
+{{#IF_NOT_DEFAULT}}
+    default: false
+{{/IF_NOT_DEFAULT}}
+{{#IF_OPENAI_AND_NO_CLAUDE}}
+
+  # Claude Provider (uncomment to enable)
+  # claude:
+  #   API_KEY: "CLAUDE_API_KEY"
+  #   MODEL_NAME: "CLAUDE_MODEL_NAME"
+  #   default: false
+{{/IF_OPENAI_AND_NO_CLAUDE}}
+{{#IF_CLAUDE_AND_NO_OPENAI}}
+
+  # OpenAI Provider (uncomment to enable)
+  # openai:
+  #   API_KEY: "OPENAI_API_KEY"
+  #   MODEL_NAME: "OPENAI_MODEL_NAME"
+  #   default: false
+{{/IF_CLAUDE_AND_NO_OPENAI}}
+{{#IF_NO_OLLAMA}}
+
+  # Ollama Provider - uncomment to enable
+  # ollama:
+  #   MODEL_NAME: "OLLAMA_MODEL_NAME"  # or "llama2", "mistral", etc.
+  #   default: false
+{{/IF_NO_OLLAMA}}
+
+{{/LLM_PROVIDERS}}
+# Tool Validation Configuration (v1.3.0)
+# ---------------------------
+# Configure tool-level structural safety validation
+# This section is optional but recommended for production use
+
+check:
+  # Timeout for tool execution in milliseconds
+  timeout_ms: 30000
+
+  # Tools directory name (relative to project root, default: "tools")
+  # tools_dir: tools
+
+  # Maximum output size in KB (default: 50)
+  # max_output_size_kb: 50
+
+  # Strict mode: warnings become errors (default: false)
+  # strict_mode: false

package/dist/config/types.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Configuration type definitions for Syrin.
+ * These types represent the structure of the syrin.yaml file.
+ */
+import type { ProjectName, AgentName, MCPURL, APIKey, ModelName, ScriptCommand, SyrinVersion } from '../types/ids.js';
+export type TransportType = 'stdio' | 'http';
+export interface LLMProviderConfig {
+    /** API key for the LLM provider (can be an environment variable name) - required for cloud providers */
+    API_KEY?: APIKey;
+    /** Model name to use (can be an environment variable name) - required for cloud providers and Ollama */
+    MODEL_NAME?: ModelName;
+    /** Whether this is the default LLM provider */
+    default?: boolean;
+}
+export interface CheckConfig {
+    /** Timeout for tool execution in milliseconds */
+    timeout_ms?: number;
+    /** Memory limit for sandboxed processes in MB */
+    memory_limit_mb?: number;
+    /** Tools directory name (relative to project root, default: "tools") */
+    tools_dir?: string;
+    /** Maximum output size in KB (default: 50) */
+    max_output_size_kb?: number;
+    /** Number of runs for determinism checking (default: 3) */
+    determinism_runs?: number;
+    /** Enable retry scenario testing (default: true) */
+    test_retries?: boolean;
+    /** Maximum retries to test (default: 3) */
+    max_retries?: number;
+    /** Retry delay in milliseconds (default: 100) */
+    retry_delay_ms?: number;
+    /** Strict mode: warnings become errors (default: false) */
+    strict_mode?: boolean;
+}
+export interface SyrinConfig {
+    /** Configuration version */
+    version: SyrinVersion;
+    /** Project name */
+    project_name: ProjectName;
+    /** Agent name */
+    agent_name: AgentName;
+    /** Transport type (stdio or http) */
+    transport: TransportType;
+    /** MCP server URL (required for http transport) */
+    mcp_url?: MCPURL;
+    /** Script command to run the MCP server (required for stdio transport) */
+    script?: ScriptCommand;
+    /** LLM provider configurations */
+    llm: Record<string, LLMProviderConfig>;
+    /** Tool testing configuration (v1.3.0) */
+    check?: CheckConfig;
+}
+/**
+ * Options for initializing a new Syrin project.
+ */
+export interface InitOptions {
+    /** Project name */
+    projectName: ProjectName;
+    /** Agent name */
+    agentName: AgentName;
+    /** Transport type */
+    transport: TransportType;
+    /** MCP server URL (for http transport) */
+    mcpUrl?: MCPURL;
+    /** Script command to run the MCP server */
+    script: ScriptCommand;
+    /** LLM providers to configure */
+    llmProviders: {
+        openai?: {
+            apiKey: APIKey;
+            modelName: ModelName;
+            default?: boolean;
+        };
+        claude?: {
+            apiKey: APIKey;
+            modelName: ModelName;
+            default?: boolean;
+        };
+        ollama?: {
+            modelName?: ModelName;
+            default?: boolean;
+        };
+    };
+    /** Skip interactive prompts (non-interactive mode) */
+    nonInteractive?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/config/types.js

@@ -0,0 +1,6 @@
+/**
+ * Configuration type definitions for Syrin.
+ * These types represent the structure of the syrin.yaml file.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/constants/app.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Application metadata constants.
+ */
+export declare const PACKAGE_NAME = "@syrin/cli";
+export declare const App: {
+    readonly NAME: "Syrin";
+    readonly VERSION_KEY: "version";
+};
+//# sourceMappingURL=app.d.ts.map

package/dist/constants/app.js

@@ -0,0 +1,9 @@
+/**
+ * Application metadata constants.
+ */
+export const PACKAGE_NAME = '@syrin/cli';
+export const App = {
+    NAME: 'Syrin',
+    VERSION_KEY: 'version',
+};
+//# sourceMappingURL=app.js.map

package/dist/constants/commands.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Command name constants.
+ * Centralized command names used throughout the CLI.
+ */
+/**
+ * CLI tool commands (main CLI commands).
+ */
+export declare const ToolCommands: {
+    /** Main CLI name */
+    readonly CLI_NAME: "syrin";
+    /** Init command */
+    readonly INIT: "syrin init";
+    /** Doctor command */
+    readonly DOCTOR: "syrin doctor";
+    /** Dev command */
+    readonly DEV: "syrin dev";
+    /** Test command */
+    readonly TEST: "syrin test";
+    /** List command */
+    readonly LIST: "syrin list";
+    /** Analyse command */
+    readonly ANALYSE: "syrin analyse";
+};
+/**
+ * Chat commands (available in dev mode chat interface).
+ */
+export declare const ChatCommands: {
+    /** Show help message */
+    readonly HELP: "/help";
+    /** Clear chat history */
+    readonly CLEAR: "/clear";
+    /** List available MCP tools */
+    readonly TOOLS: "/tools";
+    /** Show command history */
+    readonly HISTORY: "/history";
+    /** Save tool result JSON to file */
+    readonly SAVE_JSON: "/save-json";
+    /** Exit the chat */
+    readonly EXIT: "/exit";
+    /** Quit the chat (alias for exit) */
+    readonly QUIT: "/quit";
+};
+//# sourceMappingURL=commands.d.ts.map

package/dist/constants/commands.js

@@ -0,0 +1,43 @@
+/**
+ * Command name constants.
+ * Centralized command names used throughout the CLI.
+ */
+/**
+ * CLI tool commands (main CLI commands).
+ */
+export const ToolCommands = {
+    /** Main CLI name */
+    CLI_NAME: 'syrin',
+    /** Init command */
+    INIT: 'syrin init',
+    /** Doctor command */
+    DOCTOR: 'syrin doctor',
+    /** Dev command */
+    DEV: 'syrin dev',
+    /** Test command */
+    TEST: 'syrin test',
+    /** List command */
+    LIST: 'syrin list',
+    /** Analyse command */
+    ANALYSE: 'syrin analyse',
+};
+/**
+ * Chat commands (available in dev mode chat interface).
+ */
+export const ChatCommands = {
+    /** Show help message */
+    HELP: '/help',
+    /** Clear chat history */
+    CLEAR: '/clear',
+    /** List available MCP tools */
+    TOOLS: '/tools',
+    /** Show command history */
+    HISTORY: '/history',
+    /** Save tool result JSON to file */
+    SAVE_JSON: '/save-json',
+    /** Exit the chat */
+    EXIT: '/exit',
+    /** Quit the chat (alias for exit) */
+    QUIT: '/quit',
+};
+//# sourceMappingURL=commands.js.map

package/dist/constants/defaults.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Default values used throughout the application.
+ */
+export declare const Defaults: {
+    /** Default MCP server URL */
+    readonly MCP_URL: "http://localhost:8000/mcp";
+    /** Default transport type */
+    readonly TRANSPORT: "stdio";
+    /** Default LLM provider */
+    readonly LLM_PROVIDER: "openai";
+    /** Default agent name */
+    readonly AGENT_NAME: "Syrin";
+    /** Default script command */
+    readonly SCRIPT_COMMAND: "npm run start";
+    /** Default working status message */
+    readonly WORKING: "working";
+};
+//# sourceMappingURL=defaults.d.ts.map

package/dist/constants/defaults.js

@@ -0,0 +1,18 @@
+/**
+ * Default values used throughout the application.
+ */
+export const Defaults = {
+    /** Default MCP server URL */
+    MCP_URL: 'http://localhost:8000/mcp',
+    /** Default transport type */
+    TRANSPORT: 'stdio',
+    /** Default LLM provider */
+    LLM_PROVIDER: 'openai',
+    /** Default agent name */
+    AGENT_NAME: 'Syrin',
+    /** Default script command */
+    SCRIPT_COMMAND: 'npm run start',
+    /** Default working status message */
+    WORKING: 'working',
+};
+//# sourceMappingURL=defaults.js.map

package/dist/constants/env-vars.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Environment variable name constants.
+ */
+export declare const EnvVars: {
+    readonly OPENAI_API_KEY: "OPENAI_API_KEY";
+    readonly OPENAI_MODEL_NAME: "OPENAI_MODEL_NAME";
+    readonly CLAUDE_API_KEY: "CLAUDE_API_KEY";
+    readonly CLAUDE_MODEL_NAME: "CLAUDE_MODEL_NAME";
+    readonly OLLAMA_MODEL_NAME: "OLLAMA_MODEL_NAME";
+};
+//# sourceMappingURL=env-vars.d.ts.map

package/dist/constants/env-vars.js

@@ -0,0 +1,11 @@
+/**
+ * Environment variable name constants.
+ */
+export const EnvVars = {
+    OPENAI_API_KEY: 'OPENAI_API_KEY',
+    OPENAI_MODEL_NAME: 'OPENAI_MODEL_NAME',
+    CLAUDE_API_KEY: 'CLAUDE_API_KEY',
+    CLAUDE_MODEL_NAME: 'CLAUDE_MODEL_NAME',
+    OLLAMA_MODEL_NAME: 'OLLAMA_MODEL_NAME',
+};
+//# sourceMappingURL=env-vars.js.map

package/dist/constants/icons.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Icon constants used throughout the CLI.
+ * Centralized for easy maintenance and consistency.
+ */
+export declare const Icons: {
+    /** Success/Valid indicator */
+    readonly SUCCESS: "✓";
+    /** Failure/Invalid indicator */
+    readonly FAILURE: "✗";
+    /** Warning indicator */
+    readonly WARNING: "⚠️";
+    /** Error indicator */
+    readonly ERROR: "❌";
+    /** Checkmark indicator (alternative) */
+    readonly CHECK: "✅";
+    /** Folder/Directory indicator */
+    readonly FOLDER: "📁";
+    /** Document/Note indicator */
+    readonly DOCUMENT: "📝";
+    /** Lightbulb/Tip indicator */
+    readonly TIP: "💡";
+};
+//# sourceMappingURL=icons.d.ts.map

package/dist/constants/icons.js

@@ -0,0 +1,23 @@
+/**
+ * Icon constants used throughout the CLI.
+ * Centralized for easy maintenance and consistency.
+ */
+export const Icons = {
+    /** Success/Valid indicator */
+    SUCCESS: '✓',
+    /** Failure/Invalid indicator */
+    FAILURE: '✗',
+    /** Warning indicator */
+    WARNING: '⚠️',
+    /** Error indicator */
+    ERROR: '❌',
+    /** Checkmark indicator (alternative) */
+    CHECK: '✅',
+    /** Folder/Directory indicator */
+    FOLDER: '📁',
+    /** Document/Note indicator */
+    DOCUMENT: '📝',
+    /** Lightbulb/Tip indicator */
+    TIP: '💡',
+};
+//# sourceMappingURL=icons.js.map

package/dist/constants/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Constants index file.
+ * Exports all constants for easy importing throughout the application.
+ */
+export * from './icons.js';
+export * from './labels.js';
+export * from './messages.js';
+export * from './paths.js';
+export * from './commands.js';
+export * from './transport.js';
+export * from './list.js';
+export * from './llm.js';
+export * from './defaults.js';
+export * from './env-vars.js';
+export * from './app.js';
+export * from './links.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/constants/index.js

@@ -0,0 +1,17 @@
+/**
+ * Constants index file.
+ * Exports all constants for easy importing throughout the application.
+ */
+export * from './icons.js';
+export * from './labels.js';
+export * from './messages.js';
+export * from './paths.js';
+export * from './commands.js';
+export * from './transport.js';
+export * from './list.js';
+export * from './llm.js';
+export * from './defaults.js';
+export * from './env-vars.js';
+export * from './app.js';
+export * from './links.js';
+//# sourceMappingURL=index.js.map

package/dist/constants/labels.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Label constants for CLI output.
+ * Used in doctor reports and other formatted output.
+ */
+export declare const Labels: {
+    readonly DOCTOR_REPORT_TITLE: "Syrin Doctor Report";
+    readonly SYRIN_VERSION: "Syrin Version:";
+    readonly MCP_PROJECT_NAME: "MCP Project Name:";
+    readonly AGENT_NAME: "Agent Name:";
+    readonly TRANSPORT_LAYER: "Transport Layer:";
+    readonly MCP_URL: "MCP URL:";
+    readonly COMMAND: "Command:";
+    readonly SCRIPTS: "Scripts:";
+    readonly LLMS: "LLMs:";
+    readonly MODEL: "Model";
+    readonly SCRIPT_DEV: "dev";
+    readonly SCRIPT_START: "start";
+    readonly STATUS_WORKING: "(working)";
+    readonly STATUS_DEFAULT: "(default)";
+    readonly STATUS_MISSING: "Missing";
+    readonly STATUS_NA: "N/A";
+    readonly TOOLS: "Tools";
+    readonly RESOURCES: "Resources";
+    readonly PROMPTS: "Prompts";
+    readonly NAME: "Name";
+    readonly TITLE: "Title";
+    readonly DESCRIPTION: "Description";
+    readonly URI: "URI";
+    readonly ARGUMENTS: "Arguments";
+    readonly REQUIRED: "Required";
+    readonly INPUT_SCHEMA: "Input Schema";
+    readonly OUTPUT_SCHEMA: "Output Schema";
+    readonly NO_TOOLS: "No tools available";
+    readonly NO_RESOURCES: "No resources available";
+    readonly NO_PROMPTS: "No prompts available";
+    readonly TOTAL_COUNT: "Total";
+};
+//# sourceMappingURL=labels.d.ts.map

package/dist/constants/labels.js

@@ -0,0 +1,42 @@
+/**
+ * Label constants for CLI output.
+ * Used in doctor reports and other formatted output.
+ */
+export const Labels = {
+    // Doctor Report Labels
+    DOCTOR_REPORT_TITLE: 'Syrin Doctor Report',
+    SYRIN_VERSION: 'Syrin Version:',
+    MCP_PROJECT_NAME: 'MCP Project Name:',
+    AGENT_NAME: 'Agent Name:',
+    TRANSPORT_LAYER: 'Transport Layer:',
+    MCP_URL: 'MCP URL:',
+    COMMAND: 'Command:',
+    SCRIPTS: 'Scripts:',
+    LLMS: 'LLMs:',
+    MODEL: 'Model',
+    // Script Labels
+    SCRIPT_DEV: 'dev',
+    SCRIPT_START: 'start',
+    // Status Messages
+    STATUS_WORKING: '(working)',
+    STATUS_DEFAULT: '(default)',
+    STATUS_MISSING: 'Missing',
+    STATUS_NA: 'N/A',
+    // List Command Labels
+    TOOLS: 'Tools',
+    RESOURCES: 'Resources',
+    PROMPTS: 'Prompts',
+    NAME: 'Name',
+    TITLE: 'Title',
+    DESCRIPTION: 'Description',
+    URI: 'URI',
+    ARGUMENTS: 'Arguments',
+    REQUIRED: 'Required',
+    INPUT_SCHEMA: 'Input Schema',
+    OUTPUT_SCHEMA: 'Output Schema',
+    NO_TOOLS: 'No tools available',
+    NO_RESOURCES: 'No resources available',
+    NO_PROMPTS: 'No prompts available',
+    TOTAL_COUNT: 'Total',
+};
+//# sourceMappingURL=labels.js.map

package/dist/constants/links.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Syrin external links constants.
+ * Centralized URLs for npm, GitHub, and documentation.
+ */
+export declare const SYRIN_LINKS: {
+    readonly NPM: "https://www.npmjs.com/package/@syrin/cli";
+    readonly GITHUB: "https://github.com/syrin-labs/cli";
+    readonly DOCS: "https://github.com/syrin-labs/cli#readme";
+};
+//# sourceMappingURL=links.d.ts.map

package/dist/constants/links.js

@@ -0,0 +1,11 @@
+/**
+ * Syrin external links constants.
+ * Centralized URLs for npm, GitHub, and documentation.
+ */
+import { PACKAGE_NAME } from './app.js';
+export const SYRIN_LINKS = {
+    NPM: `https://www.npmjs.com/package/${PACKAGE_NAME}`,
+    GITHUB: 'https://github.com/syrin-labs/cli',
+    DOCS: 'https://github.com/syrin-labs/cli#readme',
+};
+//# sourceMappingURL=links.js.map

package/dist/constants/list.d.ts

@@ -0,0 +1,10 @@
+/**
+ * List type constants.
+ */
+export declare const ListTypes: {
+    readonly TOOLS: "tools";
+    readonly RESOURCES: "resources";
+    readonly PROMPTS: "prompts";
+};
+export type ListType = (typeof ListTypes)[keyof typeof ListTypes];
+//# sourceMappingURL=list.d.ts.map

package/dist/constants/list.js

@@ -0,0 +1,9 @@
+/**
+ * List type constants.
+ */
+export const ListTypes = {
+    TOOLS: 'tools',
+    RESOURCES: 'resources',
+    PROMPTS: 'prompts',
+};
+//# sourceMappingURL=list.js.map

package/dist/constants/llm.d.ts

@@ -0,0 +1,26 @@
+/**
+ * LLM provider constants.
+ */
+export declare const LLMProviders: {
+    readonly OPENAI: "openai";
+    readonly CLAUDE: "claude";
+    readonly OLLAMA: "ollama";
+};
+export type LLMProvider = (typeof LLMProviders)[keyof typeof LLMProviders];
+/**
+ * LLM provider display names.
+ */
+export declare const LLMProviderNames: {
+    readonly OPENAI: "OpenAI";
+    readonly CLAUDE: "Claude";
+    readonly OLLAMA: "Ollama";
+};
+/**
+ * LLM provider full display names (for prompts).
+ */
+export declare const LLMProviderDisplayNames: {
+    readonly OPENAI: "OpenAI";
+    readonly CLAUDE: "Claude (Anthropic)";
+    readonly OLLAMA: "Ollama";
+};
+//# sourceMappingURL=llm.d.ts.map

package/dist/constants/llm.js

@@ -0,0 +1,25 @@
+/**
+ * LLM provider constants.
+ */
+export const LLMProviders = {
+    OPENAI: 'openai',
+    CLAUDE: 'claude',
+    OLLAMA: 'ollama',
+};
+/**
+ * LLM provider display names.
+ */
+export const LLMProviderNames = {
+    OPENAI: 'OpenAI',
+    CLAUDE: 'Claude',
+    OLLAMA: 'Ollama',
+};
+/**
+ * LLM provider full display names (for prompts).
+ */
+export const LLMProviderDisplayNames = {
+    OPENAI: 'OpenAI',
+    CLAUDE: 'Claude (Anthropic)',
+    OLLAMA: 'Ollama',
+};
+//# sourceMappingURL=llm.js.map