Skip to main content
Glama
alberthild

ShieldAPI MCP

shieldapi.check_domain

Read-onlyIdempotent

Check domain security by analyzing DNS records, blacklist status, SPF/DMARC configurations, and SSL certificates to identify potential threats.

Instructions

Check domain reputation: DNS records, blacklists (Spamhaus, SpamCop, SORBS), SPF/DMARC, SSL.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
domainYesDomain name to check (e.g. example.com)

Implementation Reference

  • The `shieldapi.check_domain` tool is registered dynamically within this loop, utilizing the `callShieldApi` helper function to execute its logic.
    for (const [name, def] of Object.entries(TOOLS)) {
      server.tool(
        name,
        def.description,
        { [def.param]: z.string().describe(def.paramDesc) },
        { ...readOnlyAnnotations, title: TOOL_TITLES[name] || name },
        async (params) => formatResult(await callShieldApi(def.endpoint, params as Record<string, string>))
      );
    }
  • src/index.ts:50-55 (registration)
    Definition of the `shieldapi.check_domain` tool parameters and endpoint.
    'shieldapi.check_domain': {
      description: 'Check domain reputation: DNS records, blacklists (Spamhaus, SpamCop, SORBS), SPF/DMARC, SSL.',
      param: 'domain',
      paramDesc: 'Domain name to check (e.g. example.com)',
      endpoint: 'check-domain',
    },
  • The helper function `callShieldApi` handles the actual HTTP request to the backend for the check-domain tool.
    async function callShieldApi(endpoint: string, params: Record<string, string>): Promise<unknown> {
      const url = new URL(`${SHIELDAPI_URL}/api/${endpoint}`);
      for (const [key, value] of Object.entries(params)) {
        url.searchParams.set(key, value);
      }
      if (demoMode) {
        url.searchParams.set('demo', 'true');
      }
    
      const response = await paymentFetch(url.toString());
      if (!response.ok) {
        const body = await response.text();
        throw new Error(`ShieldAPI ${endpoint} failed (${response.status}): ${body.substring(0, 200)}`);
      }
      return response.json();
    }
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations cover safety profile (readOnly, non-destructive, idempotent). Description adds valuable behavioral context by enumerating exactly what 'reputation' entails (specific blacklist providers, DNS, SSL) that annotations don't capture.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single dense sentence with purpose front-loaded before colon-separated specific checks. No wasted words; every term specifies a distinct reputation vector.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Adequate for a simple read-only tool with 100% schema coverage and rich annotations, but lacks description of return values or output structure despite having no output schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% ('Domain name to check (e.g. example.com)'), providing complete parameter documentation. Description focuses on functionality rather than parameter semantics, adding no additional-guidance beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clear specific verb ('Check') and resource ('domain reputation'), distinguishing from siblings like check_email/check_ip by specifying exact inspection targets: DNS records, specific blacklist providers (Spamhaus, SpamCop, SORBS), SPF/DMARC, and SSL.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implies usage through specificity of checks listed, but provides no explicit when-to-use guidance versus siblings like check_url (full URLs) or full_scan (comprehensive multi-vector scanning), nor mentions prerequisites like valid domain format.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/alberthild/shield-api-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server