AI 에이전트 지원 개요
Cursor·Claude Code·Codex·ChatGPT 등 AI 도구가 Book Print API 문서를 정확히 읽고 코드 생성에 활용하도록 3가지 마크다운 산출물을 제공합니다.
왜 만들었는가
HTML 문서 페이지는 사람을 위한 것입니다. 사이드바·아이콘·CSS 등이 AI에게는 노이즈가 됩니다. AI 도구가 정확한 코드를 생성하려면 본문만 깨끗한 마크다운으로 받을 수 있어야 합니다.
본 문서는 3가지 표준 산출물(llms.txt · llms-full.txt · .md URL)을 제공하여어떤 AI 도구든 URL fetch만으로 본 문서를 컨텍스트로 사용할 수 있도록 설계되었습니다. llmstxt.org 표준을 따르며, Resend·Stripe 등 주요 API 문서와 같은 패턴입니다.
3가지 산출물
| 산출물 | URL | 용도 |
|---|---|---|
| llms.txt (인덱스) | /docs/llms.txt | 전체 문서의 페이지 목록. AI 도구가 "어떤 페이지가 있는지" 파악 |
| llms-full.txt (합본) | /docs/llms-full.txt | 모든 페이지 본문을 합친 단일 마크다운. 큰 컨텍스트 윈도우 도구에서 통째로 적재 |
| .md URL (페이지별) | /docs/{slug}.md | 특정 페이지만 마크다운으로. URL 끝에 .md만 붙이면 됨 |
세 산출물은 같은 변환기에서 생성되어 일관된 결과를 보장합니다. 페이지가 수정되면 다음 빌드에서 세 곳 모두 자동으로 갱신됩니다.
도구별 사용 흐름
모든 AI 도구가 표준 텍스트 파일·URL을 fetch하는 방식이라 별도 설치·플러그인이 필요 없습니다.
Cursor (IDE)
채팅에 @로 URL을 추가하면 자동으로 fetch됩니다.
@https://api.sweetbook.com/docs/llms-full.txt
Sandbox 환경에서 PDF 업로드 시나리오대로 Node.js 코드 짜줘.Claude Code (CLI)
URL을 채팅에 언급하면 WebFetch 도구가 자동 호출됩니다.
@https://api.sweetbook.com/docs/llms-full.txt 읽고
주문 부분 취소 클라이언트 코드 작성해줘.Codex (OpenAI CLI)
curl로 받아 컨텍스트로 첨부하거나, 세션 내 URL 언급으로 fetch합니다.
# 1. 문서 다운로드
curl https://api.sweetbook.com/docs/llms-full.txt > docs.md
# 2. Codex 세션에서 docs.md를 컨텍스트로 첨부
codex그 외 도구
- ChatGPT / Claude.ai 웹: URL을 채팅에 붙여넣으면 자동 fetch
- GitHub Copilot Chat:
#fetch도구 또는 인라인 URL - Perplexity / Gemini: 사용자가 URL 첨부 또는 인라인 입력
- 로컬 RAG 시스템:
curl로 다운로드 → 임베딩 인덱싱
AI가 자동으로 받는 가드 메모
일부 페이지는 마크다운 응답에 AI 전용 가드 메모가 HTML 주석으로 포함됩니다. 사람이 HTML 페이지로 볼 때는 표시되지 않고, AI가 .md URL로 fetch할 때만 노출됩니다.
# Webhooks API
<!-- AGENT INSTRUCTIONS:
- secretKey 접두사는 `whsk_`. 최초 등록 시에만 전체 값이 응답에 반환되고, ...
- 서명은 HMAC-SHA256. 서명 페이로드는 `{timestamp}.{JSON body}` 형식, ...
-->
웹훅을 설정하여 주문 상태 변경 등의 이벤트를 실시간으로 수신하는 방법을 안내합니다.
...가드 메모는 AI가 자주 헷갈리는 포인트(예: "Bearer 접두사 필수", "충전금 표기 통일", "orderStatus는 문자열 enum")를 명시적으로 알려주어 환각·실수를 줄입니다. 자세한 내용은 .md URL 사용법 참조.