QnAMaker Runtime ClientMCP Configuration & Schema Registry
The QnAMaker Runtime Client Model Context Protocol (MCP) configuration provides a validated, machine-readable JSON schema and executable bridge that connects state-of-the-art AI coding assistants — including Claude Desktop, Cursor IDE, Windsurf, Cline, and VS Code Copilot — directly to the QnAMaker Runtime Client REST API. By leveraging the standardized open Model Context Protocol, AI agents can dynamically discover capabilities, validate input parameters against strict JSON Schemas, and execute live API operations without context switching or manual copy-pasting.
Quick Specs & Integration Summary
Technical Architecture & Protocol Semantics
Under the Model Context Protocol specification, the QnAMaker Runtime Client configuration functions as an isolated protocol adapter. When an AI agent initializes a session, the client establishes a bidirectional JSON-RPC 2.0 communication channel over standard input/output (stdio) or Server-Sent Events (SSE). During the initial handshake, the server publishes its tool manifest extracted from the QnAMaker Runtime Client OpenAPI specification (version 4.0).
The QnAMaker Runtime Client API provides a direct runtime interface for interacting with pre-deployed QnAMaker knowledge bases, enabling the generation of answers from curated content and the ongoing training or refinement of the underlying AI models. Developed by Microsoft as part of its Azure Cognitive Services suite, this API is the essential backend service for applications that have already created, configured, and published a QnAMaker knowledge base. Its core capabilities are focused on two critical operational tasks: querying the knowledge base to retrieve precise, ranked answers for user questions (via the POST /knowledgebases/{kbId}/generateAnswer endpoint) and submitting new question-answer pairs or editorial feedback to continuously improve the model's accuracy and relevance (via the POST /knowledgebases/{kbId}/train endpoint). Typical enterprise use cases include powering intelligent chatbots for customer support, creating internal helpdesk or IT support assistants, and building dynamic FAQ systems for products or services where information must be rapidly accessible and regularly updated. Exposing this API as tools within an AI coding assistant through the Model Context Protocol (MCP) unlocks significant value by bridging the gap between static documentation and dynamic, context-aware automation. An MCP server wrapping these endpoints transforms the assistant from a passive code generator into an active participant in the application lifecycle. The primary value lies in enabling the AI to directly query the live knowledge base it is helping to build or modify, providing immediate, data-grounded context during development. Instead of a developer manually testing sample questions, the AI agent can simulate end-user interactions by invoking the generateAnswer tool, validating response quality in real-time. Furthermore, by granting access to the train endpoint, the AI can be instructed to programmatically update the knowledge base based on discovered documentation gaps, new feature releases, or aggregated user feedback from other parts of the application stack, creating a closed-loop system for knowledge maintenance. With this MCP server configured, a developer can instruct the AI coding assistant to perform a variety of dynamic, integrated tasks. For example, a developer can issue a command such as "Use the QnAMaker tools to test our new product documentation API with the following ten sample questions and report any answers with low confidence scores," prompting the agent to query the knowledge base and generate a quality assurance report. In another scenario, the instruction "Analyze the last 50 failed customer service interactions from our logs, extract recurring questions not handled well, and use the QnAMaker tools to add them as new suggested questions to our support knowledge base" would drive the AI to identify content gaps and directly submit training data. The agent could also be told to "Automate a weekly documentation sync by checking the release notes from our software repository and creating corresponding training entries in the QnAMaker knowledge base to ensure answers reflect the latest version," thereby automating a critical maintenance workflow. While the current specification notes an authentication method of "None," this is strictly a development or sandbox configuration and is critically insecure for any production or integrated environment. For secure deployment, this API must be protected with robust authentication, typically via Azure Active Directory (Azure AD) OAuth 2.0 tokens or primary/secondary keys generated in the Azure Portal. Developers implementing the MCP server must therefore treat the knowledge base ID and any associated keys as sensitive secrets, managing them through environment variables or a secure secrets manager, never hardcoding them. The principle of least privilege is paramount; the credentials used by the AI agent should be scoped to only the specific knowledge base it needs to interact with. It is highly recommended to use separate, tightly-scoped keys for read-only (generateAnswer) and read-write (train) operations, if the provider allows, to minimize the potential impact of a credential compromise. This architecture guarantees strict process boundary isolation: all sensitive authorization headers and secret tokens remain sandboxed inside the client runtime, never leaking into language model context windows or external logging endpoints.
Hosted Remote Configuration URL
MCP Configuration FileProvide this hosted URL in any client that supports remote MCP schema auto-loading.
https://mcpbridge.org/config/azure-com-cognitiveservices-qnamakerruntime.json2. AI Assistant Use Cases & Practical Workflows
Tailored for Developer ToolsReal-world execution scenarios demonstrating how LLM agents (Claude 3.7, GPT-4o, Cursor Agent) invoke QnAMaker Runtime Client tools to automate developer workflows.
1. CI/CD Build Failure & Telemetry Diagnostics
CI/CD RemediationInstantly diagnose failing CI/CD builds or deployment pipelines by streaming build logs, isolating failure root causes, and drafting targeted code fixes.
"Fetch recent pipeline run logs from QnAMaker Runtime Client. Isolate the failed step, summarize the exact compiler or test failure error, and propose a pull request fix in Cursor."
2. Cloud Resource Auditing & Cost Optimization
Cloud FinOpsScan active compute clusters, storage buckets, and networking configurations to identify unattached volumes or idle oversized instances.
"Query active cloud infrastructure resources in QnAMaker Runtime Client. Identify unattached storage volumes, idle compute instances, and summarize estimated monthly cost savings."
3. Zero-Downtime Rollout & Canary Health Verification
Deployment OpsOrchestrate progressive deployments, monitor error rate thresholds on newly deployed pods, and execute automated rollbacks if error budgets breach.
"Check the active deployment rollout status in QnAMaker Runtime Client. Monitor canary error rate percentages for 5 minutes and report whether the deployment is safe to promote to 100% traffic."
4. Infrastructure as Code (IaC) Drift Detection
IaC GovernanceCompare live deployed resource state against Terraform or CloudFormation definitions to spot unauthorized manual changes.
"Scan live configurations via QnAMaker Runtime Client and compare against our repository IaC definitions. Highlight any configuration drift in security groups or network routes."
End-to-End Multi-Step Agent Execution Lifecycle
When an engineer submits a task to Claude Desktop or Cursor, the LLM executes an autonomous 4-phase Model Context Protocol loop:
Schema Introspection
Handshake lists all 2 tools and builds argument validators.
Argument Synthesis
Model extracts parameters from prompt and validates types against OpenAPI rules.
Stdio Execution
Bridge invokes live API with injected local credentials and captures raw HTTP response.
Output Remediation
LLM parses JSON results, handles status codes, and presents synthesized answers.
3. Multi-Client Installation Matrix & Setup Guides
Select your AI assistant below to view exact configuration file paths, JSON installation snippets, and launch commands.
Claude Desktop
claude_desktop_config.json~/Library/Application Support/Claude/claude_desktop_config.json%APPDATA%\Claude\claude_desktop_config.json~/.config/Claude/claude_desktop_config.json{
"mcpServers": {
"azure-com-cognitiveservices-qnamakerruntime": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-openapi",
"https://api.apis.guru/v2/specs/azure.com/cognitiveservices-QnAMakerRuntime/4.0/swagger.json"
],
"env": {
"QNAMAKER_RUNTIME_CLIENT_API_KEY": "your_qnamaker_runtime_client_api_key"
}
}
}
}Cursor IDE
.cursor/mcp.jsonOpen Cursor Settings → Features → MCP Servers, or create .cursor/mcp.json in your project root.
{
"mcpServers": {
"azure-com-cognitiveservices-qnamakerruntime": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-openapi",
"https://api.apis.guru/v2/specs/azure.com/cognitiveservices-QnAMakerRuntime/4.0/swagger.json"
],
"env": {
"QNAMAKER_RUNTIME_CLIENT_API_KEY": "your_qnamaker_runtime_client_api_key"
}
}
}
}Saves as .cursor/mcp.json in the download. Move it to your project root.
VS Code / Cline Extension
cline_mcp_settings.jsonPaste into your Cline extension MCP configuration or Roo Code host settings.
{
"mcpServers": {
"azure-com-cognitiveservices-qnamakerruntime": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-openapi",
"https://api.apis.guru/v2/specs/azure.com/cognitiveservices-QnAMakerRuntime/4.0/swagger.json"
],
"env": {
"QNAMAKER_RUNTIME_CLIENT_API_KEY": "your_qnamaker_runtime_client_api_key"
}
}
}
}Zed Editor & Docker CLI
Zed / DockerDocker container execution command:
docker run -i --rm -e QNAMAKER_RUNTIME_CLIENT_API_KEY="YOUR_SECRET_VALUE" node:20-alpine npx -y @modelcontextprotocol/server-openapi https://api.apis.guru/v2/specs/azure.com/cognitiveservices-QnAMakerRuntime/4.0/swagger.json
Zed settings context servers JSON:
{
"context_servers": {
"azure-com-cognitiveservices-qnamakerruntime": {
"command": {
"path": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-openapi",
"https://api.apis.guru/v2/specs/azure.com/cognitiveservices-QnAMakerRuntime/4.0/swagger.json"
],
"env": {
"QNAMAKER_RUNTIME_CLIENT_API_KEY": "your_qnamaker_runtime_client_api_key"
}
}
}
}
}Programmatic SDK Integration (TypeScript / Python)
Initialize the QnAMaker Runtime Client MCP client directly in your backend codebase.
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
// Initialize QnAMaker Runtime Client MCP client transport over stdio
const transport = new StdioClientTransport({
command: "npx",
args: ["-y","@modelcontextprotocol/server-openapi","https://api.apis.guru/v2/specs/azure.com/cognitiveservices-QnAMakerRuntime/4.0/swagger.json"],
env: { QNAMAKER_RUNTIME_CLIENT_API_KEY: process.env.QNAMAKER_RUNTIME_CLIENT_API_KEY || "YOUR_SECRET_KEY" }
});
const client = new Client(
{ name: "azure-com-cognitiveservices-qnamakerruntime-client", version: "1.0.0" },
{ capabilities: { tools: {}, resources: {}, prompts: {} } }
);
async function connectAndRun() {
await client.connect(transport);
const tools = await client.listTools();
console.log("Connected to QnAMaker Runtime Client MCP Server.");
console.log("Discovered 2 mapped tools:", tools);
}
connectAndRun().catch(console.error);Raw Stdio Schema Definition
schema.jsonFor standalone CLI wrappers, background daemon daemons, or custom script integrations:
{
"mcpServers": {
"azure-com-cognitiveservices-qnamakerruntime": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-openapi",
"https://api.apis.guru/v2/specs/azure.com/cognitiveservices-QnAMakerRuntime/4.0/swagger.json"
],
"env": {
"QNAMAKER_RUNTIME_CLIENT_API_KEY": "your_qnamaker_runtime_client_api_key"
}
}
}
}4. Security, Authentication & Credential Management
Safely configure authentication tokens, isolate execution environments, and implement enterprise security best practices.
Required Environment Keys Reference
| Variable Name | Required | Type | Default | Purpose & Guidance |
|---|---|---|---|---|
| QNAMAKER_RUNTIME_CLIENT_API_KEY | REQUIRED | Secret Key / Token | None (Set in env) | your_qnamaker_runtime_client_api_key |
Zero-Downtime Token Rotation Protocol
- Generate Secondary Key: Create a new secret API token with identical scopes in your QnAMaker Runtime Client developer portal.
- Update Client Configuration: Insert the new token inside the
envblock of your MCP client JSON config. - Validate Connection: Issue a test query in Claude or Cursor to ensure handshake and tool calls succeed.
- Revoke Stale Token: Decommission the legacy key on the vendor portal to prevent unauthorized access.
Least-Privilege & Sandboxing Rules
- Read-Only Token Scoping: Whenever your workflow only requires querying data, provision read-only credentials to prevent accidental mutations.
- Local Process Isolation: Stdio transports run in isolated local subprocesses; secret credentials are never sent across the internet to MCP Bridge servers.
- Prompt Injection Defense: AI model responses are sandboxed; verify generated destructive arguments before confirming execution in agent mode.
Enterprise Security Checklist (Mandatory Practices)
- Never commit
claude_desktop_config.jsonor.cursor/mcp.jsoncontaining raw secrets into public GitHub repositories. - Add
.cursor/mcp.jsonand.env.localto your project's.gitignorefile. - Always enforce TLS/HTTPS encryption on outbound network requests initiated by the server process.
5. Tool Parameter Schemas & Natural Language Execution
Mapped OpenAPI operations converted into discrete Model Context Protocol tools with strict JSON-RPC payload validators.
/knowledgebases/{kbId}/generateAnswerGenerateAnswer call to query the knowledgebase.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "azure-com-cognitiveservices-qnamakerruntime_post_knowledgebases__kbId__generateAnswer",
"arguments": {}
}
}"Use QnAMaker Runtime Client to execute GenerateAnswer call to query the knowledgebase. and output the formatted result."
/knowledgebases/{kbId}/trainTrain call to add suggestions to the knowledgebase.
{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": {
"name": "azure-com-cognitiveservices-qnamakerruntime_post_knowledgebases__kbId__train",
"arguments": {}
}
}"Use QnAMaker Runtime Client to execute Train call to add suggestions to the knowledgebase. and output the formatted result."
6. Interactive Troubleshooting & FAQ Accordion
Diagnose and resolve common JSON-RPC protocol error codes, connection disconnects, and schema refresh issues.
A 401 Unauthorized response indicates that the upstream QnAMaker Runtime Client API rejected the authentication credential supplied in your MCP client's environment configuration. To resolve this: (1) Verify that your secret token is defined inside the "env" block of claude_desktop_config.json or .cursor/mcp.json rather than hardcoded in the command string. (2) Check whether QnAMaker Runtime Client requires a prefix such as "Bearer <token>" in the authorization header. (3) Confirm that your API key has not expired and has been granted sufficient least-privilege scopes on the QnAMaker Runtime Client developer dashboard.
If your MCP client fails to initialize tools for QnAMaker Runtime Client: (1) Test the bridge launcher command ("npx -y @modelcontextprotocol/server-openapi https://api.apis.guru/v2/specs/azure.com/cognitiveservices-QnAMakerRuntime/4.0/swagger.json") directly inside your terminal or shell to inspect stdout/stderr diagnostic traces. (2) Verify network connectivity to the schema source (https://api.apis.guru/v2/specs/azure.com/cognitiveservices-QnAMakerRuntime/4.0/swagger.json). (3) Ensure Node.js (v18+) is installed and accessible in your system PATH. (4) For authenticated APIs, confirm credentials are configured in your client's "env" mapping rather than command arguments.
MCP clients like Claude Desktop and Cursor query the server's tools list ("tools/list") during startup and cache the resulting JSON Schema for the duration of the application session. If new endpoints or parameters are added to QnAMaker Runtime Client: (1) Fully quit and restart Claude Desktop (Cmd+Q on macOS or File > Exit on Windows). (2) In Cursor IDE, navigate to Settings > Features > MCP Servers, toggle the QnAMaker Runtime Client server off and on, or click the refresh icon to re-execute the initialization handshake.
If the AI model hallucinates parameters or fails to invoke a tool automatically: (1) Add explicit system instructions in your project's .cursorrules or Claude project prompt (e.g., "When querying Developer Tools, always invoke the azure-com-cognitiveservices-qnamakerruntime MCP server tools first"). (2) Ensure parameter types match schema specifications (e.g., passing integers as numbers rather than strings). (3) Check that required parameters marked in Section 5 are not omitted from the model's generated payload.
When the QnAMaker Runtime Client upstream endpoint returns an HTTP 429 Too Many Requests response, the MCP server bubbles the structured error payload back to the AI client over stdio. Modern LLMs like Claude 3.7 and Cursor Agent recognize rate-limiting status codes, inspect the "Retry-After" header if present, and will automatically introduce backoff delays or ask the user before retrying the operation.
The Hosted Config URL (https://mcpbridge.org/config/azure-com-cognitiveservices-qnamakerruntime.json) provides a static, remote JSON schema definition that cloud-native MCP clients can fetch over HTTPS for dynamic discovery. In contrast, local stdio configurations execute a local subprocess on your workstation. Local stdio processes offer maximum security because secret API keys remain strictly on your local machine and never transit third-party proxy servers.
Similar Developer Tools Configurations
Explore related API bridges with ready-to-use Model Context Protocol schemas.
GitHub API
Developer ToolsAccess GitHub repositories, issues, pull requests, and more. Integrate GitHub workflows directly into your AI agent.
https://mcpbridge.org/config/github.jsonGitLab API
Developer ToolsManage repositories, CI/CD pipelines, and merge requests through your AI agent.
https://mcpbridge.org/config/gitlab.jsonBox Platform API
Developer ToolsThe Box Platform API, provided by Box (box.com), is a robust and comprehensive RESTful service that enables deep integration with the Box cloud content management ecosystem. It serves as the programmatic backbone for enterprises and developers seeking to build custom applications and workflows that interact with content stored securely in Box. Its core capabilities extend far beyond basic file operations, encompassing a full spectrum of content lifecycle management. Developers can programmatically create, upload, download, search, and manage files and folders, but the API's true power lies in its enterprise-grade features. These include advanced collaboration management through invitations and permissions, granular user and group administration within an enterprise directory, and sophisticated security and compliance controls. Specific endpoint groups for managing collaboration whitelists and exempt targets allow for precise governance over external sharing policies, ensuring that content is only shared with approved domains. Furthermore, the API facilitates complex legal and compliance use cases, such as placing items on legal hold or applying retention policies, making it an indispensable tool for regulated industries and large organizations. Exposing this API as tools via the Model Context Protocol (MCP) for AI coding assistants transforms it from a static integration point into a dynamic, conversational development partner. The value lies in delegating repetitive, structured, and context-aware platform operations to the AI agent. Instead of manually writing scripts or navigating multiple dashboard clicks, a developer can instruct the AI to perform precise actions using natural language, which the AI translates into the correct API calls. For instance, an AI assistant equipped with these MCP tools can intelligently query the `GET /collaborations` endpoint to analyze the permission landscape for a sensitive project folder, or it can generate the necessary configuration to programmatically whitelist a new partner domain using `POST /collaboration_whitelist_entries`. This drastically accelerates development and operational workflows, reduces the cognitive load on developers, and minimizes the risk of manual errors in scripting repetitive tasks, effectively embedding the Box Platform's capabilities directly into the developer's AI-augmented workflow. Within this MCP-enabled environment, a developer can instruct the AI agent to perform a variety of powerful, dynamic tasks. For example, a natural language command like, "Set up the standard folder structure for our new 'Project Phoenix' initiative under the Corporate Engineering directory, then add the legal team as collaborators with viewer-only permissions," can be orchestrated by the AI. It would sequentially create the folder hierarchy via the file management endpoints, search for the existing 'Legal' group using the user management APIs, and finally apply the correct permissions using the collaborations endpoint. Another practical workflow involves security auditing; a developer could ask, "List all external collaborations on files within the '2024 Financial Reports' folder and check if any are outside our approved vendor list." The AI agent would query the relevant endpoints, cross-reference the results against the collaboration whitelist entries via `GET /collaboration_whitelist_entries`, and provide a concise report or even take corrective action by revoking specific collaborations if instructed. Critical attention must be paid to authentication and security when implementing this API integration. While the described endpoints use a 'None' authentication method for the initial `GET /authorize` step (which is part of the OAuth 2.0 flow initiation), all subsequent data operations require a valid OAuth 2.0 access token. The principle of least privilege is paramount; developers must configure their applications with the narrowest OAuth scopes necessary for their specific use case, avoiding broad `read_write_all` scopes when `read_only` or scoped write access suffices. All tokens must be stored securely, and refresh tokens should be handled with care. For enterprise deployments, administrators should enable Box's IP whitelisting for API access and mandate two-factor authentication for associated accounts. Furthermore, developers must implement rigorous error handling and leverage Box's comprehensive webhook system for event-driven architectures, rather than relying solely on polling. Finally, all API interactions should be logged for audit trails, especially when managing compliance-related features like legal holds or retention policies, to ensure accountability and support for regulatory requirements.
https://mcpbridge.org/config/box-com.jsonAsana
Developer ToolsThis API serves as the programmatic backbone for the Asana work management platform, provided by Asana, Inc. It enables developers to interact programmatically with one of the world's leading enterprise collaboration and productivity suites. The core capabilities of this interface center around the CRUD (Create, Read, Update, Delete) operations for fundamental Asana objects. Specifically, the provided endpoints grant control over project attachments—allowing for the uploading, retrieval, and management of files associated with tasks and projects—and custom fields, which are pivotal for creating structured, data-rich workflows. These custom fields allow organizations to define unique data types (like dropdown menus, text fields, or dates) to standardize information capture across projects, moving beyond basic task lists to true operational tracking. Typical use cases span from enterprise project management offices (PMOs) needing to programmatically generate status reports and audit attachments, to development teams automating the creation of bug-tracking projects with predefined custom fields for severity and status, to operational leaders building dashboards that aggregate and analyze custom field data for resource allocation insights. When exposed as tools via the Model Context Protocol (MCP) to an AI coding assistant like Claude Desktop or Cursor, this API transforms from a static set of endpoints into a dynamic, conversational work orchestration layer. The value proposition is profound: it bridges the gap between natural language intent and structured work management execution. An AI assistant equipped with these MCP tools gains the ability to understand and manipulate the very fabric of a team's operational workflow. Instead of a developer manually writing scripts to query project attachments for an audit or updating custom fields to trigger a workflow state change, they can issue plain English commands. This integration enables the AI to act as a highly specialized "project operations agent," capable of reasoning about work data, making updates based on complex criteria, and automating routine administrative tasks that typically consume valuable engineering or management time. The context window allows the AI to maintain awareness of recent interactions, making iterative tasks like "find all attachments from last week and summarize them" or "change the 'Priority' field to 'High' for all tasks assigned to me due this week" seamless and efficient. Practical workflow examples highlight the powerful automation possibilities. A developer could instruct their AI agent: "Query all attachments on the 'Q3 Launch' project and generate a CSV list of filenames and their parent tasks for documentation." The AI would leverage the GET /attachments endpoint (with appropriate project filtering) to compile this report instantly. For a more complex update: "For every task in the 'Backlog' project that has the custom field 'Estimated Hours' set to more than 10, create a subtask titled 'Breakdown Required' and update the 'Status' custom field to 'Needs Refinement'." Here, the AI would orchestrate a sequence: first querying tasks using the custom fields API (once a GET for custom fields is available or via linked object data), then using the POST /batch endpoint to efficiently create multiple subtasks and update multiple custom fields in a single, optimized API call. Furthermore, an agent could be tasked with "Set up a new bug report template by creating a 'Bug' project and adding the custom fields 'Bug ID' (text), 'Severity' (dropdown), and 'Component' (dropdown) with the appropriate options," automating a multi-step project setup process that would otherwise require numerous manual clicks or complex scripting. Despite the current configuration indicating no authentication requirement for this specific API definition, a rigorous approach to security is non-negotiable in any real-world implementation. Developers must treat this API as a conduit to their organization's critical work data. All interaction must be authenticated using Asana's standard OAuth 2.0 flow or Personal Access Tokens, ensuring every action is attributable and authorized. The principle of least privilege is essential: create and use API tokens with the narrowest possible scope. For instance, if a tool's sole purpose is to read attachments, its token should not have permission to delete them or modify project structures. When deploying an MCP server, it is critical to securely manage and store credentials, avoiding hardcoding and utilizing environment variables or secret management services. Network security should enforce HTTPS for all API calls, and developers should implement robust error handling and logging to monitor for unusual activity without exposing sensitive data. Rate limiting awareness is also key to building resilient applications that respect Asana's API service limits.
https://mcpbridge.org/config/asana-com.json