domain-search-mcp 1.2.5 → 1.2.6

package/README.md

@@ -247,6 +247,78 @@ for (const domain of result.results) {
 
 Check up to 100 domains at once with built-in rate limiting and progress tracking.
 
+---
+
+#### Quick Start: Initialize and Run bulk_search
+
+```typescript
+// Initialize bulk_search for checking 50 domains
+import { bulkSearch } from 'domain-search-mcp';
+
+// Step 1: Prepare your domain list (max 100)
+const domainsToCheck = [
+  "techflow", "datawise", "cloudpeak", "aiforge", "bytecraft",
+  "codestream", "devpulse", "syncwave", "logiclab", "pixelcraft"
+  // ... up to 100 domains
+];
+
+// Step 2: Initialize and call bulk_search
+async function initBulkSearch(domains: string[], tld: string = "com") {
+  console.log(`Initializing bulk_search for ${domains.length} domains...`);
+
+  const result = await bulkSearch({
+    domains: domains,       // Array of domain names (without TLD)
+    tld: tld,               // Single TLD to check (e.g., "com", "io")
+    concurrency: 10         // Optional: parallel requests (1-20)
+  });
+
+  // Process results
+  console.log(`✅ Checked ${result.summary.total} domains in ${result.summary.duration_ms}ms`);
+  console.log(`   Available: ${result.summary.available}`);
+  console.log(`   Taken: ${result.summary.taken}`);
+  console.log(`   Errors: ${result.summary.errors}`);
+
+  return result;
+}
+
+// Step 3: Run the bulk search
+const results = await initBulkSearch(domainsToCheck, "io");
+
+// Access available domains
+const availableDomains = results.results.filter(r => r.available);
+availableDomains.forEach(d => {
+  console.log(`${d.domain} - $${d.price_first_year}/yr`);
+});
+```
+
+**JavaScript Quick Start:**
+
+```javascript
+// Initialize bulk_search with fetch API
+async function initBulkSearch(domains, tld = 'com') {
+  const response = await fetch('http://localhost:3000/bulk_search', {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify({
+      domains: domains,
+      tld: tld,
+      concurrency: 10
+    })
+  });
+
+  const result = await response.json();
+  console.log(`Checked ${result.summary.total} domains`);
+  console.log(`Available: ${result.summary.available}`);
+  return result;
+}
+
+// Usage
+const domains = ['startup1', 'startup2', 'startup3'];
+const result = await initBulkSearch(domains, 'io');
+```
+
+---
+
 **API Endpoint:** `POST /bulk_search`
 
 **Request Parameters:**
@@ -1327,7 +1399,152 @@ console.log(`Price range: $${tldData.price_range.min} - $${tldData.price_range.m
 
 ### check_socials
 
-Verify username availability across 10 platforms:
+Verify username availability across 10 platforms simultaneously.
+
+**API Endpoint:** `POST /check_socials`
+
+**Request Parameters:**
+
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `name` | string | Yes | - | Username to check |
+| `platforms` | string[] | No | ["github", "twitter", "reddit", "npm"] | Platforms to check |
+
+**Supported Platforms:**
+
+| Platform | ID | Confidence | Detection Method |
+|----------|-----|------------|------------------|
+| GitHub | `github` | High | Public API |
+| Twitter/X | `twitter` | High | oembed API |
+| npm | `npm` | High | Registry API |
+| PyPI | `pypi` | High | Package API |
+| Reddit | `reddit` | High | Profile check |
+| YouTube | `youtube` | Medium | Channel page |
+| ProductHunt | `producthunt` | Medium | Profile page |
+| Instagram | `instagram` | Low | Blocks automation |
+| LinkedIn | `linkedin` | Low | Blocks automation |
+| TikTok | `tiktok` | Low | Blocks automation |
+
+**Response Type:**
+
+```typescript
+interface CheckSocialsResponse {
+  name: string;                    // Username checked
+  results: Array<{
+    platform: string;              // Platform ID (github, twitter, etc.)
+    available: boolean;            // Whether username is available
+    confidence: "high" | "medium" | "low";
+    url: string;                   // Direct URL to profile/claim page
+    error?: string;                // Error message if check failed
+    errorCode?: string;            // RATE_LIMIT, TIMEOUT, BLOCKED, etc.
+    responseTime?: number;         // Check duration in ms
+  }>;
+  insights: string[];              // Human-readable summary
+  summary: {
+    available: number;             // Count of available platforms
+    taken: number;                 // Count of taken platforms
+    unknown: number;               // Count of low-confidence/error platforms
+  };
+}
+```
+
+---
+
+#### Quick Start: Check GitHub, Twitter, and Instagram
+
+This is the most common use case - verify username on the three main platforms:
+
+```typescript
+// Quick Start: Check 'myproject' on GitHub, Twitter, and Instagram simultaneously
+
+import { checkSocials } from 'domain-search-mcp';
+
+async function checkUsernameOnMainPlatforms(username: string) {
+  // Call check_socials with the three platforms
+  const result = await checkSocials({
+    name: username,
+    platforms: ["github", "twitter", "instagram"]
+  });
+
+  // Process results
+  console.log(`\nChecking "${username}" on GitHub, Twitter, Instagram:\n`);
+
+  for (const platform of result.results) {
+    const status = platform.available ? "✅ Available" : "❌ Taken";
+    const confidence = platform.confidence === "low" ? " (verify manually)" : "";
+    console.log(`  ${platform.platform.padEnd(12)} ${status}${confidence}`);
+    console.log(`  └─ ${platform.url}`);
+  }
+
+  // Summary
+  const available = result.results.filter(r => r.available && r.confidence !== "low");
+  const taken = result.results.filter(r => !r.available);
+  const manual = result.results.filter(r => r.confidence === "low");
+
+  console.log(`\nSummary: ${available.length} available, ${taken.length} taken, ${manual.length} need manual check`);
+
+  return {
+    available: available.map(r => ({ platform: r.platform, url: r.url })),
+    taken: taken.map(r => r.platform),
+    verifyManually: manual.map(r => ({ platform: r.platform, url: r.url }))
+  };
+}
+
+// Usage
+const result = await checkUsernameOnMainPlatforms("myproject");
+
+// Output:
+// Checking "myproject" on GitHub, Twitter, Instagram:
+//
+//   github       ✅ Available
+//   └─ https://github.com/myproject
+//   twitter      ❌ Taken
+//   └─ https://twitter.com/myproject
+//   instagram    ✅ Available (verify manually)
+//   └─ https://instagram.com/myproject
+//
+// Summary: 1 available, 1 taken, 1 need manual check
+```
+
+**JavaScript Quick Start:**
+
+```javascript
+// Check GitHub, Twitter, Instagram for a project name
+async function checkProjectSocials(projectName) {
+  const response = await fetch('http://localhost:3000/check_socials', {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify({
+      name: projectName,
+      platforms: ['github', 'twitter', 'instagram']
+    })
+  });
+
+  const data = await response.json();
+
+  // Display results
+  console.log(`Social media check for "${projectName}":`);
+  data.results.forEach(r => {
+    const icon = r.available ? '✅' : '❌';
+    const note = r.confidence === 'low' ? ' (verify manually)' : '';
+    console.log(`  ${icon} ${r.platform}: ${r.available ? 'Available' : 'Taken'}${note}`);
+  });
+
+  return data;
+}
+
+// Example
+const socials = await checkProjectSocials('myproject');
+// Output:
+// Social media check for "myproject":
+//   ✅ github: Available
+//   ❌ twitter: Taken
+//   ✅ instagram: Available (verify manually)
+```
+
+---
+
+**Basic Example:**
 
 ```typescript
 // Input
@@ -1340,15 +1557,31 @@ Verify username availability across 10 platforms:
 {
   "name": "vibecoding",
   "results": [
-    { "platform": "github", "available": true, "confidence": "high" },
-    { "platform": "twitter", "available": false, "confidence": "high" },
-    { "platform": "instagram", "available": true, "confidence": "low" }
+    {
+      "platform": "github",
+      "available": true,
+      "confidence": "high",
+      "url": "https://github.com/vibecoding"
+    },
+    {
+      "platform": "twitter",
+      "available": false,
+      "confidence": "high",
+      "url": "https://twitter.com/vibecoding"
+    },
+    {
+      "platform": "instagram",
+      "available": true,
+      "confidence": "low",
+      "url": "https://instagram.com/vibecoding"
+    }
   ],
   "insights": [
     "✅ vibecoding is available on: github",
     "❌ vibecoding is taken on: twitter",
     "⚠️ Could not reliably check: instagram (check manually)"
-  ]
+  ],
+  "summary": { "available": 2, "taken": 1, "unknown": 0 }
 }
 ```
 
@@ -2086,6 +2319,215 @@ Add to `.cursor/mcp.json`:
 
 Add to your Cline settings to enable MCP servers.
 
+### MCP Tool Invocation Patterns
+
+When using Domain Search MCP through an MCP-compatible client (Claude Desktop, Cursor, etc.), tools are invoked using the standard MCP tool call pattern:
+
+#### Basic MCP Tool Call Structure
+
+```typescript
+// MCP tool invocation pattern (as handled by the MCP client)
+// The client sends a tool_call request to the MCP server:
+
+// Tool: search_domain
+{
+  "tool": "search_domain",
+  "arguments": {
+    "domain_name": "vibecoding",
+    "tlds": ["com", "io", "dev"]
+  }
+}
+
+// Tool: check_socials
+{
+  "tool": "check_socials",
+  "arguments": {
+    "name": "myproject",
+    "platforms": ["github", "twitter", "instagram"]
+  }
+}
+
+// Tool: suggest_domains
+{
+  "tool": "suggest_domains",
+  "arguments": {
+    "base_name": "techapp",
+    "tld": "com",
+    "max_suggestions": 10,
+    "variants": ["prefixes", "suffixes", "hyphen"]
+  }
+}
+```
+
+#### MCP Tool Invocation via Claude Desktop
+
+When using Claude Desktop, simply describe what you want in natural language:
+
+```
+User: "Check if 'myproject' is available as a domain and on GitHub"
+
+Claude invokes MCP tools:
+1. search_domain({ domain_name: "myproject", tlds: ["com", "io", "dev"] })
+2. check_socials({ name: "myproject", platforms: ["github"] })
+
+Response: Shows domain availability with pricing and GitHub username status
+```
+
+#### Quick Reference: All MCP Tool Names
+
+| MCP Tool Name | Purpose | Primary Arguments |
+|---------------|---------|-------------------|
+| `search_domain` | Check availability + pricing | `domain_name`, `tlds[]` |
+| `bulk_search` | Check up to 100 domains | `domains[]`, `tld` |
+| `compare_registrars` | Compare prices | `domain`, `tld` |
+| `suggest_domains` | Get variations when taken | `base_name`, `tld`, `variants[]` |
+| `suggest_domains_smart` | AI-powered suggestions | `query`, `tld`, `style` |
+| `tld_info` | TLD details + restrictions | `tld`, `detailed` |
+| `check_socials` | Social username check | `name`, `platforms[]` |
+
+#### Programmatic MCP Tool Invocation (via MCP SDK)
+
+```typescript
+import { Client } from "@modelcontextprotocol/sdk/client/index.js";
+
+// Initialize MCP client
+const client = new Client({
+  name: "domain-search-client",
+  version: "1.0.0"
+});
+
+// Connect to the domain-search-mcp server
+await client.connect(transport);
+
+// Invoke MCP tools programmatically
+const domainResult = await client.callTool({
+  name: "search_domain",
+  arguments: {
+    domain_name: "myproject",
+    tlds: ["com", "io"]
+  }
+});
+
+const socialResult = await client.callTool({
+  name: "check_socials",
+  arguments: {
+    name: "myproject",
+    platforms: ["github", "twitter", "instagram"]
+  }
+});
+
+console.log("Domain results:", domainResult);
+console.log("Social results:", socialResult);
+```
+
+### Running as Local HTTP Server
+
+Domain Search MCP can also run as a standalone HTTP server for direct API access:
+
+#### Quick Start: Local Server Setup
+
+```bash
+# Step 1: Clone and install
+git clone https://github.com/dorukardahan/domain-search-mcp.git
+cd domain-search-mcp
+npm install
+
+# Step 2: Build the server
+npm run build
+
+# Step 3: Start the HTTP server
+npm start
+
+# Server runs at http://localhost:3000
+```
+
+#### Local Server Configuration
+
+```bash
+# Optional: Configure environment before starting
+cp .env.example .env
+
+# Edit .env to add API keys (optional but recommended)
+# PORKBUN_API_KEY=pk1_...
+# PORKBUN_SECRET_KEY=sk1_...
+
+# Set custom port (default: 3000)
+export PORT=3001
+
+# Start server
+npm start
+```
+
+#### Making API Requests to Local Server
+
+Once the server is running, you can make HTTP requests:
+
+```bash
+# Check domain availability
+curl -X POST http://localhost:3000/search_domain \
+  -H "Content-Type: application/json" \
+  -d '{"domain_name": "myproject", "tlds": ["com", "io"]}'
+
+# Check social media usernames
+curl -X POST http://localhost:3000/check_socials \
+  -H "Content-Type: application/json" \
+  -d '{"name": "myproject", "platforms": ["github", "twitter"]}'
+
+# Bulk search 50 domains
+curl -X POST http://localhost:3000/bulk_search \
+  -H "Content-Type: application/json" \
+  -d '{"domains": ["name1", "name2", "name3"], "tld": "com"}'
+```
+
+#### JavaScript/Node.js Local Server Integration
+
+```javascript
+// Complete local server integration example
+
+const BASE_URL = 'http://localhost:3000';
+
+// Initialize connection to local domain-search server
+async function initializeDomainSearch() {
+  try {
+    // Test server connection
+    const response = await fetch(`${BASE_URL}/search_domain`, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({
+        domain_name: 'test-connection',
+        tlds: ['com']
+      })
+    });
+
+    if (response.ok) {
+      console.log('✅ Domain Search server connected');
+      return true;
+    }
+    throw new Error('Server not responding');
+  } catch (error) {
+    console.error('❌ Failed to connect to server:', error.message);
+    console.error('Make sure to run: npm start');
+    return false;
+  }
+}
+
+// Usage
+const connected = await initializeDomainSearch();
+if (connected) {
+  // Proceed with domain searches
+  const result = await fetch(`${BASE_URL}/search_domain`, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify({
+      domain_name: 'vibecoding',
+      tlds: ['com', 'io', 'dev']
+    })
+  }).then(r => r.json());
+
+  console.log(`Found ${result.results.filter(r => r.available).length} available domains`);
+}
+```
+
 ## Development
 
 ### Setup

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "domain-search-mcp",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "Fast domain availability aggregator MCP server. Check availability across Porkbun, Namecheap, RDAP, and WHOIS. Compare pricing. Get suggestions.",
   "main": "dist/server.js",
   "types": "dist/server.d.ts",