Karim shoair commited on
Commit
aa534bd
·
1 Parent(s): 6dfaf13

docs: add an api reference to the mcp server

Browse files
Files changed (2) hide show
  1. docs/api-reference/mcp-server.md +39 -0
  2. mkdocs.yml +1 -0
docs/api-reference/mcp-server.md ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ search:
3
+ exclude: true
4
+ ---
5
+
6
+ # MCP Server API Reference
7
+
8
+ The **Scrapling MCP Server** provides six powerful tools for web scraping through the Model Context Protocol (MCP). This server integrates Scrapling's capabilities directly into AI chatbots and agents, allowing conversational web scraping with advanced anti-bot bypass features.
9
+
10
+ You can start the MCP server by running:
11
+
12
+ ```bash
13
+ scrapling mcp
14
+ ```
15
+
16
+ Or import the server class directly:
17
+
18
+ ```python
19
+ from scrapling.core.ai import ScraplingMCPServer
20
+
21
+ server = ScraplingMCPServer()
22
+ server.serve()
23
+ ```
24
+
25
+ ## Response Model
26
+
27
+ The standardized response structure that's returned by all MCP server tools:
28
+
29
+ ## ::: scrapling.core.ai.ResponseModel
30
+ handler: python
31
+ :docstring:
32
+
33
+ ## MCP Server Class
34
+
35
+ The main MCP server class that provides all web scraping tools:
36
+
37
+ ## ::: scrapling.core.ai.ScraplingMCPServer
38
+ handler: python
39
+ :docstring:
mkdocs.yml CHANGED
@@ -89,6 +89,7 @@ nav:
89
  - Selector: api-reference/selector.md
90
  - Fetchers: api-reference/fetchers.md
91
  - Custom Types: api-reference/custom-types.md
 
92
  - Writing your retrieval system: development/adaptive_storage_system.md
93
  - Using Scrapling's custom types: development/scrapling_custom_types.md
94
  - Support and Advertisement: donate.md
 
89
  - Selector: api-reference/selector.md
90
  - Fetchers: api-reference/fetchers.md
91
  - Custom Types: api-reference/custom-types.md
92
+ - MCP Server: api-reference/mcp-server.md
93
  - Writing your retrieval system: development/adaptive_storage_system.md
94
  - Using Scrapling's custom types: development/scrapling_custom_types.md
95
  - Support and Advertisement: donate.md