rss-agent-discovery

内容来源：README.md（说明文档） · 原始地址 · 查看安装指南

原始内容

# RSS Agent Discovery

AI agent-focused RSS feed discovery tool. JSON-only output to stdout, errors to stderr only when `--verbose` is enabled.

## Why This Tool?

Existing RSS discovery tools (`rss-url-finder`, `rss-finder`) were built for human developers. They output human-readable text and don't validate that feeds actually exist.

This tool is designed for **AI agents** (Claude, Cursor, GPT):
- JSON-only output to stdout (machine-parseable)
- Errors to stderr only when `--verbose` is enabled (clean output by default)
- All errors and warnings included in JSON structure
- Semantic exit codes (0=found, 1=none, 2=error)
- Fast (10s default timeout, parallel scanning)
- Discovery-only (returns feed URLs, doesn't parse content)
- Finds feeds AI agents miss

**Proof:** Cursor fails to find `https://vercel.com/atom`. This tool succeeds.

## Installation

```bash
npm install
npm run build
```

### Agent Skills

Install AI agent skill with Skills CLI:

```bash
npx skills add brooksy4503/rss-agent-discovery --skill rss-agent-discovery
```

More info about the Skills CLI: https://skills.sh/

## Usage

### Basic usage:
```bash
node dist/find-rss-feeds.js https://vercel.com
```

Or via CLI (after `npm link`):
```bash
rss-discover https://vercel.com
```

### Multiple URLs (parallel processing):
```bash
node dist/find-rss-feeds.js https://vercel.com https://news.ycombinator.com https://stripe.com
```

### Parse with jq:
```bash
node dist/find-rss-feeds.js https://vercel.com | jq '.results[0].feeds'
```

### Custom timeout:
```bash
node dist/find-rss-feeds.js --timeout 15000 https://example.com
```

### Skip blog scanning:
```bash
node dist/find-rss-feeds.js --skip-blogs https://example.com
```

### Limit blog scans:
```bash
node dist/find-rss-feeds.js --max-blogs 3 https://example.com
```

### Custom blog paths:
```bash
node dist/find-rss-feeds.js --blog-paths '/blog,/news' https://example.com
# or with pipe separator
node dist/find-rss-feeds.js --blog-paths '/blog|/updates' https://example.com
```

### Verbose mode (debug logging):
```bash
node dist/find-rss-feeds.js --verbose https://example.com
```

### Show help:
```bash
node dist/find-rss-feeds.js --help
```

### Show version:
```bash
node dist/find-rss-feeds.js --version
# or
rss-discover --version
```

### Run tests:
```bash
npm test              # Run all tests (unit + smoke)
npm run test:unit     # Run unit tests only
npm run test:smoke    # Run smoke tests (integration)
```

## Output Schema

```json
{
  "success": true,
  "partialResults": false,
  "results": [
    {
      "url": "https://vercel.com",
      "feeds": [
        {
          "url": "https://vercel.com/atom",
          "title": "atom",
          "type": "atom"
        }
      ],
      "error": null,
      "diagnostics": []
    }
  ]
}
```

**Fields:**
- `success` (boolean): `true` if no URLs had errors, `false` if at least one URL had an error
- `partialResults` (boolean, optional): `true` if `success === false` but some feeds were still found
- `results` (array): One entry per input URL
  - `url` (string): The scanned URL
  - `feeds` (array): Discovered feed objects with `url`, `title`, and `type` ('rss' | 'atom' | 'unknown')
  - `error` (string | null): Error message if scanning failed, `null` otherwise. Timeout errors are normalized to `"Timeout"`
  - `diagnostics` (string[], optional): Array of warning messages for non-fatal issues (e.g., failed blog path scans)

## Output Contract

**Default behavior (without `--verbose`):**
- JSON-only output to stdout (machine-parseable)
- No stderr output (clean for programmatic consumption)
- All errors and warnings included in JSON structure

**Verbose mode (`--verbose`):**
- JSON output to stdout (unchanged)
- Debug logging to stderr (useful for troubleshooting)
- Additional context about skipped URLs, validation failures, etc.

**Recommended integration pattern:**
1. Parse stdout as JSON (always valid JSON, even on errors)
2. Check `success` field for overall status
3. Check `partialResults` if `success === false` to see if any feeds were found
4. Check `error` field in each result for URL-specific failures
5. Check `diagnostics` array for warnings and non-fatal issues
6. Use `--verbose` flag only when troubleshooting or debugging

## Exit Codes

- `0` - One or more feeds found (or `--help` / `--version` used)
- `1` - No feeds found
- `2` - Error occurred

## Features

- Discovers RSS/Atom feeds from HTML `<link>` tags
- Tests common paths (`/rss.xml`, `/atom`, `/feed`, etc.)
- Scans blog subdirectories (`/blog`, `/news`, `/articles`)
- Parallel processing for multiple URLs
- Deduplicates feeds across all sources
- Validates feeds actually exist and return XML
- JSON-only output to stdout
- Errors to stderr only when `--verbose` is enabled
- All errors and warnings included in JSON structure
- 10s default timeout per URL (configurable)

## Examples

### Find feeds for Vercel:
```bash
node dist/find-rss-feeds.js https://vercel.com
```

Output:
```json
{
  "success": true,
  "results": [
    {
      "url": "https://vercel.com",
      "feeds": [
        {"url": "https://vercel.com/atom", "title": "atom", "type": "atom"}
      ],
      "error": null
    }
  ]
}
```

### Check exit code:
```bash
node dist/find-rss-feeds.js https://vercel.com
echo $?  # Outputs: 0
```

### No feeds found:
```bash
node dist/find-rss-feeds.js https://example.com
echo $?  # Outputs: 1
```

### Parallel scan:
```bash
node dist/find-rss-feeds.js https://vercel.com https://news.ycombinator.com | jq
```

## Integration Example

### Claude AI:
```python
import subprocess
import json

result = subprocess.run(
  ['node', 'dist/find-rss-feeds.js', 'https://vercel.com'],
  capture_output=True,
  text=True
)

data = json.loads(result.stdout)
feeds = data['results'][0]['feeds']
exit_code = result.returncode
```

### Shell script:
```bash
#!/bin/bash
# No need to redirect stderr - it's clean by default
result=$(node dist/find-rss-feeds.js "$1")
exit_code=$?

if [ $exit_code -eq 0 ]; then
  echo "Found feeds:"
  echo "$result" | jq '.results[0].feeds'
fi
```

## AI Agent Integration

This tool is designed to work seamlessly with AI coding agents:

### Opencode / Claude Code
```bash
# Opencode can call this tool directly
npx -y rss-agent-discovery https://example.com | jq '.results[0].feeds[].url'
```

### Cursor
Cursor can integrate this as a custom tool:
```json
{
  "name": "rss_discovery",
  "command": "npx -y rss-agent-discovery {url}",
  "description": "Discover RSS feeds from a website"
}
```

### GitHub Copilot
```javascript
// Use in GitHub Actions or workflows
const { execSync } = require('child_process');
const result = JSON.parse(
  execSync('npx -y rss-agent-discovery https://github.com/blog').toString()
);
```

### Custom MCP Server
```typescript
// Build a Model Context Protocol server
import { spawn } from 'child_process';

async function discoverRSS(url: string) {
  const proc = spawn('npx', ['-y', 'rss-agent-discovery', url]);
  const chunks: Buffer[] = [];
  
  for await (const chunk of proc.stdout) {
    chunks.push(chunk);
  }
  
  return JSON.parse(Buffer.concat(chunks).toString());
}
```

### Why AI Agents Need This Tool

AI agents (Claude, Cursor, ChatGPT Codex) struggle with RSS discovery because:
- They rely on web search which may miss feeds
- They don't systematically parse HTML `<link>` tags
- They give up after trying 2-3 common paths
- They can't validate feeds actually return XML

This tool solves all of those problems with structured JSON output.

## Development

### Build:
```bash
npm run build
```

### Test:
```bash
npm test              # Run all tests (unit + smoke)
npm run test:unit     # Run unit tests only
npm run test:smoke    # Run smoke tests (integration)
```

### Lint:
```bash
tsc --noEmit
```

## Project Structure

- `find-rss-feeds.ts` - TypeScript source
- `dist/` - Compiled JavaScript
- `package.json` - Dependencies and scripts

## License

MIT

RSS Agent Discovery

AI agent-focused RSS feed discovery tool. JSON-only output to stdout, errors to stderr only when --verbose is enabled.

Why This Tool?

Existing RSS discovery tools (rss-url-finder, rss-finder) were built for human developers. They output human-readable text and don't validate that feeds actually exist.

This tool is designed for AI agents (Claude, Cursor, GPT):

JSON-only output to stdout (machine-parseable)
Errors to stderr only when --verbose is enabled (clean output by default)
All errors and warnings included in JSON structure
Semantic exit codes (0=found, 1=none, 2=error)
Fast (10s default timeout, parallel scanning)
Discovery-only (returns feed URLs, doesn't parse content)
Finds feeds AI agents miss

Proof: Cursor fails to find https://vercel.com/atom. This tool succeeds.

Installation

npm install
npm run build

Agent Skills

Install AI agent skill with Skills CLI:

npx skills add brooksy4503/rss-agent-discovery --skill rss-agent-discovery

More info about the Skills CLI: https://skills.sh/

Usage

Basic usage:

node dist/find-rss-feeds.js https://vercel.com

Or via CLI (after npm link):

rss-discover https://vercel.com

Multiple URLs (parallel processing):

node dist/find-rss-feeds.js https://vercel.com https://news.ycombinator.com https://stripe.com

Parse with jq:

node dist/find-rss-feeds.js https://vercel.com | jq '.results[0].feeds'

Custom timeout:

node dist/find-rss-feeds.js --timeout 15000 https://example.com

Skip blog scanning:

node dist/find-rss-feeds.js --skip-blogs https://example.com

Limit blog scans:

node dist/find-rss-feeds.js --max-blogs 3 https://example.com

Custom blog paths:

node dist/find-rss-feeds.js --blog-paths '/blog,/news' https://example.com
# or with pipe separator
node dist/find-rss-feeds.js --blog-paths '/blog|/updates' https://example.com

Verbose mode (debug logging):

node dist/find-rss-feeds.js --verbose https://example.com

Show help:

node dist/find-rss-feeds.js --help

Show version:

node dist/find-rss-feeds.js --version
# or
rss-discover --version

Run tests:

npm test              # Run all tests (unit + smoke)
npm run test:unit     # Run unit tests only
npm run test:smoke    # Run smoke tests (integration)

Output Schema

{
  "success": true,
  "partialResults": false,
  "results": [
    {
      "url": "https://vercel.com",
      "feeds": [
        {
          "url": "https://vercel.com/atom",
          "title": "atom",
          "type": "atom"
        }
      ],
      "error": null,
      "diagnostics": []
    }
  ]
}

Fields:

success (boolean): true if no URLs had errors, false if at least one URL had an error
partialResults (boolean, optional): true if success === false but some feeds were still found
results (array): One entry per input URL
- url (string): The scanned URL
- feeds (array): Discovered feed objects with url, title, and type ('rss' | 'atom' | 'unknown')
- error (string | null): Error message if scanning failed, null otherwise. Timeout errors are normalized to "Timeout"
- diagnostics (string[], optional): Array of warning messages for non-fatal issues (e.g., failed blog path scans)

Output Contract

Default behavior (without --verbose):

JSON-only output to stdout (machine-parseable)
No stderr output (clean for programmatic consumption)
All errors and warnings included in JSON structure

Verbose mode (--verbose):

JSON output to stdout (unchanged)
Debug logging to stderr (useful for troubleshooting)
Additional context about skipped URLs, validation failures, etc.

Recommended integration pattern:

Parse stdout as JSON (always valid JSON, even on errors)
Check success field for overall status
Check partialResults if success === false to see if any feeds were found
Check error field in each result for URL-specific failures
Check diagnostics array for warnings and non-fatal issues
Use --verbose flag only when troubleshooting or debugging

Exit Codes

0 - One or more feeds found (or --help / --version used)
1 - No feeds found
2 - Error occurred

Features

Discovers RSS/Atom feeds from HTML <link> tags
Tests common paths (/rss.xml, /atom, /feed, etc.)
Scans blog subdirectories (/blog, /news, /articles)
Parallel processing for multiple URLs
Deduplicates feeds across all sources
Validates feeds actually exist and return XML
JSON-only output to stdout
Errors to stderr only when --verbose is enabled
All errors and warnings included in JSON structure
10s default timeout per URL (configurable)

Examples

Find feeds for Vercel:

node dist/find-rss-feeds.js https://vercel.com

Output:

{
  "success": true,
  "results": [
    {
      "url": "https://vercel.com",
      "feeds": [
        {"url": "https://vercel.com/atom", "title": "atom", "type": "atom"}
      ],
      "error": null
    }
  ]
}

Check exit code:

node dist/find-rss-feeds.js https://vercel.com
echo $?  # Outputs: 0

No feeds found:

node dist/find-rss-feeds.js https://example.com
echo $?  # Outputs: 1

Parallel scan:

node dist/find-rss-feeds.js https://vercel.com https://news.ycombinator.com | jq

Integration Example

Claude AI:

import subprocess
import json

result = subprocess.run(
  ['node', 'dist/find-rss-feeds.js', 'https://vercel.com'],
  capture_output=True,
  text=True
)

data = json.loads(result.stdout)
feeds = data['results'][0]['feeds']
exit_code = result.returncode

Shell script:

#!/bin/bash
# No need to redirect stderr - it's clean by default
result=$(node dist/find-rss-feeds.js "$1")
exit_code=$?

if [ $exit_code -eq 0 ]; then
  echo "Found feeds:"
  echo "$result" | jq '.results[0].feeds'
fi

AI Agent Integration

This tool is designed to work seamlessly with AI coding agents:

Opencode / Claude Code

# Opencode can call this tool directly
npx -y rss-agent-discovery https://example.com | jq '.results[0].feeds[].url'

Cursor

Cursor can integrate this as a custom tool:

{
  "name": "rss_discovery",
  "command": "npx -y rss-agent-discovery {url}",
  "description": "Discover RSS feeds from a website"
}

GitHub Copilot

// Use in GitHub Actions or workflows
const { execSync } = require('child_process');
const result = JSON.parse(
  execSync('npx -y rss-agent-discovery https://github.com/blog').toString()
);

Custom MCP Server

// Build a Model Context Protocol server
import { spawn } from 'child_process';

async function discoverRSS(url: string) {
  const proc = spawn('npx', ['-y', 'rss-agent-discovery', url]);
  const chunks: Buffer[] = [];
  
  for await (const chunk of proc.stdout) {
    chunks.push(chunk);
  }
  
  return JSON.parse(Buffer.concat(chunks).toString());
}

Why AI Agents Need This Tool

AI agents (Claude, Cursor, ChatGPT Codex) struggle with RSS discovery because:

They rely on web search which may miss feeds
They don't systematically parse HTML <link> tags
They give up after trying 2-3 common paths
They can't validate feeds actually return XML

This tool solves all of those problems with structured JSON output.

Development

Build:

npm run build

Test:

npm test              # Run all tests (unit + smoke)
npm run test:unit     # Run unit tests only
npm run test:smoke    # Run smoke tests (integration)

Lint:

tsc --noEmit

Project Structure

find-rss-feeds.ts - TypeScript source
dist/ - Compiled JavaScript
package.json - Dependencies and scripts

License

MIT