Skip to content

IDE Support for RIDDL

Ossum Inc. provides IDE extensions for working with the RIDDL language. All tools are free and open source under the Apache License 2.0.

IDE Extensions

IntelliJ IDEA Plugin

RIDDL language support for JetBrains IntelliJ IDEA, including:

  • Syntax highlighting with customizable colors
  • Real-time validation and error detection
  • Integrated RIDDL tool window
  • Clickable error navigation

Status: Beta - Download

VS Code Extension

RIDDL language support for Visual Studio Code, including:

  • Syntax highlighting with semantic tokens
  • IntelliSense code completion (50+ keywords)
  • Real-time diagnostics
  • Go to Definition and Find References
  • Hover documentation

Status: Beta - Download

Writing RIDDL

Authoring RIDDL Sources

A comprehensive guide to writing effective RIDDL source files, covering:

  • File organization and includes
  • Adding metadata with the with clause
  • Type definitions and references
  • Commands, events, queries, and results
  • Entity design patterns
  • Handler statements
  • Common patterns and best practices

This guide applies to any IDE or editor.

AI-Assisted Modeling

RIDDL MCP Server

Connect AI assistants to the RIDDL MCP Server for intelligent modeling assistance:

  • Validate RIDDL code with detailed error messages
  • Check model completeness and get suggestions
  • Convert natural language to RIDDL structures
  • Get explanations for validation errors

Supports: Claude Desktop, Claude Code, Gemini CLI, VS Code Copilot, IntelliJ AI Assistant, and IntelliJ Junie.

Getting Started

  1. Install an IDE extension for your preferred editor
  2. Read the authoring guide to learn RIDDL best practices
  3. Connect the MCP server for AI-assisted modeling (optional)

Support

If you have questions or need assistance:

Contributing

We welcome contributions to all open source projects. Visit the GitHub repositories linked above to report issues, suggest features, or submit pull requests.