Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
Foundry IQ skills integration for GitHub Copilot CLI is in Public Preview and is subject to the Supplemental Terms of Use for Microsoft Azure Previews. For preview terms specific to this feature, see Preview functionality.
Query an existing Foundry IQ (Azure AI Search) knowledge base with citations and build a knowledge graph by using Foundry IQ skills in GitHub Copilot CLI. In this article, you install the foundry-iq-skills plugin and use its foundry-iq skill with your Azure resources.
Find the public plugin source in Foundry IQ Skills.
Prerequisites
- Git, required to add the plugin marketplace.
- GitHub Copilot CLI on Windows or Linux.
- Python 3.12 or later, required for the plugin's helper scripts.
- An existing knowledge base and access to its Azure subscription and resources.
- Azure CLI installed and signed in to query an existing knowledge base with this plugin. Use an authenticated Azure identity with permissions for the requested read or change. For query-access requirements, see Knowledge base retrieval prerequisites.
- Permission to view knowledge-base and knowledge-source definitions, in addition to query access. The Reader role can view object definitions. See Built-in roles.
Install the plugin
Run the slash commands in GitHub Copilot CLI, not in your operating system's shell.
Add the marketplace.
/plugin marketplace add microsoft/azure-skillsInstall the plugin.
/plugin install foundry-iq-skills@azure-skills
To update an installed plugin, run this command in Copilot CLI:
/plugin update foundry-iq-skills@azure-skills
Query an existing knowledge base
The skill starts with read-only checks. Identify your existing resources to keep discovery scoped to them. Choosing resources isn't approval to change them.
In Copilot CLI, identify your existing Foundry IQ service and knowledge base. Ask: "Query this knowledge base with citations."
If the skill asks whether to use an existing service, find compatible services, or create one, choose USE EXISTING. Supply the existing resource details it requests.
Ask a question about content in the knowledge base.
Review the retrieved answer and its citations for relevant content from the knowledge base.
Review change and cleanup boundaries
Querying an existing knowledge base is a read operation and doesn't require write approval. Other tasks can change Azure resources.
Before approving a change, review the plan shown by the skill. Approval is required to create a service, knowledge source, or knowledge base, connect a knowledge base to an agent, or make another planned resource change. Approval applies only to the unchanged plan; if the plan changes, the skill asks again.
Treat cleanup as a separate planning workflow. Supported deletion of resources created by the workflow requires separate approval. Don't combine creation and cleanup approval.
Recognize supported workflows
Beyond retrieval, the skill supports local-file and Azure Blob Storage or Azure Data Lake Storage knowledge sources, knowledge-base creation with retrieval validation, existing-agent connections, diagnosis, and cleanup planning. For source concepts, see Knowledge sources overview.
The skill supports connecting an existing multi-source knowledge base to an existing agent without changing the knowledge base.
Troubleshooting
If a marketplace registration, installation, or update command reports an error, stop before the knowledge base procedure. Confirm that you're running the slash commands inside GitHub Copilot CLI and that Git is available. For installation guidance, see Foundry IQ Plugin installation instructions.