Sign inGet Started

llms.txt i dokumentacja w Markdown

Wszystko na tej stronie dokumentacji istnieje w dwóch postaciach: jako HTML, który właśnie czytasz, i jako Markdown przygotowany do konsumpcji maszynowej. Agenty potrzebują czystego tekstu bogatego w linki, który mogą indeksować, pobierać lub wczytywać do kontekstu. Ta strona opisuje trzy formy maszynowe i ich wzajemne relacje.

Korpus

  • /llms.txt, indeks: starannie dobrany punkt wejścia do produktów, przewodników dla programistów, narzędzi i referencji czytelnych maszynowo. Stosuje konwencję llms.txt i jest na tyle mały, że mieści się w kontekście. Użyj go jako punktu startowego, gdy agent pobiera strony na żądanie.
  • /llms-full.txt, eksport angielskich przewodników: autorskie angielskie dokumenty połączone w jeden plik Markdown. Nie zawiera wygenerowanych referencji operacji API, wygenerowanych referencji SDK ani zaimportowanej dokumentacji. Użyj go, gdy zadanie wymaga szerokiego zbioru przewodników.
  • Bliźniak Markdown dla każdej strony: Każda strona jest też dostępna jako surowy Markdown, dzięki czemu agent może pobrać jedną stronę bez reszty korpusu.
Eksport przewodników i bliźniacze pliki Markdown korzystają z tych samych opublikowanych źródeł co ich strony HTML. Indeks kieruje do tych źródeł. Do konkretnego zadania przeszukaj dokumentację publicznym endpointem GET: zamień q na swoje pytanie, a następnie pobierz pasujący markdown_url. Wyszukiwanie zwraca linki do stron i sekcji oraz szacowaną liczbę tokenów strony.

Funkcja Copy page

Rzadko musisz pamiętać te adresy URL. Każda strona w sekcjach Guides, referencja API, SDK i baza wiedzy zawiera menu Copy page, które przekazuje formy maszynowe bezpośrednio do Twoich narzędzi:
  • Copy page as Markdown: Bliźniak Markdown bieżącej strony, gotowy do wklejenia do czatu lub pliku kontekstowego.
  • Otwórz llms-full.txt: kolekcja angielskich przewodników do zadań wymagających kilku przewodników naraz.
  • Copy MCP install command: Jednolinijkowe polecenie, które dodaje hostowany serwer MCP do konfiguracji Twojego klienta, dzięki czemu agent czytający stronę może też podłączyć narzędzia potrzebne do działania.
  • Connect to Cursor / Connect to VS Code: Konfiguracja MCP jednym kliknięciem dla dwóch popularnych edytorów agentowych.
Dashboard oferuje węższą wersję tego samego pomysłu. Na stronie onboardingu e-mail menu Copy for AI kopiuje bieżący przykład kodu jako gotowy do wklejenia prompt lub otwiera go bezpośrednio w Cursorze, Claude lub ChatGPT.

Referencja API nigdy nie rozjeżdża się z kodem

Sekcja referencji API jest generowana ze specyfikacji OpenAPI, która waliduje API. Jej bliźniaczy Markdown pochodzi z tego samego źródła. Sygnatury operacji i schematy znajdziesz w wygenerowanej referencji lub w publicznej specyfikacji OpenAPI. Eksport angielskich przewodników nie zawiera wygenerowanych stron operacji. Zacznij od wprowadzenia do referencji API, aby zobaczyć, jak referencja jest zorganizowana.

Strony cenowe zawierają swoje ceny

Strona cennikowa i jej bliźniaczy Markdown renderują się z tych samych danych cenowych, w tym samym żądaniu. /email-api/pricing.md zwraca plany e-mail i obie drabinki wolumenowe, /pricing/email.md siatkę planów wysyłki przy każdym wolumenie, /pricing/sms.md kartę stawek na kierunek, /pricing/voice/us.md stawki za minutę połączeń na kierunek, a /pricing/sms/fees.md opłaty operatorskie i 10DLC. Zacznij od /pricing.md: zawiera listę każdego produktu, który publikuje stawkę, jego stronę cennikową oraz adres .md, pod którym te stawki się znajdują. Stawki z katalogu rozliczeniowego są pobierane na żądanie, a nie kopiowane do pliku, więc bliźniak nie może podać ceny, która od tego czasu się zmieniła. Tabele wskazują opublikowaną walutę i jednostkę rozliczeniową. Korzystaj z waluty podanej przez źródło cennikowe.

Wybór formy

Agent ma…Przekaż mu…
Odkryć, co istnieje, i pobierać strony na żądanie/llms.txt
Przeczytać autorskie angielskie przewodniki razem/llms-full.txt
Dokładnie zrozumieć jeden tematMarkdown tej strony przez Copy page
Działać na Bird, nie tylko o nim czytaćSerwer MCP; sama dokumentacja nie wyśle e-maila
Aby przeprowadzić krok po kroku pełną konfigurację instalującą serwer MCP, podłączającą edytor i włączającą korpus, przejdź do AI onboarding.

Następne kroki

  • AI onboarding: zainstaluj serwer MCP, podłącz edytor i włącz korpus.
  • Serwer MCP: pozwól agentowi działać z Bird, a nie tylko o nim czytać.
  • Agent skills: gotowe przepływy pracy, które uczą agentów programistycznych powierzchni Bird.