iotHubClientMCP Configuration & Schema Registry
The iotHubClient 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 iotHubClient 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 iotHubClient 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 iotHubClient OpenAPI specification (version 2016-02-03).
The iotHubClient API, provided by Microsoft Azure, serves as the comprehensive management plane for Azure IoT Hub instances within a user's subscription. Its core capabilities encompass the full lifecycle management of IoT hubs, including provisioning, configuration, monitoring, and deletion. Developers and cloud architects use this API to programmatically control their IoT infrastructure, which is critical for enterprise-scale Internet of Things deployments. Typical use cases range from automated environment setup for continuous integration pipelines and dynamic scaling of hub resources based on traffic patterns, to centralized management of security credentials and diagnostic statistics across a fleet of IoT solutions. The API abstracts the complexity of the underlying Azure Resource Manager, providing a direct, RESTful interface to manipulate IoT hub resources, their associated keys, consumer groups, and operational statistics. When exposed as tools through the Model Context Protocol (MCP) to an AI coding assistant, this API unlocks significant development acceleration and cognitive support. The AI gains the ability to perform complex, context-aware infrastructure operations through natural language commands. For instance, instead of manually writing and executing multi-line Azure CLI commands or navigating the Azure Portal, a developer can instruct the AI to "list all IoT hubs in the 'production' resource group" or "generate a new set of security keys for the 'primary-hub' and display them." This integration transforms the AI from a code-completion tool into an active infrastructure collaborator, capable of querying state, validating configurations, and executing changes, thereby reducing context switching and the potential for manual error in repetitive or complex administrative tasks. Practical workflow examples demonstrate the power of this integration. A developer can ask the AI to perform dynamic tasks such as: "Query all IoT hubs in my subscription and create a summary table showing their name, location, and current unit count to identify underutilized resources." The AI can then use the GET list endpoints to gather this data. For automation, a command like "Update the 'event-hub-dev' IoT hub to increase its SKU tier to S2 and then list its new primary connection string" would translate to the AI executing a PUT operation followed by a POST to the listkeys endpoint. Furthermore, the AI can manage event processing routes by performing actions like "Get all consumer groups on the 'telemetry' endpoint of the 'central-hub' and report which ones have the name pattern 'live-*'," utilizing the specific consumer group enumeration endpoints to provide immediate, actionable insight. Critical to the secure deployment of this API, especially when integrated with an AI assistant, is the strict adherence to authentication and authorization principles. Although the basic endpoint list references no authentication, the iotHubClient API is inherently protected by Azure Active Directory. All calls must be authenticated with a valid Azure AD token, and the calling principal must be assigned an appropriate Role-Based Access Control (RBAC) role, such as "IoT Hub Data Contributor" or "IoT Hub Registry Contributor," on the target subscription or resource group. Best practices dictate applying the principle of least privilege—granting only the permissions necessary for the specific task. Developers configuring an MCP server for this API must ensure that the AI agent's service principal or managed identity is configured with precise, scoped permissions to prevent unauthorized actions, and that all communication occurs over encrypted channels. It is imperative to avoid hardcoding credentials and to leverage secure secret management solutions like Azure Key Vault. 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-iothub.json2. AI Assistant Use Cases & Practical Workflows
Tailored for Cloud InfrastructureReal-world execution scenarios demonstrating how LLM agents (Claude 3.7, GPT-4o, Cursor Agent) invoke iotHubClient 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 iotHubClient. 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 iotHubClient. 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 iotHubClient. 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 iotHubClient 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 10 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-iothub": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-openapi",
"https://api.apis.guru/v2/specs/azure.com/iothub/2016-02-03/swagger.json"
],
"env": {
"IOTHUBCLIENT_API_KEY": "your_iothubclient_api_key"
}
}
}
}Cursor IDE
.cursor/mcp.jsonOpen Cursor Settings → Features → MCP Servers, or create .cursor/mcp.json in your project root.
{
"mcpServers": {
"azure-com-iothub": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-openapi",
"https://api.apis.guru/v2/specs/azure.com/iothub/2016-02-03/swagger.json"
],
"env": {
"IOTHUBCLIENT_API_KEY": "your_iothubclient_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-iothub": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-openapi",
"https://api.apis.guru/v2/specs/azure.com/iothub/2016-02-03/swagger.json"
],
"env": {
"IOTHUBCLIENT_API_KEY": "your_iothubclient_api_key"
}
}
}
}Zed Editor & Docker CLI
Zed / DockerDocker container execution command:
docker run -i --rm -e IOTHUBCLIENT_API_KEY="YOUR_SECRET_VALUE" node:20-alpine npx -y @modelcontextprotocol/server-openapi https://api.apis.guru/v2/specs/azure.com/iothub/2016-02-03/swagger.json
Zed settings context servers JSON:
{
"context_servers": {
"azure-com-iothub": {
"command": {
"path": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-openapi",
"https://api.apis.guru/v2/specs/azure.com/iothub/2016-02-03/swagger.json"
],
"env": {
"IOTHUBCLIENT_API_KEY": "your_iothubclient_api_key"
}
}
}
}
}Programmatic SDK Integration (TypeScript / Python)
Initialize the iotHubClient MCP client directly in your backend codebase.
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
// Initialize iotHubClient MCP client transport over stdio
const transport = new StdioClientTransport({
command: "npx",
args: ["-y","@modelcontextprotocol/server-openapi","https://api.apis.guru/v2/specs/azure.com/iothub/2016-02-03/swagger.json"],
env: { IOTHUBCLIENT_API_KEY: process.env.IOTHUBCLIENT_API_KEY || "YOUR_SECRET_KEY" }
});
const client = new Client(
{ name: "azure-com-iothub-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 iotHubClient MCP Server.");
console.log("Discovered 10 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-iothub": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-openapi",
"https://api.apis.guru/v2/specs/azure.com/iothub/2016-02-03/swagger.json"
],
"env": {
"IOTHUBCLIENT_API_KEY": "your_iothubclient_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 |
|---|---|---|---|---|
| IOTHUBCLIENT_API_KEY | REQUIRED | Secret Key / Token | None (Set in env) | your_iothubclient_api_key |
Zero-Downtime Token Rotation Protocol
- Generate Secondary Key: Create a new secret API token with identical scopes in your iotHubClient 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.
/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubsGet all the IoT hubs in a subscription.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "azure-com-iothub_get_subscriptions__subscriptionId__providers_Microsoft_Devices_IotHubs",
"arguments": {}
}
}"Use iotHubClient to execute Get all the IoT hubs in a subscription. and output the formatted result."
/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailabilityCheck if an IoT hub name is available.
{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": {
"name": "azure-com-iothub_post_subscriptions__subscriptionId__providers_Microsoft_Devices_checkNameAvailability",
"arguments": {}
}
}"Use iotHubClient to execute Check if an IoT hub name is available. and output the formatted result."
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubsGet all the IoT hubs in a resource group.
{
"jsonrpc": "2.0",
"id": 3,
"method": "tools/call",
"params": {
"name": "azure-com-iothub_get_subscriptions__subscriptionId__resourceGroups__resourceGroupName__providers_Microsoft_Devices_IotHubs",
"arguments": {}
}
}"Use iotHubClient to execute Get all the IoT hubs in a resource group. and output the formatted result."
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}Get the non-security related metadata of an IoT hub.
{
"jsonrpc": "2.0",
"id": 4,
"method": "tools/call",
"params": {
"name": "azure-com-iothub_get_subscriptions__subscriptionId__resourceGroups__resourceGroupName__providers_Microsoft_Devices_IotHubs__resourceName",
"arguments": {}
}
}"Use iotHubClient to execute Get the non-security related metadata of an IoT hub. and output the formatted result."
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}Create or update the metadata of an IoT hub.
{
"jsonrpc": "2.0",
"id": 5,
"method": "tools/call",
"params": {
"name": "azure-com-iothub_put_subscriptions__subscriptionId__resourceGroups__resourceGroupName__providers_Microsoft_Devices_IotHubs__resourceName",
"arguments": {}
}
}"Use iotHubClient to execute Create or update the metadata of an IoT hub. and output the formatted result."
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}Delete an IoT hub.
{
"jsonrpc": "2.0",
"id": 6,
"method": "tools/call",
"params": {
"name": "azure-com-iothub_delete_subscriptions__subscriptionId__resourceGroups__resourceGroupName__providers_Microsoft_Devices_IotHubs__resourceName",
"arguments": {}
}
}"Use iotHubClient to execute Delete an IoT hub. and output the formatted result."
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeysGet a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
{
"jsonrpc": "2.0",
"id": 7,
"method": "tools/call",
"params": {
"name": "azure-com-iothub_post_subscriptions__subscriptionId__resourceGroups__resourceGroupName__providers_Microsoft_Devices_IotHubs__resourceName__IotHubKeys__keyName__listkeys",
"arguments": {}
}
}"Use iotHubClient to execute Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security. and output the formatted result."
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStatsGet the statistics from an IoT hub.
{
"jsonrpc": "2.0",
"id": 8,
"method": "tools/call",
"params": {
"name": "azure-com-iothub_get_subscriptions__subscriptionId__resourceGroups__resourceGroupName__providers_Microsoft_Devices_IotHubs__resourceName__IotHubStats",
"arguments": {}
}
}"Use iotHubClient to execute Get the statistics from an IoT hub. 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 iotHubClient 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 iotHubClient 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 iotHubClient developer dashboard.
If your MCP client fails to initialize tools for iotHubClient: (1) Test the bridge launcher command ("npx -y @modelcontextprotocol/server-openapi https://api.apis.guru/v2/specs/azure.com/iothub/2016-02-03/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/iothub/2016-02-03/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 iotHubClient: (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 iotHubClient 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 Cloud Infrastructure, always invoke the azure-com-iothub 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 iotHubClient 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-iothub.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 Cloud Infrastructure Configurations
Explore related API bridges with ready-to-use Model Context Protocol schemas.
Supabase API
Cloud InfrastructureManage Supabase projects, databases, authentication, and storage through your AI agent.
https://mcpbridge.org/config/supabase.jsonCloudflare API
Cloud InfrastructureManage Cloudflare DNS, CDN, Workers, and security settings through your AI agent.
https://mcpbridge.org/config/cloudflare.jsonVercel API
Cloud InfrastructureDeploy projects, manage domains, and monitor deployments through your AI agent.
https://mcpbridge.org/config/vercel.jsonDigitalOcean API
Cloud InfrastructureThe DigitalOcean API is a comprehensive, RESTful interface provided by DigitalOcean, a leading cloud infrastructure provider focused on simplifying cloud computing for developers, startups, and enterprises. It serves as the programmatic backbone for managing the entire DigitalOcean ecosystem, enabling users to provision, configure, and control cloud resources such as Droplets (virtual private servers), Kubernetes clusters, managed databases, networks, storage volumes, and application platforms. Core capabilities include full lifecycle management of these resources, from creation and scaling to monitoring and deletion, mirroring the functionality available in the DigitalOcean control panel. Its primary use cases range from automating infrastructure setup for CI/CD pipelines and enabling infrastructure-as-code practices to supporting dynamic application scaling and resource optimization for SaaS products, e-commerce sites, and development environments. The API is designed for both developers seeking to automate their cloud operations and businesses that require programmable, scalable cloud infrastructure without the complexity of larger hyperscale providers. When exposed as tools via the Model Context Protocol (MCP) to an AI coding assistant, the DigitalOcean API transforms from a traditional developer tool into a dynamic, context-aware resource for intelligent infrastructure automation. The MCP server acts as a bridge, allowing the AI model to understand and execute API calls based on natural language instructions and the current project context. This integration provides immense value by enabling the AI to perform real-time cloud management tasks directly within the development workflow. For instance, the AI can instantly query account details to verify resources, list and manage SSH keys for secure access, or retrieve and monitor the status of infrastructure actions. This contextual access means the AI can make informed suggestions or take automated actions—like recommending a cost-optimized Droplet size based on current usage patterns or verifying that a new SSH key has been correctly added before proceeding with a deployment script—thereby reducing context-switching and accelerating development cycles. Practical workflow examples demonstrate the power of this MCP integration. A developer could instruct the AI agent with commands like, "Query our account for all active SSH keys and ensure the one named 'ci-bot' is present; if not, create it using this public key," automating a common security and setup step. Another example involves asking the AI to "Check the status of our last ten infrastructure actions to see if any are stuck in a 'pending' state," which would leverage the actions endpoints to provide an immediate operational health check. More complex automations are possible, such as "Based on the current Droplet inventory from the API, generate a Terraform configuration file that replicates this setup," or "Scan our Kubernetes 1-Click apps and suggest one for deploying a new microservice based on the project requirements." These interactions turn the AI into a proactive DevOps partner capable of auditing, reporting, and modifying cloud infrastructure through simple, conversational directives. Critical to the secure operation of this MCP server is rigorous attention to authentication and access control, despite any initial configuration notes indicating "None" for simplicity. In any real-world deployment, authentication via a DigitalOcean Personal Access Token is non-negotiable. This token should be treated as a high-privilege secret. Developers must adhere to the principle of least privilege by creating tokens with the minimum scopes required for the specific tasks—such as read-only access for monitoring or write access only for specific resource types. Best practices include storing tokens in secure environment variables or a secrets manager, never hardcoding them, and ensuring the MCP server configuration does not expose them in logs or client-side code. Furthermore, regular token rotation and monitoring of API activity through DigitalOcean's audit logs are essential to maintain a secure posture when integrating cloud management capabilities directly into AI-assisted development environments.
https://mcpbridge.org/config/digitalocean-com.json