Skip to main content
Glama
Sign In
doc-scraper

doc-scraper

by Sriram-PR
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Go
Local

list_sites

Read-onlyIdempotent

Lists all documentation sites configured for crawling, so you can see which sites are available before starting a crawl or reading pages.

Instructions

List all configured sites available for crawling

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
sitesYes
config_pathYes
total_sitesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.15.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "config_path": {
+      "type": "string"
+    },
+    "sites": {
+      "items": {
+        "properties": {
+          "domain": {
+            "type": "string"
+          },
+          "key": {
+            "type": "string"
+          },
+          "last_crawled": {
+            "type": "string"
+          },
+          "max_depth": {
+            "type": "integer"
+          },
+          "path_prefix": {
+            "type": "string"
+          },
+          "start_urls_count": {
+            "type": "integer"
+          },
+          "status": {
+            "description": "\"running\" while a crawl is active; absent otherwise",
+            "type": "string"
+          }
+        },
+        "required": [
+          "key",
+          "domain",
+          "path_prefix",
+          "start_urls_count",
+          "max_depth"
+        ],
+        "type": "object"
+      },
+      "type": [
+        "null",
+        "array"
+      ]
+    },
+    "total_sites": {
+      "type": "integer"
+    }
+  },
+  "required": [
+    "sites",
+    "config_path",
+    "total_sites"
+  ],
+  "type": "object"
+}
  2. Changed2 schema fields changedv2.10.1
    • addedInput schema / properties
      Added value: +{}
    • addedInput schema / required
      Added value: +[]
  3. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and a closed-world scope, so the safety and side-effect profile is fully covered elsewhere. The description adds no behavioral context beyond that (e.g., empty-list behavior, scope of 'configured'), so it neither contradicts nor enriches the annotations.

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?

A single front-loaded sentence with no filler; the verb and scope come first and nothing is wasted.

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

Completeness5/5

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

For a nullary list tool, the annotations cover the safety profile and the output schema covers the return shape, so the description need not explain result structure. Nothing an agent needs to call this correctly is absent.

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

Parameters4/5

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

The tool takes zero parameters, so per the baseline there is nothing for the description to disambiguate. No parameter-related value is expected or missing.

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

Purpose4/5

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

States a specific verb+resource (list sites) plus scope ('all configured', 'available for crawling'), which implicitly separates it from mutation siblings like crawl_site. It does not explicitly distinguish itself from the other list-style sibling list_pages, so it stops short of a top score.

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?

Usage is only implied: 'available for crawling' hints this is a discovery step before crawl_site, but there is no explicit when-to-use, when-not-to-use, or mention of an alternative tool. Adequate but leaves the agent to infer the workflow.

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

Deploy Server

Other Tools