Skip to content

Commit

Permalink
update README to reflect new capabilities
Browse files Browse the repository at this point in the history
  • Loading branch information
jackadamson committed Nov 29, 2024
1 parent 5552af1 commit c820086
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions src/fetch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,26 @@

A Model Context Protocol server that provides web content fetching capabilities. This server enables LLMs to retrieve and process content from web pages, converting HTML to markdown for easier consumption.

Presently the server only supports fetching HTML content.
The fetch tool will truncate the response, but by using the `start_index` argument, you can specify where to start the content extraction. This lets models read a webpage in chunks, until they find the information they need.

### Available Tools

- `fetch` - Fetches a URL from the internet and extracts its contents as markdown.
- `url` (string, required): URL to fetch
- `max_length` (integer, optional): Maximum number of characters to return (default: 5000)
- `start_index` (integer, optional): Start content from this character index (default: 0)
- `raw` (boolean, optional): Get raw content without markdown conversion (default: false)

### Prompts

- **fetch**
- Fetch a URL and extract its contents as markdown
- Argument: `url` (string, required): URL to fetch
- Arguments:
- `url` (string, required): URL to fetch

## Installation

Optionally: Install node.js, this will cause the fetch serve to use a different HTML simplifier that is more robust.
Optionally: Install node.js, this will cause the fetch server to use a different HTML simplifier that is more robust.

### Using uv (recommended)

Expand Down

0 comments on commit c820086

Please sign in to comment.