Skip to content

Overview

#Amp

First-party Amp plugin that routes Amp’s built-in read_web_page tool through curl.md and also adds a specific curl_md tool.

Important

The Amp Plugin API is still experimental. As a result, the curl.md Amp plugin may also change without warning.

#Quick Start

Install the plugin, launch Amp, and start curling.

  1. Install plugin

    Run the @curl.md/amp package installer:

    npx @curl.md/amp install --yes

    Successful installs create the Amp plugin shim in ~/.config/amp/plugins/curlmd.ts.

  2. Start Amp

    Start Amp with plugins enabled via the PLUGINS=all env var:

    PLUGINS=all amp

    Tip

    Amp requires PLUGINS=all to be set in order to load plugins. Add this to your environment so you do not need to prefix every Amp command manually.

  3. Use Amp

    Now that Amp is running with the curl.md plugin, all you need to do is use Amp. To confirm everything is set up, try this out:

    Read the curl.md Amp plugin docs and summarize how it works.
    https://curl.md/docs/plugins/amp

    Amp will automatically use curl.md to turn URLs you paste, or URLs it decides to fetch on its own, into markdown.

#Install

Run the @curl.md/amp npm package installer:

npx @curl.md/amp install --yes

This installs the package into Amp’s config directory and writes the plugin shim Amp loads from ~/.config/amp/plugins/curlmd.ts.

To update an existing install, rerun the installer at the latest version:

npx @curl.md/amp@latest install --yes

If you prefer to add the shim manually, create your own plugin entry in ~/.config/amp/plugins:

~/.config/amp/plugins/curlmd.ts
// @i-know-the-amp-plugin-api-is-wip-and-very-experimental-right-now
import plugin from '@curl.md/amp'
export default plugin

#Usage

Ask for a page, paste links, or let Amp figure out what it needs to fetch.

#Prompting

Inside Amp, prompt like you normally would, for example:

Read the Cloudflare Agents docs and summarize the core concepts.
https://developers.cloudflare.com/agents

In this example, Amp will use curl.md to fetch the page and return markdown optimized for agents.

You can also tell Amp to use a specific objective, keywords, or let it decide what to use on its own (it’s really good at this).

#Authentication

The plugin uses the same auth model as the CLI. Log in to connect the plugin to your curl.md account or organization.

curl.md auth login

For non-interactive environments, set CURLMD_API_KEY.

#Tools

The plugin registers the following tools:

ToolDescription
curl_mdFetch a URL as markdown.
read_web_pageOverrides built-in read_web_page with markdown output.

Both curl_md and the intercepted read_web_page tool accept the following inputs:

InputTypeDescription
urlstringHTTP(S) URL or bare domain to fetch. Prefer the canonical docs or article URL.
objective?stringSpecific question to answer from the page. Use when only part matters.
keywords?string[]Keywords to focus extraction on relevant sections.
mode?rush / smartUse rush for speed or smart for better section selection on long or noisy pages.
fresh?booleanBypass cache when freshness matters.

#Contributing

We welcome contributions to make the Amp plugin better. Feel free to create issues or pull requests on GitHub if there are issues or something could be improved.