@stophy/mcp 1.3.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -11
- package/dist/index.js +10 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# Stophy MCP
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
Give your agents the live web over MCP. Your agent reaches every Stophy endpoint through three tools.
|
|
3
|
+
Give your agents the live web over MCP. Your agent can search, scrape, map, crawl and extract, and read a site's own data through a parser.
|
|
6
4
|
|
|
7
5
|
[](https://cursor.com/en/install-mcp?name=stophy&config=eyJ1cmwiOiJodHRwczovL21jcC5zdG9waHkuZGV2L21jcCJ9)
|
|
8
6
|
|
|
@@ -111,17 +109,32 @@ The package needs Node.js 18 or later.
|
|
|
111
109
|
|
|
112
110
|
## Tools
|
|
113
111
|
|
|
114
|
-
| Tool | What it does
|
|
115
|
-
| -------------------------- |
|
|
116
|
-
| `
|
|
117
|
-
| `
|
|
118
|
-
| `
|
|
112
|
+
| Tool | What it does |
|
|
113
|
+
| -------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
114
|
+
| `stophy_search` | Searches the web, news and images |
|
|
115
|
+
| `stophy_scrape` | Reads a page as markdown, HTML, links, a screenshot or JSON |
|
|
116
|
+
| `stophy_map` | Lists the pages on a site |
|
|
117
|
+
| `stophy_crawl` | Starts a crawl of a site in the background and returns its `id` |
|
|
118
|
+
| `stophy_extract` | Pulls the fields you name from pages as JSON |
|
|
119
|
+
| `stophy_search_endpoints` | Finds the endpoint for a task, with its cost. Free |
|
|
120
|
+
| `stophy_describe_endpoint` | Shows an endpoint's inputs, an example and what it returns. Free |
|
|
121
|
+
| `stophy_call` | Runs any endpoint by `id` with `input`, and optional `fields` and `maxTextLength` |
|
|
122
|
+
| `stophy_signup` | Gets your agent an API key: it returns a link for you to approve, then the key once you call it with the code |
|
|
123
|
+
|
|
124
|
+
To get a site's own data as JSON, such as a Reddit search, a YouTube transcript or Google Maps places, call `stophy_scrape` with the site's page URL and a parser:
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{
|
|
128
|
+
"url": "https://www.reddit.com/search/?q=bun+runtime",
|
|
129
|
+
"formats": [{ "type": "json", "parser": "reddit-search" }]
|
|
130
|
+
}
|
|
131
|
+
```
|
|
119
132
|
|
|
120
|
-
|
|
133
|
+
The `stophy_scrape` description names every parser, and [the parser list](https://api.stophy.dev/v1/parsers) shows the page each one takes.
|
|
121
134
|
|
|
122
|
-
|
|
135
|
+
Endpoint ids are camelCase, such as `crawlStatus` or `batchScrape`. A crawl runs in the background: call `crawlStatus` through `stophy_call` with the crawl's `id`. While the crawl runs, the result has a `next` link: send the `cursor` value from that link as `cursor` to get the pages finished since. `fields` keeps only the keys you name on each row. Most calls cost 1 credit. Search costs 2 credits per 10 results, a crawl 1 credit a page, and extract 5 credits for most pages. Each result shows its cost in `creditsUsed`. See [pricing](https://docs.stophy.dev/billing).
|
|
123
136
|
|
|
124
|
-
|
|
137
|
+
To give each endpoint its own tool, add `toolsets` to the URL with a source name, such as `https://api.stophy.dev/mcp?toolsets=web`. Your agent then also gets `scrape`, `crawlStatus`, `batchScrape` and every other web endpoint as tools.
|
|
125
138
|
|
|
126
139
|
## Network and credentials
|
|
127
140
|
|