Skip to content

aktsmm/vscode-copilot-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VS Code + GitHub Copilot スターターキット

VS Code と GitHub Copilot を活用した Azure 開発環境のセットアップガイドです。

💻 対象環境: 本ガイドは Windows + PowerShell 環境向けです。Mac / Linux の場合はコマンドを適宜読み替えてください。

使いこなすと、こんなことができます:

  • 🤖 MCP 連携: MS Learn Docs MCP などを使い、公式ドキュメントを参照しながら正確な回答を得る
  • 📝 カスタム Agent: Azure 専門家・レポート作成・コードレビューなど、専門特化した AI アシスタントを作成(エージェント間のワークフローも構築可能)
  • 🏗️ Bicep 開発: AI アシスタントで IaC(Infrastructure as Code)をスムーズに記述
  • 🔧 Copilot カスタマイズ: プロジェクト固有のルールやプロンプトテンプレートを定義
  • ☁️ Azure CLI 連携: AI が CLI コマンドを実行してリソース把握・デプロイ・トラブルシューティングを支援

📸 注意: 本ガイドのスクリーンショットは 2025 年 12 月時点 のものです。UI や手順が変更されている場合は、適宜読み替えて公式ドキュメントを参照してください。


📑 目次


事前準備(必須)

以下の手順でセットアップを進めてください。最後の「準備完了の確認」で動作確認ができます。

📋 前提条件

必要なもの 用途 備考
Windows 10/11 本ガイドの対象 OS Mac / Linux は適宜読み替え
GitHub アカウント Copilot 利用、Git 操作 無料で作成可能
GitHub Copilot ライセンス AI コード補完・Chat・Agent Free(無料)/ Pro / Pro+ / Business / Enterprise
Azure アカウント Bicep デプロイ、Azure リソース操作 ⭐ 推奨(なくても Bicep の編集・構文チェックは可能)

💡 GitHub Copilot Free($0)で始められます。主に使う Agent モード(IDE 内)は Free でも利用可能(50 回/月)。詳細は Copilot 料金ページ を参照。

📖 プラン比較・エージェント機能の違い: GitHub Copilot プラン比較ガイド を参照。

🎯 準備のゴール

目的 作業内容 判定基準
VS Code での Bicep 開発 VS Code インストール & Bicep 拡張機能導入 .bicep ファイルでシンタックスハイライトされる
Copilot によるコード補完 GitHub Copilot 拡張機能導入 & GitHub ログイン コメントを書くと補完が動く
Copilot Chat / Agent GitHub Copilot Chat 拡張機能導入 Chat パネルで質問・Agent モードでファイル編集ができる
Azure 操作 Azure CLI インストール & az login az login でログインでき、リソース作成権限がある
Git 管理 Git CLI インストール git --version が動く
GitHub 操作 GitHub CLI インストール & gh auth login gh auth status が動く
MS Learn 参照 MCP サーバー設定 Copilot Chat で MS Learn が参照される

1. VS Code のインストール

公式サイトからダウンロード・インストール:
🔗 https://code.visualstudio.com/

💡 ターミナルの開き方・実行ポリシーなどは コマンドの実行場所 を参照。

インストール時に以下のオプションを選択してください(※英語環境での表記):

オプション 推奨 説明
Add "Open with Code" action to Windows Explorer file context menu ファイル右クリック →「Code で開く」
Add "Open with Code" action to Windows Explorer directory context menu フォルダ右クリック →「Code で開く」
Register Code as an editor for supported file types 任意 テキストファイルをダブルクリックで VS Code が開く(好みに合わせて)
Add to PATH ✅ 必須 ターミナルから code コマンドが使える

💡 Add to PATH は超必須です。これがないと拡張機能の一括インストールコマンドが動きません。

初回起動時の設定

VS Code を初めて起動すると「Get started with VS Code」画面が表示されます。

  1. 「Use AI features with Copilot for free」 をクリック → GitHub アカウントでサインイン
  2. サインイン完了後、右側に Copilot Chat パネル が表示されます
  3. 残りの項目(テーマ選択など)は任意でスキップ可能

