Skip to main content

Usage

docs-mcp-server list [options]

Options

--server-url
string
URL of external pipeline worker RPC endpoint (e.g., http://localhost:8080/api).When specified, lists libraries from the remote worker instead of local storage.

Examples

List Local Libraries

# Show all indexed libraries
docs-mcp-server list

List Remote Libraries

# Query remote worker for libraries
docs-mcp-server list --server-url http://worker.example.com:8080/api

Output

The command returns a JSON array of libraries with their versions:
[
  {
    "library": "react",
    "versions": [
      {
        "version": "18.0.0",
        "documentCount": 342,
        "lastUpdated": "2024-01-15T10:30:00Z"
      },
      {
        "version": "17.0.2",
        "documentCount": 298,
        "lastUpdated": "2023-12-10T14:20:00Z"
      }
    ]
  },
  {
    "library": "typescript",
    "versions": [
      {
        "version": "5.3.3",
        "documentCount": 567,
        "lastUpdated": "2024-01-20T09:15:00Z"
      }
    ]
  }
]

Output Fields

library
string
Name of the indexed library
versions
array
Array of version objects for this library
versions[].version
string
Version identifier (e.g., “18.0.0”)
versions[].documentCount
number
Number of documents indexed for this version
versions[].lastUpdated
string
ISO 8601 timestamp of when this version was last updated

Use Cases

Check Available Libraries

Verify what documentation is available before searching:
docs-mcp-server list
# Then search a library from the output
docs-mcp-server search react "hooks"

Verify Scraping Success

After scraping, confirm the library was indexed:
docs-mcp-server scrape mylib https://docs.example.com
docs-mcp-server list
# Should show 'mylib' in output

Check Document Counts

Verify how many documents were indexed:
{
  "library": "react",
  "versions": [
    {
      "version": "18.0.0",
      "documentCount": 342  // 342 pages indexed
    }
  ]
}

Monitor Multiple Versions

Track different versions of the same library:
{
  "library": "react",
  "versions": [
    {"version": "18.0.0", "documentCount": 342},
    {"version": "17.0.2", "documentCount": 298},
    {"version": "16.14.0", "documentCount": 276}
  ]
}

Empty Index

If no libraries are indexed, the output is an empty array:
[]
To add libraries, use the scrape command:
docs-mcp-server scrape react https://react.dev/reference/react

Performance

The list command is fast and does not require embedding model initialization. It only queries metadata from the document store.

See Also

  • scrape - Add libraries to the index
  • remove - Remove libraries from the index
  • search - Query indexed libraries

Build docs developers (and LLMs) love