vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2026-04-04 09:11:34 -07:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

DOCS: MCP features, css

Browse Source 
Signed-off-by: jokob-sk <jokob.sk@gmail.com>
This commit is contained in:
jokob-sk
2026-02-01 16:39:11 +11:00
parent db8a086c42
commit d52799a49e
3 changed files with 4 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/API.md
View File

@@ -59,6 +59,10 @@ http://<server>:<GRAPHQL_PORT>/
## Endpoints ## Endpoints
> [!NOTE]
> You can explore the API endpoints by using the interactive API docs at `http://<server>:<GRAPHQL_PORT>/docs`.
> ![API docs](./img/API/API_docs.png)
> [!TIP] > [!TIP]
> When retrieving devices or settings try using the GraphQL API endpoint first as it is read-optimized. > When retrieving devices or settings try using the GraphQL API endpoint first as it is read-optimized.

14
docs/API_MCP.md
View File

@@ -31,11 +31,6 @@ graph TB
D -->|Response Data| C D -->|Response Data| C
C -->|JSON Response| B C -->|JSON Response| B
B -->|Stream Events| A B -->|Stream Events| A
style A fill:#e1f5fe
style B fill:#f3e5f5
style C fill:#fff3e0
style D fill:#e8f5e8
``` ```
### MCP Tool Integration ### MCP Tool Integration
@@ -98,15 +93,6 @@ graph LR
F --> I F --> I
G --> J G --> J
H --> I H --> I
style A fill:#e1f5fe
style B fill:#e1f5fe
style C fill:#f3e5f5
style D fill:#f3e5f5
style E fill:#f3e5f5
style F fill:#fff3e0
style G fill:#fff3e0
style H fill:#fff3e0
``` ```
--- ---

BIN
docs/img/API/API_docs.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB