Skip to content

Commit 590feb7

Browse files
committedMar 5, 2025·
docs: improved readme
1 parent c67126d commit 590feb7

File tree

1 file changed

+53
-32
lines changed

1 file changed

+53
-32
lines changed
 

‎README.md

+53-32
Original file line numberDiff line numberDiff line change
@@ -4,69 +4,90 @@
44
[![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
55
[![smithery badge](https://smithery.ai/badge/@ScrapeGraphAI/scrapegraph-mcp)](https://smithery.ai/server/@ScrapeGraphAI/scrapegraph-mcp)
66

7-
A [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) server that provides access to the [ScapeGraph AI](https://scrapegraphai.com) API. It allows language models to use AI-powered web scraping capabilities.
7+
A production-ready [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) server that provides seamless integration with the [ScapeGraph AI](https://scrapegraphai.com) API. This server enables language models to leverage advanced AI-powered web scraping capabilities with enterprise-grade reliability.
88

99
## Available Tools
1010

11-
The server exposes the following tools:
11+
The server provides the following enterprise-ready tools:
1212

13-
- `markdownify(website_url: str)`: Convert any webpage into clean, formatted markdown
14-
- `smartscraper(user_prompt: str, website_url: str)`: Extract structured data from any webpage using AI
15-
- `searchscraper(user_prompt: str)`: Perform AI-powered web searches with structured results
13+
- `markdownify(website_url: str)`: Transform any webpage into clean, structured markdown format
14+
- `smartscraper(user_prompt: str, website_url: str)`: Leverage AI to extract structured data from any webpage
15+
- `searchscraper(user_prompt: str)`: Execute AI-powered web searches with structured, actionable results
1616

17-
## Usage
17+
## Setup Instructions
1818

19-
You'll need a ScapeGraph API key to use this server. You can obtain one by:
19+
To utilize this server, you'll need a ScapeGraph API key. Follow these steps to obtain one:
2020

21-
1. Going to the [ScapeGraph Dashboard](https://dashboard.scrapegraphai.com)
22-
2. Creating an account and obtaining an API key
21+
1. Navigate to the [ScapeGraph Dashboard](https://dashboard.scrapegraphai.com)
22+
2. Create an account and generate your API key
2323

24-
### Installing via Smithery
24+
### Automated Installation via Smithery
2525

26-
To install ScrapeGraph API Integration Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@ScrapeGraphAI/scrapegraph-mcp):
26+
For automated installation of the ScrapeGraph API Integration Server using [Smithery](https://smithery.ai/server/@ScrapeGraphAI/scrapegraph-mcp):
2727

2828
```bash
2929
npx -y @smithery/cli install @ScrapeGraphAI/scrapegraph-mcp --client claude
3030
```
3131

32-
### Claude for Desktop
32+
### Claude Desktop Configuration
3333

34-
Update your `claude_desktop_config.json` (located in `~/Library/Application\ Support/Claude/claude_desktop_config.json` on macOS and `%APPDATA%/Claude/claude_desktop_config.json` on Windows) to include the following:
34+
Update your Claude Desktop configuration file with the following settings:
3535

3636
```json
3737
{
3838
"mcpServers": {
39-
"scrapegraph": {
40-
"command": "uvx",
39+
"@ScrapeGraphAI-scrapegraph-mcp": {
40+
"command": "npx",
4141
"args": [
42-
"scrapegraph_mcp"
43-
],
44-
"env": {
45-
"SGAI_API_KEY": "YOUR_SCRAPEGRAPH_API_KEY"
46-
}
42+
"-y",
43+
"@smithery/cli@latest",
44+
"run",
45+
"@ScrapeGraphAI/scrapegraph-mcp",
46+
"--config",
47+
"\"{\\\"scrapegraphApiKey\\\":\\\"sgai-123456\\\"}\""
48+
]
4749
}
4850
}
4951
}
5052
```
5153

52-
## Example Queries
54+
The configuration file is located at:
55+
- Windows: `%APPDATA%/Claude/claude_desktop_config.json`
56+
- macOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
5357

54-
Once connected, you can ask Claude questions like:
58+
## Example Use Cases
5559

56-
- "What are the main features of the ScapeGraph API?"
57-
- "Convert the ScapeGraph homepage into markdown"
58-
- "Extract the pricing information from the ScapeGraph website"
59-
- "Find information about the latest advancements in AI-powered web scraping"
60-
- "Summarize the content of the Python documentation website"
60+
The server enables sophisticated queries such as:
61+
62+
- "Analyze and extract the main features of the ScapeGraph API"
63+
- "Generate a structured markdown version of the ScapeGraph homepage"
64+
- "Extract and analyze pricing information from the ScapeGraph website"
65+
- "Research and summarize recent developments in AI-powered web scraping"
66+
- "Create a comprehensive summary of the Python documentation website"
6167

6268
## Error Handling
6369

64-
The server provides human-readable error messages for common issues:
70+
The server implements robust error handling with detailed, actionable error messages for:
71+
72+
- API authentication issues
73+
- Malformed URL structures
74+
- Network connectivity failures
75+
- Rate limiting and quota management
76+
77+
## Common Issues
6578

66-
- API authentication errors
67-
- Invalid URL formats
68-
- Network connectivity problems
79+
### Windows-Specific Connection
80+
81+
When running on Windows systems, you may need to use the following command to connect to the MCP server:
82+
83+
```bash
84+
C:\Windows\System32\cmd.exe /c npx -y @smithery/cli@latest run @ScrapeGraphAI/scrapegraph-mcp --config "{\"scrapegraphApiKey\":\"sgai-123456\"}"
85+
```
86+
87+
This ensures proper execution in the Windows environment.
6988

7089
## License
7190

72-
This project is licensed under the MIT License - see the LICENSE file for details.
91+
This project is distributed under the MIT License. For detailed terms and conditions, please refer to the LICENSE file.
92+
93+
Made with ❤️ by ScrapeGraphAI Team

0 commit comments

Comments
 (0)
Please sign in to comment.