llms.txt · llms-full.txt 사용법

AI 에이전트가 Book Print API 전체 문서를 한 번에 읽도록 제공하는 두 가지 산출물의 차이와 사용법입니다.

llms.txt vs llms-full.txt

항목llms.txt (인덱스)llms-full.txt (합본)
URL/docs/llms.txt/docs/llms-full.txt
크기~3 KB (페이지 링크 목록)~450 KB (36개 페이지 본문 전체)
구조그룹별 페이지 목록 + 각 페이지 .md 링크모든 페이지를 --- 구분자로 연결한 단일 마크다운
토큰 수~1 K~30~50 K (한국어 + 영어 코드 혼합)
주 용도AI가 "어떤 페이지를 더 읽을지" 결정하는 디렉토리큰 컨텍스트 윈도우(128K+) 도구에서 전체 본문 한 번에 적재
먼저 시도해볼 것은 llms-full.txt — 대부분의 최신 AI 도구(Claude Code 1M·Cursor Pro·ChatGPT Plus 등)는 450 KB 를 한 번에 적재할 수 있습니다. 토큰 한도가 작은 도구에서만 llms.txt + 페이지별 .md를 조합하세요.

llms.txt 형식

llmstxt.org 표준 형식을 따릅니다. 페이지 링크는 모두 .md 확장자로 지정되어 AI가 인덱스 → 페이지 단위 fetch 흐름으로 사용 가능합니다.

llms.txt 응답 예시 (앞부분)
# Sweetbook API 개발문서

> 포토북 PDF 생성·주문·배송 자동화를 위한 REST API.
> Base URL: https://api.sweetbook.com (Live) / https://api-sandbox.sweetbook.com (Sandbox).
> 인증: Bearer API Key. 충전금 결제 모델.

## 시작하기

- [개요](https://api.sweetbook.com/docs.md)
- [파트너 등록](https://api.sweetbook.com/docs/registration.md)
- [환경 (Sandbox / Live)](https://api.sweetbook.com/docs/environments.md)
- [인증 (API Key)](https://api.sweetbook.com/docs/authentication.md)

## 빠른 시작
...

llms-full.txt 형식

모든 페이지 본문을 --- 구분자로 연결한 단일 마크다운입니다. 페이지 순서는 사이드바 순서를 따릅니다.

llms-full.txt 응답 예시 (앞부분)
# Sweetbook API 개발문서 — 전체 본문

> 포토북 PDF 생성·주문·배송 자동화를 위한 REST API.
> Base URL: https://api.sweetbook.com (Live) / https://api-sandbox.sweetbook.com (Sandbox).
> 본 파일은 모든 페이지 본문을 합친 단일 마크다운입니다. 페이지별 인덱스는 /docs/llms.txt 참조.

---

# 개요
...

---

# 파트너 등록
...

(... 이하 36개 페이지 본문)

도구별 등록 방법

Cursor

채팅에 @ + URL 형식으로 첨부합니다.

Cursor 채팅 예시
@https://api.sweetbook.com/docs/llms-full.txt

다음 시나리오대로 코드 짜줘:
1. Sandbox API Key로 인증
2. PDF 업로드 방식으로 책 생성 (creationType=PDF_UPLOAD)
3. 표지·내지 PDF 업로드 후 POST /books/{bookUid}/finalization 명시 호출
4. 주문 생성 후 PDF_READY 상태 확인

팁: 첨부 후 "위 문서 기준으로"를 명시하면 AI가 외부 추측을 줄이고 본문 사실에 더 충실해집니다.

Claude Code (CLI)

세션 내 URL 언급으로 자동 WebFetch됩니다.

Claude Code 사용 예
# 세션 시작 후
> https://api.sweetbook.com/docs/llms-full.txt 읽고
> Sweetbook 충전금 잔액 모니터링 + 자동 충전 스크립트 작성해줘.

Codex (OpenAI)

curl로 다운로드 후 세션에 첨부합니다.

Codex 사용 예
# 1. 합본 다운로드
curl https://api-sandbox.sweetbook.com/docs/llms-full.txt > sweetbook-docs.md

# 2. Codex 세션 시작 (sweetbook-docs.md를 컨텍스트로)
codex

ChatGPT / Claude.ai 웹

URL을 채팅에 직접 붙여넣으면 도구가 자동으로 fetch합니다. 또는 다운로드한 파일을 첨부 모드로 업로드.

로컬 RAG 시스템

RAG 인덱싱 워크플로우
# 1. 다운로드
curl https://api-sandbox.sweetbook.com/docs/llms-full.txt > sweetbook.md

# 2. 페이지 단위로 분할 (--- 구분자 기준)
csplit sweetbook.md '/^---$/' '{*}'

# 3. 각 페이지를 임베딩 → 벡터 DB 인덱싱
# (구현은 사용 중인 RAG 프레임워크에 맞춰)

자주 묻는 질문

Q왜 llms.txt와 llms-full.txt를 둘 다 제공하나요?
A토큰 한도가 작은 도구나, AI가 "필요한 페이지만 골라 읽기"를 하고 싶을 때는 llms.txt(인덱스) + 페이지별 .md가 효율적입니다. 반대로 큰 작업을 한 번에 시킬 때는 llms-full.txt를 통째로 적재하면 캐시 활용도가 높아 후속 질의가 빨라집니다.
Q문서가 업데이트되면 자동으로 반영되나요?
A네. 두 산출물 모두 빌드 시점에 페이지 소스에서 자동 생성되므로, 페이지가 갱신되면 다음 배포에서 같이 반영됩니다. AI 도구는 매번 fresh URL을 fetch하므로 별도 캐시 무효화가 필요 없습니다.
Qllms.txt 표준은 어디서 확인할 수 있나요?
Allmstxt.org ↗에서 공식 표준을 확인할 수 있습니다. Resend·Stripe 등 주요 API 문서가 같은 표준을 채택하고 있습니다.

관련 문서