💡 ポイント: GitHub にサインインすると、右側に「Build with Agent」パネルが表示され、Copilot Chat が使えるようになります。

2. VS Code 拡張機能の導入

以下の拡張機能を VS Code にインストールしてください(下のコマンドで一括インストール可能)。

💡 拡張機能について: これらは Bicep による IaC 開発 を想定した構成例です。概ねインストールして問題ありませんが、実際の用途に合わせて適宜取捨選択・追加してください。

拡張機能 用途
Japanese Language Pack VS Code の日本語化
Bicep Bicep ファイルの編集・バリデーション
GitHub Copilot AI によるコード補完
GitHub Copilot Chat AI とのチャットベース開発
Azure Resources Azure リソースのブラウズ・管理
Azure CLI Tools Azure CLI コマンドのシンタックスハイライト・実行
YAML YAML ファイルのバリデーション(CI/CD パイプライン等)
Prettier コードフォーマッター(JSON, YAML, Markdown 整形)
GitLens Git 履歴・blame の可視化

VS Code ターミナル(PowerShell)で実行Ctrl + @ でターミナルを開く):

以下をコピーして貼り付け、Enter キーを押すと 9 つの拡張機能が順番にインストールされます。

# 拡張機能を一括インストール
code --install-extension MS-CEINTL.vscode-language-pack-ja;
code --install-extension ms-azuretools.vscode-bicep;
code --install-extension GitHub.copilot;
code --install-extension GitHub.copilot-chat;
code --install-extension ms-azuretools.vscode-azureresourcegroups;
code --install-extension ms-vscode.azurecli;
code --install-extension redhat.vscode-yaml;
code --install-extension esbenp.prettier-vscode;
code --install-extension eamodio.gitlens;

💡 日本語化: Japanese Language Pack インストール後、VS Code を再起動すると日本語に切り替わります。切り替わらない場合は Ctrl + Shift + P → 「Configure Display Language」→「ja」を選択してください。

保存時の自動整形(推奨)

Prettier でファイル保存時に自動整形されるように設定しましょう。

  1. Ctrl + , で設定を開く
  2. 「format on save」で検索
  3. Editor: Format On Save にチェックを入れる

💡 GitHub Copilot のログイン: 拡張機能インストール後、VS Code 左下の人型アイコンをクリックして GitHub アカウントでサインインしてください。

💡 Copilot 関連の追加拡張機能について: GitHub Copilot for Azure など追加の拡張機能もありますが、インストール時に設定ファイル(.vscode/mcp.json 等)が自動生成されることがあります。上記の拡張機能だけで十分に Copilot を活用できます。

3. CLI ツールのインストール(Azure CLI / Git / GitHub CLI)

💡 CLI ツールについて: これらは Bicep による IaC 開発 を想定した構成例です。概ねインストールして問題ありませんが、実際の用途に合わせて適宜取捨選択・追加してください。

⚠️ Azure CLI について: Azure CLI は Azure リソースの操作に使用します。Azure アカウントがない場合はインストール不要ですが、Bicep テンプレートのデプロイができません(構文チェックや編集は可能)。

⚠️ 管理者権限の PowerShell で実行してください(VS Code ターミナルではなく)

スタートメニュー → 「PowerShell」を右クリック → 「管理者として実行」 で開いてください。

以下をコピーして貼り付け、Enter キーを押すとツールがインストールされます(約 15 分)。

# Git をインストール
winget install Git.Git;

# GitHub CLI をインストール
winget install GitHub.cli;

# Azure CLI をインストール(Azure を使う場合のみ)
winget install Microsoft.AzureCLI;

💡 winget が使えない場合は、各公式サイトからインストーラーをダウンロード:

💡 インストール後は VS Code を再起動 してください(PATH を反映するため)。

インストール確認 & ログイン(VS Code ターミナル Ctrl + @ で実行):

# バージョン確認(3つとも表示されれば OK)
az --version; git --version; gh --version

