doc

시그널akan
엔드포인트
3
REST API
3
웹소켓
0
MCP 도구
3
기본 URL
가드
인증

REST API

GET/listDocPagesPublicMCP
문서 목차

Akan.js 문서 페이지 전체를 제목·구획·읽기 우선순위와 함께 나열한다. 무엇이 있는지 파악할 때 먼저 쓰고, 이후 readDocPage 로 한 편을 읽는다. 찾는 것이 이미 정해져 있다면 searchDocPages 가 낫다.

readOnlyHintidempotentHint
쿼리
ArgumentTypeValuesDescription
section
구획
String
한 구획으로 좁힌다. 비우면 네 구획 전부
반환
[DocPage]!
FieldTypeValuesDescription
href
경로
String!
—문서 경로이며, readDocPage 에 넘기는 식별자
title
제목
String
—페이지 제목
section
구획
String!
docsreferencesconventionscheatsheet
네 문서 구획 중 어디에 속하는지
category
분류
String
—페이지가 속한 메뉴 그룹
priority
우선순위
String!
P0P1P2
읽는 순서 — P0 가 프레임워크를 관통하는 경로
summary
요약
String
—페이지의 첫 산문 문단
예시
[
  {
    "href": "/references/akanjs/signal",
    "title": "String",
    "section": "docs",
    "category": "String",
    "priority": "P0",
    "summary": "String"
  }
]
GET/readDocPage/:hrefPublicMCP
문서 페이지 읽기

문서 페이지 한 편을 코드 예제까지 포함한 마크다운 전문으로 반환한다. href 는 listDocPages 나 searchDocPages 가 준 값을 쓴다.

readOnlyHintidempotentHint
경로 파라미터
ArgumentTypeValuesDescription
href
경로
String!—페이지 경로. 예: /references/akanjs/signal
반환
String!
예시
"String"
GET/searchDocPages/:textPublicMCP
문서 검색

주어진 단어를 모두 포함하는 문서 페이지를 찾고, 제목 일치를 본문 언급보다 앞에 둔다. 전문이 아니라 요약을 반환하므로 이어서 readDocPage 를 쓴다.

readOnlyHintidempotentHint
경로 파라미터
ArgumentTypeValuesDescription
text
검색어
String!—찾을 단어. 모든 단어가 포함되어야 한다
쿼리
ArgumentTypeValuesDescription
limit
개수 제한
Int—반환할 페이지 수. 기본 20
반환
[DocPage]!
FieldTypeValuesDescription
href
경로
String!
—문서 경로이며, readDocPage 에 넘기는 식별자
title
제목
String
—페이지 제목
section
구획
String!
docsreferencesconventionscheatsheet
네 문서 구획 중 어디에 속하는지
category
분류
String
—페이지가 속한 메뉴 그룹
priority
우선순위
String!
P0P1P2
읽는 순서 — P0 가 프레임워크를 관통하는 경로
summary
요약
String
—페이지의 첫 산문 문단
예시
[
  {
    "href": "/references/akanjs/signal",
    "title": "String",
    "section": "docs",
    "category": "String",
    "priority": "P0",
    "summary": "String"
  }
]

웹소켓

이 시그널에는 웹소켓 엔드포인트가 없습니다.