doc

Signalakan
Endpoints
3
REST API
3
Web Socket
0
MCP Tools
3
Base URL
Guards
Auth

REST API

GET/listDocPagesPublicMCP
Documentation Index

Lists every Akan.js documentation page with its title, section and reading priority. Start here to find out what exists, then read one with readDocPage. Prefer searchDocPages when you already know what you are looking for.

readOnlyHintidempotentHint
Query
ArgumentTypeValuesDescription
section
Section
String
Narrows to one section; omit for all four
Returns
[DocPage]!
FieldTypeValuesDescription
href
Path
String!
—The docs route, and the identifier to pass to readDocPage
title
Title
String
—Page title
section
Section
String!
docsreferencesconventionscheatsheet
Which of the four documentation sections it belongs to
category
Category
String
—The menu group the page sits under
priority
Priority
String!
P0P1P2
Reading order — P0 is the path through the framework
summary
Summary
String
—First prose paragraph of the page
Example
[
  {
    "href": "/references/akanjs/signal",
    "title": "String",
    "section": "docs",
    "category": "String",
    "priority": "P0",
    "summary": "String"
  }
]
GET/readDocPage/:hrefPublicMCP
Read Documentation Page

Returns one documentation page in full as markdown, including its code examples. Takes the href from listDocPages or searchDocPages.

readOnlyHintidempotentHint
Path parameters
ArgumentTypeValuesDescription
href
Path
String!—The page path, such as /references/akanjs/signal
Returns
String!
Example
"String"
GET/searchDocPages/:textPublicMCP
Search Documentation

Finds documentation pages matching every word given, ranked with title matches ahead of body mentions. Returns summaries rather than full pages, so follow up with readDocPage.

readOnlyHintidempotentHint
Path parameters
ArgumentTypeValuesDescription
text
Query
String!—Words to match; every word must appear
Query
ArgumentTypeValuesDescription
limit
Limit
Int—How many pages to return, 20 by default
Returns
[DocPage]!
FieldTypeValuesDescription
href
Path
String!
—The docs route, and the identifier to pass to readDocPage
title
Title
String
—Page title
section
Section
String!
docsreferencesconventionscheatsheet
Which of the four documentation sections it belongs to
category
Category
String
—The menu group the page sits under
priority
Priority
String!
P0P1P2
Reading order — P0 is the path through the framework
summary
Summary
String
—First prose paragraph of the page
Example
[
  {
    "href": "/references/akanjs/signal",
    "title": "String",
    "section": "docs",
    "category": "String",
    "priority": "P0",
    "summary": "String"
  }
]

Web Socket

This signal declares no websocket endpoint.