OpenParable
Skip to content
← Back to skills

Qdk Programming

Development
qdk-programming

Qdk Programming is an Agent Skill for development published in the microsoft/qdk repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

QDK programming guide for Q#, OpenQASM, and the qsharp/qdk Python API. Use when: writing or editing Q# or OpenQASM code, running quantum programs, resource estimation, circuit generation, noisy simulation, Azure Quantum submission, Qiskit/Cirq/PennyLane interop, or Q# testing and standard library usage.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/microsoft/qdk/blob/HEAD/source/vscode/skills/qdk-programming/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/qdk-programming, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

QDK Programming

Quantum programming with the Microsoft Quantum Development Kit (QDK).

Two Modes

Most QDK features work in two modes:

  1. Tool mode — use provided tools to work with standalone .qs / .qasm files directly. No Python required.
  2. Python mode — the user writes Python scripts or Jupyter notebooks, using the qsharp/qdk Python packages as a driver for Q#/OpenQASM programs.

Default to tool mode unless the user is already working in Python or the feature is Python-only.

Reference Files

FileContent
qsharp.mdQ# language syntax, types, quantum operations, standard library, project structure
openqasm.mdOpenQASM 2.0/3.0 syntax, standard gates, version differences
python.mdqsharp/qdk Python API for execution, estimation, circuits, noise, Azure, Qiskit/Cirq, setup

Features

FeatureTool modePython mode
Writing Q# codeRead qsharp.mdRead qsharp.md
Writing OpenQASM codeRead openqasm.mdRead openqasm.md
Running a programqdkRunProgrampython.md — Running Q# Code
Resource estimationqdkRunResourceEstimatorpython.md — Resource Estimation
Circuit diagramsqdkGenerateCircuitpython.md — Circuit Generation
Azure QuantumUse the azureQuantum* toolspython.md — Azure Quantum
Noisy simulation— (Python only)python.md — Noisy Simulation
Q#/OpenQASM in Python and/or Jupyter— (inherently Python)python.md
Qiskit / Cirq / PennyLane interop— (inherently Python)python.md — Framework Interop

Quantum Katas

Quantum Katas are a collection of self-paced tutorials built into the QDK that teach quantum computing from the ground up. If the user wants to learn through the Quantum Katas, encourage them to use the /qdk-learning prompt to chat with the QDK Learning agent, which provides a guided, chat-embedded experience.

Deprecations

  • The QDK was rewritten in 2024. It no longer uses the IQ# Jupyter kernel or dotnet CLI tools.