hive-skills 0.1.0

package/assets/skills/converted/mcp-builder/composable/mini/13-node-implementation.md

@@ -0,0 +1,717 @@
+# Node/TypeScript — Implementation Patterns
+
+Node/TypeScript-specific best practices and code for implementing MCP servers with the MCP TypeScript SDK: project structure, server setup, tool registration, input validation with Zod, error handling, and a complete working example. Server naming (`{service}-mcp-server`) and tool naming are in the naming mini; this mini is the how-in-TypeScript.
+
+## MCP TypeScript SDK
+
+The official MCP TypeScript SDK provides:
+- `McpServer` class for server initialization
+- `registerTool` method for tool registration
+- Zod schema integration for runtime input validation
+- Type-safe tool handler implementations
+
+**IMPORTANT — Use Modern APIs Only:**
+- **DO use:** `server.registerTool()`, `server.registerResource()`, `server.registerPrompt()`
+- **DO NOT use:** old deprecated APIs such as `server.tool()`, `server.setRequestHandler(ListToolsRequestSchema, ...)`, or manual handler registration.
+- The `register*` methods provide better type safety, automatic schema handling, and are the recommended approach.
+
+For complete SDK details use WebFetch: `https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md`
+
+## Quick Reference
+
+### Key imports
+```typescript
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import express from "express";
+import { z } from "zod";
+```
+
+### Server initialization
+```typescript
+const server = new McpServer({
+  name: "service-mcp-server",
+  version: "1.0.0"
+});
+```
+
+### Tool registration pattern
+```typescript
+server.registerTool(
+  "tool_name",
+  {
+    title: "Tool Display Name",
+    description: "What the tool does",
+    inputSchema: { param: z.string() },
+    outputSchema: { result: z.string() }
+  },
+  async ({ param }) => {
+    const output = { result: `Processed: ${param}` };
+    return {
+      content: [{ type: "text", text: JSON.stringify(output) }],
+      structuredContent: output // Modern pattern for structured data
+    };
+  }
+);
+```
+
+## Project Structure
+
+```
+{service}-mcp-server/
+├── package.json
+├── tsconfig.json
+├── README.md
+├── src/
+│   ├── index.ts          # Main entry point with McpServer initialization
+│   ├── types.ts          # TypeScript type definitions and interfaces
+│   ├── tools/            # Tool implementations (one file per domain)
+│   ├── services/         # API clients and shared utilities
+│   ├── schemas/          # Zod validation schemas
+│   └── constants.ts      # Shared constants (API_URL, CHARACTER_LIMIT, etc.)
+└── dist/                 # Built JavaScript files (entry point: dist/index.js)
+```
+
+## Tool Structure
+
+Use snake_case, action-oriented tool names with a service prefix (e.g., `slack_send_message`, `github_create_issue`, `asana_list_tasks`). Tools are registered using `registerTool`:
+- Use Zod schemas for runtime input validation and type safety.
+- The `description` field must be explicitly provided — JSDoc comments are NOT automatically extracted.
+- Explicitly provide `title`, `description`, `inputSchema`, and `annotations`.
+- The `inputSchema` must be a Zod schema object (not a JSON schema).
+- Type all parameters and return values explicitly.
+
+```typescript
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { z } from "zod";
+
+const server = new McpServer({
+  name: "example-mcp",
+  version: "1.0.0"
+});
+
+// Zod schema for input validation
+const UserSearchInputSchema = z.object({
+  query: z.string()
+    .min(2, "Query must be at least 2 characters")
+    .max(200, "Query must not exceed 200 characters")
+    .describe("Search string to match against names/emails"),
+  limit: z.number()
+    .int()
+    .min(1)
+    .max(100)
+    .default(20)
+    .describe("Maximum results to return"),
+  offset: z.number()
+    .int()
+    .min(0)
+    .default(0)
+    .describe("Number of results to skip for pagination"),
+  response_format: z.nativeEnum(ResponseFormat)
+    .default(ResponseFormat.MARKDOWN)
+    .describe("Output format: 'markdown' for human-readable or 'json' for machine-readable")
+}).strict();
+
+// Type definition from Zod schema
+type UserSearchInput = z.infer<typeof UserSearchInputSchema>;
+
+server.registerTool(
+  "example_search_users",
+  {
+    title: "Search Example Users",
+    description: `Search for users in the Example system by name, email, or team.
+
+This tool searches across all user profiles in the Example platform, supporting partial matches and various search filters. It does NOT create or modify users, only searches existing ones.
+
+Args:
+  - query (string): Search string to match against names/emails
+  - limit (number): Maximum results to return, between 1-100 (default: 20)
+  - offset (number): Number of results to skip for pagination (default: 0)
+  - response_format ('markdown' | 'json'): Output format (default: 'markdown')
+
+Returns:
+  For JSON format: Structured data with schema:
+  {
+    "total": number,           // Total number of matches found
+    "count": number,           // Number of results in this response
+    "offset": number,          // Current pagination offset
+    "users": [
+      {
+        "id": string,          // User ID (e.g., "U123456789")
+        "name": string,        // Full name (e.g., "John Doe")
+        "email": string,       // Email address
+        "team": string,        // Team name (optional)
+        "active": boolean      // Whether user is active
+      }
+    ],
+    "has_more": boolean,       // Whether more results are available
+    "next_offset": number      // Offset for next page (if has_more is true)
+  }
+
+Examples:
+  - Use when: "Find all marketing team members" -> params with query="team:marketing"
+  - Use when: "Search for John's account" -> params with query="john"
+  - Don't use when: You need to create a user (use example_create_user instead)
+
+Error Handling:
+  - Returns "Error: Rate limit exceeded" if too many requests (429 status)
+  - Returns "No users found matching '<query>'" if search returns empty`,
+    inputSchema: UserSearchInputSchema,
+    annotations: {
+      readOnlyHint: true,
+      destructiveHint: false,
+      idempotentHint: true,
+      openWorldHint: true
+    }
+  },
+  async (params: UserSearchInput) => {
+    try {
+      // Input validation is handled by Zod schema
+      // Make API request using validated parameters
+      const data = await makeApiRequest<any>(
+        "users/search",
+        "GET",
+        undefined,
+        {
+          q: params.query,
+          limit: params.limit,
+          offset: params.offset
+        }
+      );
+
+      const users = data.users || [];
+      const total = data.total || 0;
+
+      if (!users.length) {
+        return {
+          content: [{
+            type: "text",
+            text: `No users found matching '${params.query}'`
+          }]
+        };
+      }
+
+      // Prepare structured output
+      const output = {
+        total,
+        count: users.length,
+        offset: params.offset,
+        users: users.map((user: any) => ({
+          id: user.id,
+          name: user.name,
+          email: user.email,
+          ...(user.team ? { team: user.team } : {}),
+          active: user.active ?? true
+        })),
+        has_more: total > params.offset + users.length,
+        ...(total > params.offset + users.length ? {
+          next_offset: params.offset + users.length
+        } : {})
+      };
+
+      // Format text representation based on requested format
+      let textContent: string;
+      if (params.response_format === ResponseFormat.MARKDOWN) {
+        const lines = [`# User Search Results: '${params.query}'`, "",
+          `Found ${total} users (showing ${users.length})`, ""];
+        for (const user of users) {
+          lines.push(`## ${user.name} (${user.id})`);
+          lines.push(`- **Email**: ${user.email}`);
+          if (user.team) lines.push(`- **Team**: ${user.team}`);
+          lines.push("");
+        }
+        textContent = lines.join("\n");
+      } else {
+        textContent = JSON.stringify(output, null, 2);
+      }
+
+      return {
+        content: [{ type: "text", text: textContent }],
+        structuredContent: output // Modern pattern for structured data
+      };
+    } catch (error) {
+      return {
+        content: [{
+          type: "text",
+          text: handleApiError(error)
+        }]
+      };
+    }
+  }
+);
+```
+
+## Zod Schemas for Input Validation
+
+Zod provides runtime type validation:
+
+```typescript
+import { z } from "zod";
+
+// Basic schema with validation
+const CreateUserSchema = z.object({
+  name: z.string()
+    .min(1, "Name is required")
+    .max(100, "Name must not exceed 100 characters"),
+  email: z.string()
+    .email("Invalid email format"),
+  age: z.number()
+    .int("Age must be a whole number")
+    .min(0, "Age cannot be negative")
+    .max(150, "Age cannot be greater than 150")
+}).strict();  // Use .strict() to forbid extra fields
+
+// Enums
+enum ResponseFormat {
+  MARKDOWN = "markdown",
+  JSON = "json"
+}
+
+const SearchSchema = z.object({
+  response_format: z.nativeEnum(ResponseFormat)
+    .default(ResponseFormat.MARKDOWN)
+    .describe("Output format")
+});
+
+// Optional fields with defaults
+const PaginationSchema = z.object({
+  limit: z.number()
+    .int()
+    .min(1)
+    .max(100)
+    .default(20)
+    .describe("Maximum results to return"),
+  offset: z.number()
+    .int()
+    .min(0)
+    .default(0)
+    .describe("Number of results to skip")
+});
+```
+
+## Response Format Options
+
+Support multiple output formats for flexibility (concept in the response-formats mini):
+
+```typescript
+enum ResponseFormat {
+  MARKDOWN = "markdown",
+  JSON = "json"
+}
+
+const inputSchema = z.object({
+  query: z.string(),
+  response_format: z.nativeEnum(ResponseFormat)
+    .default(ResponseFormat.MARKDOWN)
+    .describe("Output format: 'markdown' for human-readable or 'json' for machine-readable")
+});
+```
+
+**Markdown format:** use headers, lists, and formatting for clarity; convert timestamps to human-readable format; show display names with IDs in parentheses; omit verbose metadata; group related information logically.
+
+**JSON format:** return complete, structured data suitable for programmatic processing; include all available fields and metadata; use consistent field names and types.
+
+## Pagination Implementation
+
+```typescript
+const ListSchema = z.object({
+  limit: z.number().int().min(1).max(100).default(20),
+  offset: z.number().int().min(0).default(0)
+});
+
+async function listItems(params: z.infer<typeof ListSchema>) {
+  const data = await apiRequest(params.limit, params.offset);
+
+  const response = {
+    total: data.total,
+    count: data.items.length,
+    offset: params.offset,
+    items: data.items,
+    has_more: data.total > params.offset + data.items.length,
+    next_offset: data.total > params.offset + data.items.length
+      ? params.offset + data.items.length
+      : undefined
+  };
+
+  return JSON.stringify(response, null, 2);
+}
+```
+
+## Character Limits and Truncation
+
+Add a CHARACTER_LIMIT constant to prevent overwhelming responses:
+
+```typescript
+// At module level in constants.ts
+export const CHARACTER_LIMIT = 25000;  // Maximum response size in characters
+
+async function searchTool(params: SearchInput) {
+  let result = generateResponse(data);
+
+  // Check character limit and truncate if needed
+  if (result.length > CHARACTER_LIMIT) {
+    const truncatedData = data.slice(0, Math.max(1, data.length / 2));
+    response.data = truncatedData;
+    response.truncated = true;
+    response.truncation_message =
+      `Response truncated from ${data.length} to ${truncatedData.length} items. ` +
+      `Use 'offset' parameter or add filters to see more results.`;
+    result = JSON.stringify(response, null, 2);
+  }
+
+  return result;
+}
+```
+
+## Error Handling
+
+Provide clear, actionable error messages:
+
+```typescript
+import axios, { AxiosError } from "axios";
+
+function handleApiError(error: unknown): string {
+  if (error instanceof AxiosError) {
+    if (error.response) {
+      switch (error.response.status) {
+        case 404:
+          return "Error: Resource not found. Please check the ID is correct.";
+        case 403:
+          return "Error: Permission denied. You don't have access to this resource.";
+        case 429:
+          return "Error: Rate limit exceeded. Please wait before making more requests.";
+        default:
+          return `Error: API request failed with status ${error.response.status}`;
+      }
+    } else if (error.code === "ECONNABORTED") {
+      return "Error: Request timed out. Please try again.";
+    }
+  }
+  return `Error: Unexpected error occurred: ${error instanceof Error ? error.message : String(error)}`;
+}
+```
+
+## Shared Utilities
+
+Extract common functionality into reusable functions:
+
+```typescript
+// Shared API request function
+async function makeApiRequest<T>(
+  endpoint: string,
+  method: "GET" | "POST" | "PUT" | "DELETE" = "GET",
+  data?: any,
+  params?: any
+): Promise<T> {
+  try {
+    const response = await axios({
+      method,
+      url: `${API_BASE_URL}/${endpoint}`,
+      data,
+      params,
+      timeout: 30000,
+      headers: {
+        "Content-Type": "application/json",
+        "Accept": "application/json"
+      }
+    });
+    return response.data;
+  } catch (error) {
+    throw error;
+  }
+}
+```
+
+## Async/Await Best Practices
+
+Always use async/await for network requests and I/O operations:
+
+```typescript
+// Good: Async network request
+async function fetchData(resourceId: string): Promise<ResourceData> {
+  const response = await axios.get(`${API_URL}/resource/${resourceId}`);
+  return response.data;
+}
+
+// Bad: Promise chains
+function fetchData(resourceId: string): Promise<ResourceData> {
+  return axios.get(`${API_URL}/resource/${resourceId}`)
+    .then(response => response.data);  // Harder to read and maintain
+}
+```
+
+## TypeScript Best Practices
+
+1. **Use Strict TypeScript:** enable strict mode in tsconfig.json.
+2. **Define Interfaces:** create clear interface definitions for all data structures.
+3. **Avoid `any`:** use proper types or `unknown` instead of `any`.
+4. **Zod for Runtime Validation:** use Zod schemas to validate external data.
+5. **Type Guards:** create type guard functions for complex type checking.
+6. **Error Handling:** always use try-catch with proper error type checking.
+7. **Null Safety:** use optional chaining (`?.`) and nullish coalescing (`??`).
+
+```typescript
+// Good: Type-safe with Zod and interfaces
+interface UserResponse {
+  id: string;
+  name: string;
+  email: string;
+  team?: string;
+  active: boolean;
+}
+
+const UserSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  email: z.string().email(),
+  team: z.string().optional(),
+  active: z.boolean()
+});
+
+type User = z.infer<typeof UserSchema>;
+
+async function getUser(id: string): Promise<User> {
+  const data = await apiCall(`/users/${id}`);
+  return UserSchema.parse(data);  // Runtime validation
+}
+
+// Bad: Using any
+async function getUser(id: string): Promise<any> {
+  return await apiCall(`/users/${id}`);  // No type safety
+}
+```
+
+## Package Configuration
+
+### package.json
+
+```json
+{
+  "name": "{service}-mcp-server",
+  "version": "1.0.0",
+  "description": "MCP server for {Service} API integration",
+  "type": "module",
+  "main": "dist/index.js",
+  "scripts": {
+    "start": "node dist/index.js",
+    "dev": "tsx watch src/index.ts",
+    "build": "tsc",
+    "clean": "rm -rf dist"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.6.1",
+    "axios": "^1.7.9",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2"
+  }
+}
+```
+
+### tsconfig.json
+
+```json
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "Node16",
+    "moduleResolution": "Node16",
+    "lib": ["ES2022"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}
+```
+
+## Complete Example
+
+```typescript
+#!/usr/bin/env node
+/**
+ * MCP Server for Example Service.
+ *
+ * This server provides tools to interact with Example API, including user search,
+ * project management, and data export capabilities.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { z } from "zod";
+import axios, { AxiosError } from "axios";
+
+// Constants
+const API_BASE_URL = "https://api.example.com/v1";
+const CHARACTER_LIMIT = 25000;
+
+// Enums
+enum ResponseFormat {
+  MARKDOWN = "markdown",
+  JSON = "json"
+}
+
+// Zod schemas
+const UserSearchInputSchema = z.object({
+  query: z.string()
+    .min(2, "Query must be at least 2 characters")
+    .max(200, "Query must not exceed 200 characters")
+    .describe("Search string to match against names/emails"),
+  limit: z.number()
+    .int()
+    .min(1)
+    .max(100)
+    .default(20)
+    .describe("Maximum results to return"),
+  offset: z.number()
+    .int()
+    .min(0)
+    .default(0)
+    .describe("Number of results to skip for pagination"),
+  response_format: z.nativeEnum(ResponseFormat)
+    .default(ResponseFormat.MARKDOWN)
+    .describe("Output format: 'markdown' for human-readable or 'json' for machine-readable")
+}).strict();
+
+type UserSearchInput = z.infer<typeof UserSearchInputSchema>;
+
+// Shared utility functions
+async function makeApiRequest<T>(
+  endpoint: string,
+  method: "GET" | "POST" | "PUT" | "DELETE" = "GET",
+  data?: any,
+  params?: any
+): Promise<T> {
+  try {
+    const response = await axios({
+      method,
+      url: `${API_BASE_URL}/${endpoint}`,
+      data,
+      params,
+      timeout: 30000,
+      headers: {
+        "Content-Type": "application/json",
+        "Accept": "application/json"
+      }
+    });
+    return response.data;
+  } catch (error) {
+    throw error;
+  }
+}
+
+function handleApiError(error: unknown): string {
+  if (error instanceof AxiosError) {
+    if (error.response) {
+      switch (error.response.status) {
+        case 404:
+          return "Error: Resource not found. Please check the ID is correct.";
+        case 403:
+          return "Error: Permission denied. You don't have access to this resource.";
+        case 429:
+          return "Error: Rate limit exceeded. Please wait before making more requests.";
+        default:
+          return `Error: API request failed with status ${error.response.status}`;
+      }
+    } else if (error.code === "ECONNABORTED") {
+      return "Error: Request timed out. Please try again.";
+    }
+  }
+  return `Error: Unexpected error occurred: ${error instanceof Error ? error.message : String(error)}`;
+}
+
+// Create MCP server instance
+const server = new McpServer({
+  name: "example-mcp",
+  version: "1.0.0"
+});
+
+// Register tools
+server.registerTool(
+  "example_search_users",
+  {
+    title: "Search Example Users",
+    description: `[Full description as shown above]`,
+    inputSchema: UserSearchInputSchema,
+    annotations: {
+      readOnlyHint: true,
+      destructiveHint: false,
+      idempotentHint: true,
+      openWorldHint: true
+    }
+  },
+  async (params: UserSearchInput) => {
+    // Implementation as shown above
+  }
+);
+
+// Main function
+// For stdio (local):
+async function runStdio() {
+  if (!process.env.EXAMPLE_API_KEY) {
+    console.error("ERROR: EXAMPLE_API_KEY environment variable is required");
+    process.exit(1);
+  }
+
+  const transport = new StdioServerTransport();
+  await server.connect(transport);
+  console.error("MCP server running via stdio");
+}
+
+// For streamable HTTP (remote):
+async function runHTTP() {
+  if (!process.env.EXAMPLE_API_KEY) {
+    console.error("ERROR: EXAMPLE_API_KEY environment variable is required");
+    process.exit(1);
+  }
+
+  const app = express();
+  app.use(express.json());
+
+  app.post('/mcp', async (req, res) => {
+    const transport = new StreamableHTTPServerTransport({
+      sessionIdGenerator: undefined,
+      enableJsonResponse: true
+    });
+    res.on('close', () => transport.close());
+    await server.connect(transport);
+    await transport.handleRequest(req, res, req.body);
+  });
+
+  const port = parseInt(process.env.PORT || '3000');
+  app.listen(port, () => {
+    console.error(`MCP server running on http://localhost:${port}/mcp`);
+  });
+}
+
+// Choose transport based on environment
+const transport = process.env.TRANSPORT || 'stdio';
+if (transport === 'http') {
+  runHTTP().catch(error => {
+    console.error("Server error:", error);
+    process.exit(1);
+  });
+} else {
+  runStdio().catch(error => {
+    console.error("Server error:", error);
+    process.exit(1);
+  });
+}
+```
+
+Advanced MCP features (resources, transport, notifications), build/run commands, and the quality checklist are in `14-node-advanced-and-checklist.md`.