Skip to main content
Glama
davinoishi

Broken Link Checker MCP Server

by davinoishi

Broken Link Checker MCP Server

An MCP (Model Context Protocol) server that provides broken link checking capabilities using the broken-link-checker library.

Features

  • Check Single Page Links: Scan all links on a single HTML page for broken links

  • Check Entire Site: Recursively crawl and check all links across an entire website

  • Detailed reporting including HTTP status codes, broken reasons, and link metadata

  • Support for excluding external links and respecting robots.txt

  • Two deployment modes: Local stdio or Remote HTTP/SSE

Related MCP server: siteone-mcp-server

Installation

npm install

Deployment Options

Option 1: Local Usage (stdio transport)

Use index.js for local Claude Desktop integration.

Option 2: Remote Usage (HTTP/SSE transport)

Use server.js for remote deployment with ngrok or similar proxy services.

Usage with Claude Desktop (Local)

Step 1: Configure Claude Desktop

Add this server to your Claude Desktop configuration file:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "broken-link-checker": {
      "command": "node",
      "args": ["/Users/davinoishi/Documents/Projects-AI/BLC/index.js"]
    }
  }
}

Make sure to update the path to match your actual installation directory.

Step 2: Restart Claude Desktop

After updating the configuration, restart Claude Desktop for the changes to take effect.

Step 3: Use the Tools

The MCP server provides two main tools:

1. check_page_links

Check all links on a single HTML page.

Parameters:

  • url (required): The URL of the page to check

  • excludeExternalLinks (optional): If true, only check internal links (default: false)

  • honorRobotExclusions (optional): If true, respect robots.txt (default: true)

Example:

Can you check the links on https://example.com for any broken links?

2. check_site

Recursively crawl and check all links across an entire website.

Parameters:

  • url (required): The starting URL of the site to check

  • excludeExternalLinks (optional): If true, only check internal links (default: false)

  • honorRobotExclusions (optional): If true, respect robots.txt (default: true)

  • maxSocketsPerHost (optional): Maximum concurrent requests per host (default: 1)

Example:

Can you crawl https://example.com and check all pages for broken links?

Remote Deployment with HTTP/SSE Transport

For remote deployments (e.g., deploying on a VPS and connecting via ngrok), use the HTTP/SSE server:

Step 1: Start the HTTP Server

# Start the HTTP/SSE server (default port 3000)
npm run start:http

# Or specify a custom port
PORT=8080 npm run start:http

The server will start on http://localhost:3000 (or your specified port).

Step 2: Expose with ngrok (or alternative)

# Install ngrok if you haven't already
npm install -g ngrok

# Expose your local server
ngrok http 3000

ngrok will provide you with a public URL like: https://abc123.ngrok.io

Step 3: Configure Claude Desktop for Remote Connection

Update your Claude Desktop configuration to use the HTTP/SSE transport:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "broken-link-checker": {
      "url": "https://your-ngrok-url.ngrok.io/sse"
    }
  }
}

Replace your-ngrok-url.ngrok.io with your actual ngrok URL.

Step 4: Test the Connection

  1. Check the health endpoint: https://your-ngrok-url.ngrok.io/health

  2. Restart Claude Desktop

  3. Ask Claude to check links on a webpage

Environment Variables

You can configure the server using environment variables:

# Copy the example environment file
cp .env.example .env

# Edit .env with your settings
PORT=3000
HOST=0.0.0.0

Production Deployment

For production deployments, consider:

  1. Use a process manager (PM2, systemd):

    npm install -g pm2
    pm2 start server.js --name broken-link-checker-mcp
    pm2 save
    pm2 startup
  2. Use a reverse proxy (nginx, Caddy) for HTTPS

  3. Add authentication if exposing publicly

  4. Monitor logs and resource usage

Output Format

Both tools return JSON with the following structure:

{
  "summary": {
    "totalLinks": 100,
    "brokenLinks": 5,
    "workingLinks": 95
  },
  "brokenLinks": [
    {
      "url": "https://example.com/broken-page",
      "base": "https://example.com",
      "broken": true,
      "brokenReason": "HTTP_404",
      "http": {
        "statusCode": 404
      }
    }
  ]
}

Development

The main server code is in index.js. The server uses:

  • @modelcontextprotocol/sdk for MCP protocol implementation

  • broken-link-checker for link checking functionality

License

MIT

Available Tools

2 tools
check_siteA

Recursively crawl and check all links across an entire website. This will scan multiple pages and check all internal and external links found. Use with caution on large sites as it may take significant time.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlYesThe starting URL of the site to check
excludeExternalLinksNoIf true, only check internal links (default: false)
honorRobotExclusionsNoIf true, respect robots.txt and meta robots tags (default: true)
maxSocketsPerHostNoMaximum concurrent requests per host (default: 1)

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behavioral traits: the recursive crawling nature, scanning of multiple pages, checking of both internal and external links, and the performance warning about time consumption on large sites. This gives the agent important context about what to expect from this operation.

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?

The description is perfectly concise and well-structured in just two sentences. The first sentence clearly states the tool's purpose and scope, while the second provides important usage guidance. Every word earns its place with no redundancy or unnecessary information.

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

Completeness4/5

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

Given the tool's complexity (recursive crawling operation with performance implications), no annotations, and no output schema, the description does a good job of providing essential context. It explains what the tool does, its scope, and important behavioral considerations. However, it doesn't describe what the output looks like or any error conditions, which would be helpful given the absence of an 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?

The input schema has 100% description coverage, so all parameters are well-documented in the schema itself. The description doesn't add any additional parameter semantics beyond what's already in the schema descriptions. The baseline score of 3 is appropriate when the schema does the heavy lifting of parameter documentation.

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?

The description clearly states the tool's purpose with specific verbs ('recursively crawl and check all links') and resource ('across an entire website'). It distinguishes from the sibling tool 'check_page_links' by emphasizing it checks 'all links across an entire website' rather than just a single page.

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

Usage Guidelines4/5

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

The description provides clear context for when to use this tool ('Use with caution on large sites as it may take significant time'), which helps the agent understand performance implications. However, it doesn't explicitly state when to use the alternative 'check_page_links' tool versus this one, nor does it provide exclusion criteria beyond the caution about large sites.

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

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 2 tool updates
    • First observedcheck_page_links
    • First observedcheck_site

TDQS

A3.9/5.0

Scored across 2 tools

Disambiguation5/5

The two tools have clearly distinct purposes: check_page_links targets a single HTML page, while check_site handles an entire website with recursive crawling. There is no overlap in scope or functionality, making it easy for an agent to choose the appropriate tool based on the task.

Naming Consistency5/5

Both tools follow a consistent verb_noun pattern (check_page_links and check_site), using the same verb 'check' and descriptive nouns that clearly indicate their targets. The naming is predictable and readable throughout.

Tool Count2/5

With only two tools, the server feels thin for a broken link checker domain. While the tools cover single-page and site-wide checks, there are likely missing operations such as checking specific links, managing crawl settings, or handling reports, which could limit agent workflows.

Completeness3/5

The tools provide basic coverage for checking links on a page or site, but there are notable gaps. For example, there is no tool to check individual links, configure crawl parameters, or retrieve historical results, which might be expected in a more complete link-checking surface.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers