Skip to main content
Before you start: Check if an assistant hasn’t already been created on our community repository firstGitlab
Gallery Create Digital Twin

Education-ready Community Assistants

Building Your Assistant

Why build an assistant: Increase the power of your digital twin by creating specialized AI assistants that enhance its capabilities by automating tasks in agentic workflows. Use Case: Creating an assistant is recommended when you find yourself needing to repeat a task that has well-defined instructions — like creating Swagger annotations, JSON documents, or Markdown text blocks — or a more sophisticated workflow, like reading and writing files, converting data structures, interacting with LLMs or other external sources, or coordinating actions between tools (for example, preparing an email and sending it). Where do I start: Use the CRISPE methodology as a guide. CRISPE is a six-part recipe (Context, Role, Input, Steps, Parameters, End goal) for writing assistant instructions that hold together. Here’s the general methodology:

CRISPE Methodology Framework

CRISPE is an acronym that provides a systematic approach to creating comprehensive AI assistant instructions:

C - Context 🎯

Establishes the situational background and purpose of the assistant. This section defines:
  • The problem domain or environment
  • Who the assistant serves
  • What systems or data sources are involved
  • The broader organizational or educational context

R - Role 👤

Defines the persona and responsibilities of the assistant. This includes:
  • The specific character or professional identity the AI should adopt
  • Behavioral expectations and tone
  • Core competencies and areas of expertise
  • How the assistant should interact with users

I - Input 📥

Specifies the types of data and information the assistant will receive:
  • Data sources and formats
  • User-provided parameters
  • Optional vs. required inputs
  • Contextual information from various systems

S - Steps 📋

Outlines the specific processes and workflows the assistant must follow:
  • Sequential actions to take
  • Decision-making criteria
  • Analytical procedures
  • Output generation methods

P - Parameters ⚙️

Establishes operational constraints and guidelines:
  • Communication style requirements
  • Output format specifications
  • Quality standards and limitations
  • Behavioral boundaries and restrictions

E - End Goal 🎯

Clearly states the ultimate objective and success metrics:
  • Desired outcomes for users
  • Value proposition
  • Success indicators
  • Long-term impact expectations

Benefits of CRISPE Methodology

The CRISPE framework ensures AI assistants are:
  • Comprehensive: All essential elements are addressed
  • Structured: Logical flow from context to outcome
  • Actionable: Clear steps and parameters for execution
  • Goal-oriented: Focused on specific, measurable outcomes
  • User-centered: Designed with end-user needs in mind
This methodology can be applied to create any specialized AI assistant by systematically working through each component to ensure clarity, completeness, and effectiveness.

Class Health Check Example

The Class Health Check assistant is built on this methodology:

Core code

Prompt

Guidelines for Tool Usage

Additionally, it is considered best practice to provide extra instructions guiding the LLM on tool usage. For example:
Prompt

Framework separated from core instructions

Detail specific frameworks, thresholds, and formatting guidelines toward the end of the prompt, while your CRISPE instructions simply refer to them.
Prompt
The complete code is available on Gitlab

Use Variables

Externalize sensitive information or reusable instructions into variables.

Assistant Engineering Lifecycle

This comprehensive lifecycle provides a structured approach for developing, testing, and deploying effective AI assistants:

Define Your Assistant's Purpose

Clearly establish your assistant’s primary function and target use case:
  • Subject Tutors - Specialized instruction in specific academic disciplines
  • Study Coaches - Learning strategy guidance, motivation, and study habit development
  • Research Assistants - Project support, data analysis, and assignment assistance
  • Practice Partners - Interactive skill development, review sessions, and knowledge reinforcement
  • Content Generators - Automated creation of educational materials, assessments, and resources
  • Language Translators - Multi-language content conversion and localization support
  • Content Summarizers - Information distillation, synthesis, and clarity enhancement
  • Workflow Orchestrators - Multi-agent coordination and complex task management
  • Assessment Evaluators - Automated grading, feedback generation, and performance analysis
