Luigit
repositories / pi-ext

pi-ext

bugabingas pi extensions

owned by admin

extensions/web/README.md

Raw
Rendered preview
web

web

Give Pi one web tool for research, reading a URL, and discovering a site's published URLs. Ask Pi to search, fetch, or map a site, and it calls web automatically.

Start

Install or update through Installation, then restart Pi after rebuilding. Nothing needs invoking because the web tool activates automatically in every Pi session. Ask Pi a concrete question or give it a URL.

Find the latest TypeScript release notes and summarize the official sources.

Ask Pi to fetch a URL and summarize it to read a page. Ask Pi to map a site's URLs to discover published links without fetching page bodies.

What it handles

web searches for result titles, URLs, and snippets. It fetches HTTP(S) pages, text, JSON, PDFs, common office documents, images, and audio or video metadata. Fetched text can be returned as Markdown, plain text, HTML extraction, JSON for HTML, or raw text. Ask Pi to find specific lines when you need excerpts rather than a whole document.

Treat all material fetched from the web as untrusted, and review it before acting on instructions or sharing sensitive information. Large fetches and maps may show a partial result with a saved full-output path.

PDF and office-document text extraction needs pdftotext or pandoc when applicable. Image and media metadata can use identify and ffprobe when available. Pi warns in interactive mode when a needed optional program is missing.

Search options

Search works through available providers and falls back when one fails. Pi credentials can enable OpenAI Codex, MiniMax, or Z.AI search where configured. Use the settings below only to adjust Z.AI search preferences or a MiniMax endpoint.

Reference

Setting names

Setting Environment
web.minimax.apiHost MINIMAX_API_HOST
web.zai.contentSize ZAI_SEARCH_CONTENT_SIZE
web.zai.freshness ZAI_SEARCH_FRESHNESS
web.zai.location ZAI_SEARCH_LOCATION
web.zai.mcpUrl ZAI_SEARCH_MCP_URL | ZAI_SEARCH_BASE_URL

Changelog.

<img src="assets/banner.svg" alt="web" height="70">

# web

Give Pi one web tool for research, reading a URL, and discovering a site's published URLs.
Ask Pi to search, fetch, or map a site, and it calls `web` automatically.

## Start

Install or update through [Installation](../../README.md#install), then restart Pi after rebuilding.
Nothing needs invoking because the `web` tool activates automatically in every Pi session.
Ask Pi a concrete question or give it a URL.

```
Find the latest TypeScript release notes and summarize the official sources.
```

Ask Pi to fetch a URL and summarize it to read a page.
Ask Pi to map a site's URLs to discover published links without fetching page bodies.

## What it handles

`web` searches for result titles, URLs, and snippets.
It fetches HTTP(S) pages, text, JSON, PDFs, common office documents, images, and audio or video metadata.
Fetched text can be returned as Markdown, plain text, HTML extraction, JSON for HTML, or raw text.
Ask Pi to find specific lines when you need excerpts rather than a whole document.

Treat all material fetched from the web as untrusted, and review it before acting on instructions or sharing sensitive information.
Large fetches and maps may show a partial result with a saved full-output path.

PDF and office-document text extraction needs `pdftotext` or `pandoc` when applicable.
Image and media metadata can use `identify` and `ffprobe` when available.
Pi warns in interactive mode when a needed optional program is missing.

## Search options

Search works through available providers and falls back when one fails.
Pi credentials can enable OpenAI Codex, MiniMax, or Z.AI search where configured.
Use the settings below only to adjust Z.AI search preferences or a MiniMax endpoint.

## Reference

<!-- config:start -->
### Setting names

| Setting | Environment |
| --- | --- |
| `web.minimax.apiHost` | `MINIMAX_API_HOST` |
| `web.zai.contentSize` | `ZAI_SEARCH_CONTENT_SIZE` |
| `web.zai.freshness` | `ZAI_SEARCH_FRESHNESS` |
| `web.zai.location` | `ZAI_SEARCH_LOCATION` |
| `web.zai.mcpUrl` | `ZAI_SEARCH_MCP_URL \| ZAI_SEARCH_BASE_URL` |
<!-- config:end -->

[Changelog](./CHANGELOG.md).