Skip to content

🕷️ The BEST Web Scraping framework that handles everything from a single request to a full-scale crawl! Don't be shy, join here: https://discord.gg/EMgGbDceNQ and follow here for daily tips and tricks: https://x.com/Scrapling_dev

docs: add an api reference to the mcp server

Karim shoair35b88fbb620d
diff --git a/docs/api-reference/mcp-server.md b/docs/api-reference/mcp-server.md
new file mode 100644
index 0000000..55fa91e
--- /dev/null
+++ b/docs/api-reference/mcp-server.md
@@ -0,0 +1,39 @@
+---
+search:
+ exclude: true
+---
+
+# MCP Server API Reference
+
+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.
+
+You can start the MCP server by running:
+
+```bash
+scrapling mcp
+```
+
+Or import the server class directly:
+
+```python
+from scrapling.core.ai import ScraplingMCPServer
+
+server = ScraplingMCPServer()
+server.serve()
+```
+
+## Response Model
+
+The standardized response structure that's returned by all MCP server tools:
+
+## ::: scrapling.core.ai.ResponseModel
+ handler: python
+ :docstring:
+
+## MCP Server Class
+
+The main MCP server class that provides all web scraping tools:
+
+## ::: scrapling.core.ai.ScraplingMCPServer
+ handler: python
+ :docstring:
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index dace64b..df268e0 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -89,6 +89,7 @@ nav:
- Selector: api-reference/selector.md
- Fetchers: api-reference/fetchers.md
- Custom Types: api-reference/custom-types.md
+ - MCP Server: api-reference/mcp-server.md
- Writing your retrieval system: development/adaptive_storage_system.md
- Using Scrapling's custom types: development/scrapling_custom_types.md
- Support and Advertisement: donate.md