Consider your target audience, specific learning objectives, and integration requirements when selecting your focus area.

Design Your Assistant Identity

Create a comprehensive assistant profile that ensures professional presentation and clear functionality:
  • Visual Branding - Design a distinctive icon (optimal: 512x512 pixels, WebP format for performance)
  • Naming Convention - Choose a memorable, descriptive name that reflects the assistant’s purpose
  • Compelling Description - Craft a comprehensive description including:
    • Catchphrase - A memorable tagline that captures the assistant’s value proposition
    • Functional Overview - Clear explanation of capabilities and execution logic
    • User Benefits - Specific advantages and learning outcomes
    Example:
    Description
  • Instruction Architecture - Implement the CRISPE methodology for structured, comprehensive instructions
  • Access Control - Define user permissions (Admin-only vs. universal access) and sharing capabilities
  • Security Implementation - Externalize sensitive data using variables and secure configuration
  • Modular Design - Create reusable instruction components as variables for consistency across assistant families

Test, Debug, and Refine

Conduct comprehensive testing to ensure robust performance across all scenarios:
  • Instruction Analysis - Request LLM evaluation of your assistant’s instructions for clarity, completeness, and effectiveness
  • Performance Grading - Obtain objective assessment scores and detailed improvement recommendations
Ask Prompto to review it: Praxis AI runs Prompto, a Digital Twin built to review and improve assistant instructions. Ask your Praxis AI administrator (or humans@praxis-ai.com) for access, then paste your draft instructions to it for a critique before you publish.
  • Iterative Improvement - Systematically address each recommendation and validate changes
  • Edge Case Testing - Evaluate assistant behavior with:
    • Off-topic user requests
    • Ambiguous or incomplete inputs
    • Boundary condition scenarios
    • Invalid data formats
  • Error Handling Enhancement - Implement graceful failure responses and user guidance
Try to break it on purpose. Give your assistant nonsense, off-topic questions, and half-finished requests before anyone else does — it’s far better to find the weak spots yourself than to have your users find them.

User Acceptance Testing (UAT)

Validate assistant performance through structured stakeholder testing:
  • Controlled Deployment - Restrict access to administrator-level users only
  • Stakeholder Testing - Engage multiple administrators in comprehensive evaluation sessions
  • Feedback Collection - Document findings, usability issues, and performance gaps
  • Priority Assessment - Categorize issues by severity and impact on user experience
  • Upgrade Strategy - Develop systematic improvement plan with clear timelines
  • Validation Cycles - Implement changes and conduct verification testing
  • Acceptance Criteria - Establish clear benchmarks for production readiness

Production Deployment and Maintenance

Launch your assistant with ongoing optimization and support:
  • Access Expansion - Transition from admin-only to full user availability
  • Performance Monitoring - Track usage patterns, user satisfaction, and system performance
  • Experience Analytics - Analyze user interactions, success rates, and engagement metrics
  • Version Planning - Develop roadmap for feature enhancements and capability expansion
  • Continuous Maintenance - Establish regular review cycles for instruction updates
Proactive Monitoring Strategy: Regularly audit your assistant’s performance as LLMs evolve rapidly with improved reasoning capabilities and updated knowledge cutoffs that can alter how they interpret existing instructions—proactive monitoring ensures consistent execution quality, identifies drift in behavior patterns, and allows for timely adjustments to maintain optimal functionality as the underlying AI technology advances and potentially changes response patterns or instruction comprehension.
  • Feedback Integration - Implement user feedback loops for continuous improvement
  • Documentation Updates - Maintain current user guides and troubleshooting resources

Version Control Integration

Keep a copy of your assistant’s instructions somewhere you can track changes — GitHub, GitLab, Bitbucket or Azure DevOps. That way you can see what changed and when, work on it with colleagues, and go back to an earlier version if an edit makes things worse.
Be involved: Share and contribute your assistant to our community repository! Gitlab