# Azure CLI を最新版に更新
az upgrade

# Bicep CLI をインストール(Bicep ファイルをデプロイする場合)
az bicep install

# Azure にログイン(対象サブスクリプションにリソース作成権限が必要)
az login

# GitHub にログイン
gh auth login

💡 az login を実行すると、ブラウザまたはサインイン画面が開きます。Azure サブスクリプションに紐づいたアカウントでサインインしてください。ログイン完了後の画面では「いいえ、このアプリのみにサインインします」を選択しておくと無難です。

⚠️ サインイン画面がバックグラウンドで表示されていることがあるので、見当たらない場合はタスクバーを確認してください。

📖 権限エラーが出る場合: Azure CLI の権限とロールについて を参照してください。

💡 gh auth login を実行すると、対話形式で認証方法を選択します:

  1. Where do you use GitHub?GitHub.com
  2. What is your preferred protocol for Git operations?HTTPS
  3. Authenticate Git with your GitHub credentials?Yes
  4. How would you like to authenticate GitHub CLI?Login with a web browser
  5. 表示されるワンタイムコード(例: 5669-6BF5)をコピーして Enter
  6. ブラウザが開くので、コードを入力して認証完了
  7. ターミナルに ✓ Logged in as <ユーザー名> と表示されれば成功

4. MCP サーバー (MS Learn) の設定

Copilot Chat から MS Learn ドキュメントを参照できるようになります。

方法 1: ワンクリックインストール(⭐ 推奨)

以下のリンクをクリックすると、VS Code が開いてインストール画面が表示されます。Install ボタンをクリックして設定完了です。

設定レベル リンク 説明
User Settings Install (User) 推奨: 全ワークスペースで有効(Azure/Microsoft 技術を使う人向け)
Workspace Settings Install (Workspace) 現在のワークスペースのみで有効(Git 管理してチーム共有可能)

💡 推奨理由: Azure や Microsoft 製品を扱う場面では、Copilot Chat が MS Learn の最新ドキュメントを参照できると回答精度が大幅に向上します。

📖 詳細: MS Learn MCP Server - GitHub

方法 2: 手動設定(クリックで展開)

Workspace Settings(現在のワークスペースのみ)

.vscode/mcp.json を作成し、以下の内容をコピー:
📄 samples/mcp-workspace.json

User Settings(全ワークスペース共通)

Ctrl + Shift + PPreferences: Open User Settings (JSON) を開き、以下の内容を追加:
📄 samples/mcp-user-settings.json

💡 優先順位: Workspace Settings(.vscode/mcp.json)が User Settings より優先されます。

⚠️ Organization ポリシーで MCP が制限されている場合

企業や組織で管理されている環境では、MCP サーバーへのアクセスがポリシーで制限されていることがあります。
設定 → Chat > Mcp: Access が「organization によって管理されています」と表示され、none に固定されている場合は MCP サーバーを利用できません。この場合は組織の IT 管理者に相談してください。

準備完了の確認

以下がすべて OK なら準備完了です。

VS Code ターミナル(PowerShell)で実行:

# 1. Azure CLI が使える
az account show --query "{Subscription:name, User:user.name}" -o table
# → エラーの場合: az login を実行してログイン

# 2. Git CLI が使える(git version 2.x.x のようにバージョンが表示される)
git --version

# 3. GitHub CLI が使える
gh auth status
# → エラーの場合: gh auth login を実行してログイン

4. GitHub Copilot が有効

VS Code で新規ファイル(例: test.js)を作成し、コメントを入力すると Copilot が補完候補を提案します。

// 1から10までの合計を計算する関数
// ↑ このようなコメントを書くと、Copilot が関数を提案してくれます

5. Bicep 拡張が動作

.bicep ファイルを開いてシンタックスハイライト(色分け)が表示されれば OK です。

// 例: test.bicep を作成して以下を貼り付け
resource storageAccount 'Microsoft.Storage/storageAccounts@2023-01-01' = {
  name: 'mystorageaccount'
  location: 'japaneast'
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
}

