Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 4.41 KB

File metadata and controls

86 lines (54 loc) · 4.41 KB

🚀 Setting up the AI Assisted Coding Framework in your project

This framework integrates several powerful MCP (Model Context Protocol) tools to supercharge your development workflow:

  • Context7 MCP: Provides live documentation and code snippet retrieval for authoritative technical references
  • Memory MCP: Delivers persistent project memory, decision tracking, and knowledge graph capabilities
  • Sequential Thinking MCP: Assists the LLM with ordering tasks, and breaking down complex ideas
  • Microsoft.Learn MCP: Give your LLM access to the entire Microsoft Learn knowledgebase!

Together, they transform GitHub Copilot into an intelligent development assistant that remembers project context, tracks architectural decisions, and maintains comprehensive project knowledge across sessions.

📋 Prerequisites

  • Node.js 16+ (for MCP tools)
  • IDE with GitHub Copilot[^1]
  • Docker is recommended, or you can use the devcontainer.
  • Git for version control

🛠️ Installation & Setup

Step 1: Clone The Framework Repository

Windows Terminal:

# Clone this repository
git clone https://github.com/ChrisMcKee1/AI-Assisted-Coding.git

We will use the files in this repository once you've setup your local workspace. Keep them somewhere easy to access, we recommend a folder such as C:\github\ or ~/github on Linux & OSX.

Step 2 (optional): Change the MCP Configuration

By default, we utilize the local MCP tools for caching and speed. However, if you don't have NodeJS installed, and do not wish to use NodeJS, you can instead utilize docker versions of each tool. To build and run the Docker version of the the tools, you will need to see the documentation for each to setup the docker config:

See the Context7 Docker Readme for instructions on how to use Docker to host Context7 locally.

See the Playwright MCP Readme for details on advanced configuration and docker support for Playwright.

See the Sequential Thinking MCP Readme for details on how to configure it using docker.

See the Memory MCP Readme for details on how to configure it using Docker

Important

If you intend to do this, please do this before coming to the workshop, and ensure they are setup and configured. This can take time to setup and troubleshoot, so be prepared. Our recommendation is to use the NodeJS versions of the tools.

Step 3: Clone the Inventree Repository

You'll be building this challenge using the popular Inventree demo repository. Clone the Inventree Repository from github to an easy to access location on your machine.

Step 4: Copy the Framework to the inventree repository

Copy the .github and .vscode folders from the AI-Assisted-Coding repository to the root of your inventree repository. An example script below assumes you cloned both repositories to the root of C:\github or ~/github respectively.

Powershell

cd c:\github\AI-Assisted-Coding
robocopy . "C:\github\inventree" /E /XD .git

Bash

cd ~/github
rsync -av --exclude='.git' . ~/github/inventree

Step 5: Run the Analyze Workflow

Open the inventree Solution using VS Code or your preferrred IDE.

Run the /analyze-product prompt in Copilot Agent Mode to analyze your woskpace and generate the documents that help the spec-driven development workflow operate smoothly.

Step 6: Verify Framework setup is completed

  1. Answer any questions that the AI prompts you with, and wait for it to complete.
  2. The framework will automatically generate the copilot-instructions.md file
  3. The framework should also generate a series of files in a folder named .docs
  4. Review these documents for accuracy, and fix any problems you see.

Step 7: Follow the instructions from the README.md file to run inventree locally

Follow the instructions in the README.md file at the base of the inventree Repository to setup the application locally. You'll want to ensure that you can reach the application, search inventory, and manage suppliers.

Next challenge

Now that you've setup the AI to be able to better understand and work within your repository, it's time to understand how to write requirements!