VS Code Extension

Smarter’s Visual Studio Code Extension provides enhanced support for working with Smarter YAML manifest files, similar to Kubernetes manifests. It includes syntax validation, semantic checking, and auto-completion for reserved keywords. A Smarter manifest will include the following two keys at the top of the document:

apiVersion: smarter.sh/v1
kind: LLMClient

Valid manifest ‘kind’ values: LLMClient, Plugin, Account, SmarterAuthToken, User, Chat, ChatConfig, PromptHistory, PromptPluginUsage, PromptToolCall, SqlConnection, ApiConnection

Features

  • Syntax Validation: Ensures your YAML files are properly formatted.

  • Semantic Checking: Validates the content of your YAML manifests against predefined schemas.

  • Auto-Completion: Provides intelligent suggestions for reserved keywords and properties.

  • Error Highlighting: Highlights syntax and semantic errors in real-time.

  • Schema Support: Supports custom schemas for Smarter YAML manifests.

Getting Started

  1. Install the extension from the VS Code Marketplace (or manually if in development).

    VS Code Extension Marketplace

  2. Open a YAML manifest file in VS Code.

  3. The extension will automatically validate and provide suggestions.

Configuration

You can optionally configure the extension by adding the following settings to your settings.json:

{
  "yaml.schemas": {
    "path/to/your/schema.json": "*.yaml"
  },
  "smarterYaml.rootUrl": "https://platform.smarter.sh"
}

JSON Schemas

the VS Code Extension uses Smarter’s Pydantic-generated JSON schemas to validate the structure of Smarter YAML manifest files.

The following schemas are available:

  • /api/v1/cli/schema/Account/

  • /api/v1/cli/schema/ApiConnection/

  • /api/v1/cli/schema/ApiPlugin/

  • /api/v1/cli/schema/Chat/

  • /api/v1/cli/schema/LLMClient/

  • /api/v1/cli/schema/PromptHistory/

  • /api/v1/cli/schema/PromptPluginUsage/

  • /api/v1/cli/schema/PromptToolCall/

  • /api/v1/cli/schema/Plugin/

  • /api/v1/cli/schema/SqlConnection/

  • /api/v1/cli/schema/SqlPlugin/

  • /api/v1/cli/schema/SmarterAuthToken/

  • /api/v1/cli/schema/User/

See Pydantic for more details on these schemas and their properties.