@zainahmed.net/sdk

Official TypeScript & JavaScript client SDK and interactive CLI for Zain Ahmed's Architecture API & Model Context Protocol (MCP) Server.

Documentation • Interactive Console • OpenAPI 3.1 Spec • Agent Card • GitHub

Overview

@zainahmed.net/sdk provides first-class programmatic access to Zain Ahmed's public platform, verified cloud blueprints, and agentic discovery protocols.

Designed with zero external runtime dependencies, it runs seamlessly across Node.js, Bun, Deno, Cloudflare Workers, and modern browser environments.

Key Highlights

• ⚡ Zero Runtime Dependencies: Uses standard Web APIs (fetch, Headers, URLSearchParams).
• 🛡️ Complete Type Safety: 100% strict TypeScript types synchronized with the live OpenAPI 3.1.0 schema.
• 🤖 Agentic & Natural Language Engine: Direct integration with the verified /ask NLWeb semantic reasoning endpoint.
• 🔌 Model Context Protocol (MCP): Programmatically export and inspect MCP server configuration for Cursor, Claude Desktop, and Antigravity agents.
• 📦 Dual ESM & CommonJS: Full compatibility with both import and require workflows.
• 💻 Zero-Install CLI: Instant terminal access via npx @zainahmed.net/sdk.

Table of Contents

• Installation
• CLI Quickstart
• SDK Quickstart
  • TypeScript / ESM
  • CommonJS
• API Reference
  • Profile & Credentials
  • Case Studies & Blueprints
  • Technical Articles
  • Engineering Services
  • Natural Language Inquiry (ask)
  • Contact Form & Inquiries
  • Agent & RFC Discovery
• Model Context Protocol (MCP)
• Configuration
• License

Installation

Install using your preferred package manager:

# npm
npm install @zainahmed.net/sdk

# pnpm
pnpm add @zainahmed.net/sdk

# yarn
yarn add @zainahmed.net/sdk

# bun
bun add @zainahmed.net/sdk

CLI Quickstart

Execute commands instantly without installation using npx:

# 1. Inspect live system status and service manifests
npx @zainahmed.net/sdk status

# 2. Query engineer profile and multi-cloud certifications
npx @zainahmed.net/sdk inspect --endpoint=profile

# 3. Filter verified architectural case studies
npx @zainahmed.net/sdk query --category=cloud-architecture

# 4. Ask natural language technical questions
npx @zainahmed.net/sdk ask "What multi-cloud certifications does Zain hold?"

# 5. Output ready-to-use Model Context Protocol (MCP) JSON configuration
npx @zainahmed.net/sdk mcp

CLI Command Reference

| Command | Description | Example | | :--- | :--- | :--- | | status | Ping the API and display active version, endpoints, and manifests | npx @zainahmed.net/sdk status | | inspect | Fetch raw payload for a specific endpoint (profile, projects, articles, services) | npx @zainahmed.net/sdk inspect --endpoint=profile | | query | Filter architectural case studies by category | npx @zainahmed.net/sdk query --category=kubernetes | | ask <query> | Query Zain Ahmed's verified knowledge base in natural language | npx @zainahmed.net/sdk ask "Explain the SummitLMS architecture" | | mcp | Print formatted mcpServers configuration for Cursor & Claude Desktop | npx @zainahmed.net/sdk mcp | | help | Display interactive CLI help menu | npx @zainahmed.net/sdk help |

SDK Quickstart

TypeScript / ESM

import { ZainAhmedClient } from "@zainahmed.net/sdk"

const client = new ZainAhmedClient()

// Fetch verified credentials and certifications
const profile = await client.profile.get()
console.log(`Connected to: ${profile.name} // ${profile.title}`)

// Query verified case studies
const { projects } = await client.projects.list({
  category: "cloud-architecture",
  limit: 5,
})

for (const project of projects) {
  console.log(`- [${project.category}] ${project.title}: ${project.tagline}`)
}

// Ask natural language questions via verified NLWeb reasoning
const queryResult = await client.ask.query("What is Zain's background in FinOps and Kubernetes?")
console.log("Answer:", queryResult.answer)