6. MCP サーバーが有効

Copilot Chat で MCP ツールを呼び出せれば OK です。

  1. Ctrl + Shift + I で Copilot Chat を開く(または右側の Copilot アイコンをクリック)

  2. 以下の 2 つのプロンプトを比較してみましょう:

    MCP ツールあり(MS Learn を参照):

    #MicrosoftDocs Azure ってなに
    

    MCP ツールなし(通常の Copilot):

    Azure ってなに
    
  3. #MicrosoftDocs を入力したパターンで MCP サーバーが呼び出されていれば OK

💡 確認ポイント: MCP ツールが使用されると、回答に以下が含まれます:

  • 「🔧 Used tools: microsoft_docs_search」のようなツール使用表示
  • https://learn.microsoft.com/... のソース URL

主な MCP ツール名:

ツール名 用途
mcp_microsoftdocs_microsoft_docs_search MS Learn ドキュメントを検索
mcp_microsoftdocs_microsoft_docs_fetch 特定ページの全文を取得
mcp_microsoftdocs_microsoft_code_sample_search コードサンプルを検索

補足情報

💻 コマンドの実行場所

本ガイドのコマンドは PowerShell 5.1 以上 で実行します(Windows 10/11 は標準搭載)。

実行場所 開き方
VS Code ターミナル VS Code で Ctrl + @ または メニュー → ターミナル → 新しいターミナル
Windows PowerShell スタートメニュー → 「PowerShell」で検索
Windows Terminal スタートメニュー → 「Terminal」で検索(⭐ 推奨)

VS Code ターミナルの開き方

  1. VS Code を開く
  2. 以下のいずれかでターミナルを開く:
    • キーボード: Ctrl + @(日本語キーボード)または Ctrl + `(英語キーボード)
    • メニュー: 表示ターミナル
    • コマンドパレット: Ctrl + Shift + P → 「Terminal: Create New Terminal」

推奨: VS Code ターミナルを使うと、コード編集とコマンド実行を同じウィンドウで行えて便利です。

⚠️ 実行ポリシー: スクリプト実行がブロックされる場合は、以下を実行してください。

Set-ExecutionPolicy -Scope CurrentUser RemoteSigned

💡 管理者権限について: 日常のコマンド実行には管理者権限は不要です。ただし、Azure CLI や Git のインストール時には管理者権限が必要です。

💡 PATH の反映: CLI ツールをインストールした後は VS Code を再起動 してください。PATH が反映されず、コマンドが見つからない場合があります。

📁 VS Code 設定の優先順位

本ガイドでは「User Settings」と「Workspace Settings」の 2 種類の設定場所が登場します。

設定場所 ファイル 適用範囲
User Settings %APPDATA%\Code\User\settings.json 全ワークスペース共通(個人設定)
Workspace Settings .vscode/settings.json 現在開いているフォルダ(ワークスペース)のみ

優先順位: Workspace Settings が User Settings より優先されます。

User Settings(グローバル)
    ↓ 上書き
Workspace Settings(.vscode/settings.json)

💡 使い分けの一例:

  • User Settings: 個人の好み(フォントサイズ、テーマなど)
  • Workspace Settings: プロジェクト固有のルール(フォーマッター設定など)→ Git 管理してチームで共有

📖 GitHub Copilot プラン比較ガイド

Free / Pro / Pro+ / Business / Enterprise の違いや、Agent モードと Coding Agent の違いを解説しています。

🔗 GitHub Copilot プラン比較ガイド

🌐 プロキシ環境での設定(プレビュー)

企業ネットワークなどプロキシ環境での設定方法をまとめています。

🔗 プロキシ環境での設定

🔒 ファイアウォール・通信要件

Azure CLI、GitHub Copilot、VS Code などの通信先エンドポイントをまとめています。ファイアウォールの許可リスト設定時に参照してください。

🔗 ファイアウォール・通信要件


参考リンク

About

VS Code + GitHub Copilot スターターキット - Azure Bicep 開発環境セットアップガイド

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors