Skip to content

reference.md

Latest commit

 

History

History
36 lines (27 loc) · 2.19 KB

reference.md

File metadata and controls

36 lines (27 loc) · 2.19 KB
Raw

X Collector — Reference

← Back to the front page ｜ 🔧 Engineering guide

This page is the entrance to the exact specifications. Each area below has a dedicated document; this index tells you which one is authoritative for what.

Specification index

Area Authoritative document Language
Environment variables (complete list) operations.md — environment variable reference Japanese
Feed and application APIs api.md Japanese
UI API contract (v1) api-contract-ui-v1.md Japanese
Agent feed: differential search contract agent-feed.md English
MCP server: endpoint, auth, tools mcp-server.md English
Family Feed API family-feed-api.md Japanese
Pipeline stages, taxonomy, data model v2-design.md Japanese
Design system (WIRED-inspired editorial language) DESIGN.md English
LLM prompts (runtime-loaded — do not move) prompts/ —
Production jobs, cron, retention, source lifecycle operations.md Japanese
Step4 cross-linking: manual-run runbook step4-crosslink-llm-manual-runbook.md Japanese
Change history changelog.md Japanese

Key contracts at a glance

Short versions of the rules integrators most often need. The documents above always win if they disagree.

  • Newsletter BFF key fallback — server-side routes resolve the API key in the order NEWSLETTER_API_KEY → DIGEST_API_KEY → FEED_API_KEY
  • MCP gate — MCP_API_KEY falls back to FAMILY_FEED_API_KEY; when both are unset the server runs in open dev mode
  • Admin routes fail closed — when ADMIN_EMAIL_ALLOWLIST is unset, /admin and /api/admin/** return 403
  • Default LLM models — classification, cross-linking, and composition all default to google/gemini-3.1-flash-lite-preview via OpenRouter
  • MCP endpoint — read-only Streamable HTTP at /api/mcp/mcp, exposing search_feed and get_daily_news