CommonJS

const { ZainAhmedClient } = require("@zainahmed.net/sdk")

const client = new ZainAhmedClient()

client.profile.get().then((profile) => {
  console.log(profile.name, profile.title)
})

API Reference

Profile & Credentials

Retrieve verified engineer credentials, multi-cloud certifications, and architectural proficiencies:

// Get entire profile
const profile = await client.profile.get()

// Get specific profile section
const credentials = await client.profile.get("credentials")
const bio = await client.profile.get("bio")
const contacts = await client.profile.get("contacts")

Case Studies & Blueprints

Explore verified enterprise architecture case studies with category filtering:

const { projects } = await client.projects.list({
  category: "cloud-architecture", // "devsecops" | "ai-ml" | "finops"
  limit: 10,
})

Technical Articles

Query published technical articles and infrastructure deep dives:

const { articles } = await client.articles.list({
  category: "kubernetes",
  limit: 5,
})

Engineering Services

Retrieve available consulting tiers, architecture advisory packages, and engagement terms:

const services = await client.services.list("advisory")

Natural Language Inquiry (ask)

Ask natural language questions evaluated against verified background, certifications, and project artifacts:

const response = await client.ask.query("What multi-cloud certifications does Zain hold?")

console.log("Summary:", response.answer)
console.log("Sources:", response.sources)

Contact Form & Inquiries

Submit an engineering inquiry or project proposal directly to the platform:

const confirmation = await client.contact.send({
  name: "Sarah Chen",
  email: "[email protected]",
  company: "Apex Cloud Technologies",
  subject: "Multi-Cloud SRE Advisory",
  message: "We would like to discuss platform engineering support for our Kubernetes migration.",
  idempotencyKey: "req_8f192b0a-3d21", // Optional RFC 7231 idempotency key
})

console.log(confirmation.status) // "success"

Agent & RFC Discovery

Fetch machine-readable specifications and discovery files:

// AI Agent Catalog (/.well-known/ai-catalog.json)
const aiCatalog = await client.discovery.getAiCatalog()

// A2A Agent Card (/.well-known/agent-card.json)
const agentCard = await client.discovery.getAgentCard()

// MCP Server Descriptor (/.well-known/mcp/server-card.json)
const mcpCard = await client.discovery.getMcpServerCard()

Model Context Protocol (MCP)

@zainahmed.net/sdk includes built-in support for the Anthropic Model Context Protocol (MCP). Connect coding agents (Claude Desktop, Cursor, Antigravity) to the live API.

Claude Desktop Configuration

Add the following to your claude_desktop_config.json:

{
  "mcpServers": {
    "zainahmed": {
      "url": "https://zainahmed.net/mcp",
      "transport": "streamable-http"
    }
  }
}

Cursor Integration

In .cursor/mcp.json:

{
  "mcpServers": {
    "zainahmed": {
      "url": "https://zainahmed.net/mcp"
    }
  }
}

Claude Code CLI

claude mcp add zainahmed https://zainahmed.net/mcp

Configuration

Customize the client instance with options:

import { ZainAhmedClient } from "@zainahmed.net/sdk"

const client = new ZainAhmedClient({
  // Custom base URL (defaults to https://zainahmed.net)
  baseUrl: "https://zainahmed.net",

  // Optional Bearer token for authenticated routes
  apiKey: process.env.ZAINAHMED_API_KEY,

  // Custom fetch implementation (useful for mocks, caching, or custom proxies)
  fetch: globalThis.fetch,
})

RFC Standards & Compliance

@zainahmed.net/sdk is built to interact with an API adhering to strict RFC standards:

• RFC 9727: API Catalog (/.well-known/api-catalog)
• RFC 9728: OAuth Protected Resource (/.well-known/oauth-protected-resource)
• RFC 8414: OAuth 2.0 Authorization Server Metadata (/.well-known/oauth-authorization-server)
• RFC 9421: HTTP Message Signatures (/.well-known/http-message-signatures-directory)
• RFC 6585: Additional HTTP Status Codes (429 Too Many Requests)

License

MIT © Zain Ahmed ([email protected])