README.md•3.07 kB
# DocsScraper MCP Server
An MCP server that connects to the DocsScraper web API to provide semantic search capabilities through documentation chunks.
## Features
- **Semantic Search**: Search through documentation chunks using embeddings and AI validation
- **API Integration**: Connects to your DocsScraper web application via REST API
- **Fallback Sources**: Automatically falls back to scraper sources when no local results are found
- **Configurable Results**: Control the number of search results (1-10, default: 5)
- **Service Filtering**: Filter search results by specific service names (case-insensitive)
## Configuration
The server requires the following environment variables:
- `DOCS_SCRAPER_API_KEY`: API key for authentication (required)
## Tools
### search_docs
Search through documentation chunks using semantic search.
**Parameters:**
- `query` (string, required): The search query to find relevant documentation
- `top` (number, optional): Maximum number of results to return (1-10, default: 5)
- `service` (string, required): Service name to filter results by (case-insensitive)
**Examples:**
```json
{
"query": "how to configure authentication",
"service": "Binance",
"top": 3
}
```
```json
{
"query": "React hooks documentation",
"top": 5,
"service": "React"
}
```
## Resources
### docs-scraper://api/info
Provides information about the connected DocsScraper API, including:
- Base URL configuration
- API key status
- Endpoint details
- Authentication method
## API Integration
This server connects to the DocsScraper web API endpoint:
- **Endpoint**: `GET /api/chunks/search`
- **Authentication**: API Key via `X-API-Key` header
- **Parameters**: `query` (string), `top` (number), `service` (string, optional)
The search endpoint:
1. Uses embeddings to find semantically similar chunks
2. Applies AI validation to ensure relevance
3. Falls back to scraper sources if no local results are found
4. Returns chunks with scores and source information
## Installation
```bash
npm install
npm run build
```
## Config in mcp.json
```json
{
"mcpServers": {
"docs-scraper": {
"command": "node",
"args": [
"/Users/tanevanwifferen/Documents/Cline/MCP/docs-scraper-server/build/index.js"
],
"env": {
"DOCS_SCRAPER_API_KEY": "###",
"DOCS_SCRAPER_BASE_URL": "https://api.mcpdocsscraper.click"
},
"disabled": false,
"alwaysAllow": [
"search_docs"
],
"timeout": 900 // important, we need a lot of time to do our requests
}
}
```
## Usage
The server is designed to be used with MCP-compatible clients. Configure your client to connect to this server with the appropriate environment variables set.
## Error Handling
The server provides detailed error messages for common issues:
- Authentication failures (401)
- Invalid requests (400)
- Connection issues (ECONNREFUSED)
## Development
```bash
# Build the server
npm run build
# Watch for changes during development
npm run watch
# Test with MCP inspector
npm run inspector