XAP Coding Assistant

AI tools for understanding and writing correct XAP project code.

⚠️ Alpha Version: This extension is under active development. Please enable auto-update in VS Code to get the latest features and improvements:

Guidance Videos

💡 Tip: For the best experience, use Claude Opus 4.5 in VS Code Agent mode. It provides superior reasoning and code generation capabilities for XAP projects.

Features

This extension provides two Language Model Tools for GitHub Copilot:

#xap-read - Understand XAP Projects

What it does:

• Copilot analyzes the project and saves understanding to .github/repohandbook/understand_*.md

Analyze and understand XAP projects Example:

#xap-read ./src/MyProject

• Supports Q&A for you to understand the project behavior

Q&A Examples:

#xap-read understand private\xapnext\RealEstate
// let llm do several understanding works and wait it finishes

so what facts will be returned to me if I search single address

💡 Tip: Suggest to always run #xap-read to incrementally update project understanding as project keep updating. You can checkin understanding_*.md to your repo.

#xap-code - Full Coding Workflow 🚀

Complete workflow for adding or modifying XAP project code from your requirement.

What it does: After #xap-read to generate multiple understanding_*.md, you can start a new chat with following examples to implement your requirement.

Feature implementation Examples:

#xap-code add two new facts when search single address
#xap-code requirement is in document ./doc/my_requirement.md

Quick Actions:

You can also use #xap-code for quick build and deploy operations without going through the full 4-step workflow:

#xap-code build private\xapnext\Crisp\Crisp.sln and upload to pixp

This workflow guides you through writing XAP code in 4 structured steps:

💡 Tip: At each step, intermediate files will be saved to .github/repohandbook/. Please review these files when prompted to ensure accuracy before proceeding to the next step.

💡 Tip: There will be cat greeting at each llm response. If you don't see the greeting, it means context becomes too long, open a new chat and use #xap-code please continue with <intermediate_file> (e.g., requirement_xxx.md, design_xxx.md, or code_xxx.md) to resume.

Installation

From VS Code Marketplace

1. Open Extensions (Ctrl+Shift+X)
2. Search "XAP Coding Assistant"
3. Click Install

From Command Line

code --install-extension xap-platform.xap-coding-assistant

From VSIX

code --install-extension xap-coding-assistant-1.0.0.vsix

How It Works

This extension follows the LLM + Prompts + Handbook design:

1. Tools provide context - Prompts and handbooks are bundled in the extension
2. LLM follows prompts - Copilot uses the prompts to guide the workflow
3. User interaction - Multi-turn conversation for clarification and approval
4. Files saved to .github/repohandbook/ - Understanding, requirements, and designs are saved for reference

The tools do NOT orchestrate the workflow themselves - they simply provide the right context for Copilot to follow the prompts naturally.

Files Created

The tools save workflow artifacts to the .github/repohandbook/ folder in your workspace:

You can review these files at any time and add .github/repohandbook/ to .gitignore if desired.

Requirements

• VS Code 1.100.0 or higher
• GitHub Copilot extension

License

Internal Microsoft use only.