Skip to content

Commit e9f252f

Browse files
SimplycheeSimplychee
committed
adding link
1 parent 2a23832 commit e9f252f

File tree

1 file changed

+41
-37
lines changed

1 file changed

+41
-37
lines changed

‎docs/open360/logzio-mcp.md‎

Lines changed: 41 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ image: https://dytvr9ot2sszz.cloudfront.net/logz-docs/social-assets/docs-social.
66
keywords: [logz.io, mcp, model context protocol, llm tools, observability, logs, metrics, prometheus, promql, dashboards, alerts, elasticsearch, ai agents, integrations]
77
---
88

9-
The Logz.io Public API MCP (Model Context Protocol) server allows LLM clients (Claude, Cursor, ChatGPT, etc.) to access observability data—logs, metrics, dashboards, and alerts, in a standardized way. With MCP, AI agents can fetch context and trigger actions without custom integrations.
9+
The Logz.io Public API MCP (Model Context Protocol) server allows LLM clients (Claude, Cursor, ChatGPT, etc.) to access observability data - logs, metrics, dashboards, and alerts, in a standardized way. With MCP, AI agents can fetch context and trigger actions without custom integrations.
1010

1111
### Prerequisites
1212

@@ -56,62 +56,62 @@ The MCP server exposes tools grouped by domain. Each tool follows the MCP reques
5656

5757
Tools for managing and retrieving account information:
5858

59-
| Tool | Description | Parameters |
60-
| ------------------------- | ----------------------------------- | ---------- |
61-
| `get_account_info` | Retrieve account name and ID for the current token. | None |
62-
| `get_associated_accounts` | List all accounts associated with the current account (including sub-accounts for owners). | None |
63-
| `get_metrics_accounts` | List all metrics accounts with details. | None |
59+
| Tool | Description | Parameters | API Link |
60+
| ------------------------- | ----------------------------------- | ---------- | ---------- |
61+
| `get_account_info` | Retrieve account name and ID for the current token. | None | [Link](https://api-docs.logz.io/docs/logz/who-am-i/) |
62+
| `get_associated_accounts` | List all accounts associated with the current account (including sub-accounts for owners). | None | |
63+
| `get_metrics_accounts` | List all metrics accounts with details. | None | [Link](https://api-docs.logz.io/docs/logz/get-a-list-of-all-metrics-accounts) |
6464

6565
### Metrics management
6666

6767
Tools for querying metrics:
6868

69-
| Tool | Description | Parameters |
70-
| ---- | ----------- | ---------- |
71-
| `query_prometheus_metrics` | Run a PromQL query at a single timestamp. | `query` (string, required), `time` (string, optional), `timeout` (string, optional) |
72-
| `query_prometheus_metrics_range` | Run a PromQL query over a time range. | `query` (string, required), `start` (string, required), `end` (string, required), `step` (string, required), `timeout` (string, optional) |
73-
| `get_available_metrics` | List available Prometheus metric names. | None |
74-
| `get_metric_labels` | List available labels for a metric. | `metric_name` (string, required) |
69+
| Tool | Description | Parameters | API Link |
70+
| ---- | ----------- | ---------- | ---------- |
71+
| `query_prometheus_metrics` | Run a PromQL query at a single timestamp. | `query` (string, required), `time` (string, optional), `timeout` (string, optional) | [Link](https://api-docs.logz.io/docs/logz/post-instant-query/) |
72+
| `query_prometheus_metrics_range` | Run a PromQL query over a time range. | `query` (string, required), `start` (string, required), `end` (string, required), `step` (string, required), `timeout` (string, optional) | [Link](https://api-docs.logz.io/docs/logz/post-range-query) |
73+
| `get_available_metrics` | List available Prometheus metric names. | None | |
74+
| `get_metric_labels` | List available labels for a metric. | `metric_name` (string, required) | [Link](https://api-docs.logz.io/docs/logz/post-series-by-labels) |
7575

7676
### Logs management
7777

7878
Tools for searching, filtering, and managing logs:
7979

80-
| Tool | Description | Parameters |
81-
| ---- | ----------- | ---------- |
82-
| `search_logs` | Search logs with Elasticsearch DSL. | `query` (object, required), `size` (int, optional), `from` (int, optional), `sort` (array, optional) |
83-
| `scroll_logs` | Scroll through large sets of log data. | `query` (object, optional), `scroll_id` (string, optional), `size` (int, optional), `scroll` (string, optional) |
84-
| `search_logs_simple` | Full-text search across all log fields. | `search_term` (string, required), `size` (int, optional), `from` (int, optional) |
85-
| `search_logs_by_timestamp` | Search logs within a specific time range. | `start_time` (string, required), `end_time` (string, required), `search_term` (string, optional), `size` (int, optional), `from` (int, optional) |
86-
| `get_log_structures` | Get the 40 most frequent log record structures. | None |
87-
| `get_all_log_types` | List all log types available. | None |
88-
| `retrieve_drop_filters` | Retrieve all configured drop filters. | None |
80+
| Tool | Description | Parameters | API Link |
81+
| ---- | ----------- | ---------- | ---------- |
82+
| `search_logs` | Search logs with Elasticsearch DSL. | `query` (object, required), `size` (int, optional), `from` (int, optional), `sort` (array, optional) | [Link](https://api-docs.logz.io/docs/logz/search) |
83+
| `scroll_logs` | Scroll through large sets of log data. | `query` (object, optional), `scroll_id` (string, optional), `size` (int, optional), `scroll` (string, optional) | [Link](https://api-docs.logz.io/docs/logz/scroll) |
84+
| `search_logs_simple` | Full-text search across all log fields. | `search_term` (string, required), `size` (int, optional), `from` (int, optional) | [Link](https://api-docs.logz.io/docs/logz/search) |
85+
| `search_logs_by_timestamp` | Search logs within a specific time range. | `start_time` (string, required), `end_time` (string, required), `search_term` (string, optional), `size` (int, optional), `from` (int, optional) | [Link](https://api-docs.logz.io/docs/logz/search) |
86+
| `get_log_structures` | Get the 40 most frequent log record structures. | None | |
87+
| `get_all_log_types` | List all log types available. | None | [Link](https://api-docs.logz.io/docs/logz/get-log-types/) |
88+
| `retrieve_drop_filters` | Retrieve all configured drop filters. | None | [Link](https://api-docs.logz.io/docs/logz/get-all-for-account) |
8989

9090
### Dashboards & folders
9191

9292
Tools for creating and managing dashboards and dashboard folders:
9393

94-
| Tool | Description | Parameters |
95-
| --- | ----------- | ---------- |
96-
| `get_all_dashboards` | List all dashboards with UIDs. | None |
97-
| `get_dashboard_by_id` | Retrieve a dashboard by UID. | `folder_id` (string, required), `uid` (string, required) |
98-
| `create_dashboard` | Create a dashboard from configuration. | `folder_id` (string, required), `dashboard_config` (object, required) |
99-
| `update_dashboard` | Update a dashboard. | `folder_id` (string, required), `uid` (string, required), `dashboard_config` (object, required) |
100-
| `move_dashboard` | Move a dashboard to a different folder. | `uid` (string, required), `target_folder_id` (string, required) |
101-
| `get_all_dashboard_folders` | List all dashboard folders. | `with_dashboards` (string, optional) |
102-
| `create_dashboard_folder` | Create a new dashboard folder. | `name` (string, required) |
103-
| `get_dashboard_schema_example` | Retrieve an example dashboard schema. | None |
94+
| Tool | Description | Parameters | API Link |
95+
| --- | ----------- | ---------- | ---------- |
96+
| `get_all_dashboards` | List all dashboards with UIDs. | None | [Link](https://api-docs.logz.io/docs/logz/get-all-dashboards) |
97+
| `get_dashboard_by_id` | Retrieve a dashboard by UID. | `folder_id` (string, required), `uid` (string, required) | [Link](https://api-docs.logz.io/docs/logz/get-dashboard-by-id) |
98+
| `create_dashboard` | Create a dashboard from configuration. | `folder_id` (string, required), `dashboard_config` (object, required) | [Link](https://api-docs.logz.io/docs/logz/create-a-new-dashboard) |
99+
| `update_dashboard` | Update a dashboard. | `folder_id` (string, required), `uid` (string, required), `dashboard_config` (object, required) | [Link](https://api-docs.logz.io/docs/logz/update-an-existing-dashboard) |
100+
| `move_dashboard` | Move a dashboard to a different folder. | `uid` (string, required), `target_folder_id` (string, required) | [Link](https://api-docs.logz.io/docs/logz/move-a-dashboard-to-a-different-folder) |
101+
| `get_all_dashboard_folders` | List all dashboard folders. | `with_dashboards` (string, optional) | [Link](https://api-docs.logz.io/docs/logz/get-all-dashboards-folders) |
102+
| `create_dashboard_folder` | Create a new dashboard folder. | `name` (string, required) | [Link](https://api-docs.logz.io/docs/logz/create-dashboards-folder) |
103+
| `get_dashboard_schema_example` | Retrieve an example dashboard schema. | None | |
104104

105105

106106
### Alerts & insights
107107

108108
Tools for alerts and insights:
109109

110-
| Tool | Description | Parameters |
111-
| ---- | ----------- | ---------- |
112-
| `get_all_alerts` | List all configured alerts. | None |
113-
| `get_triggered_alerts` | List all triggered alerts. | None |
114-
| `get_insights` | Get insights matching criteria. | `startDate` (int, optional), `endDate` (int, optional), `size` (int, optional, 1–100), `search` (string, optional)|
110+
| Tool | Description | Parameters | API Link |
111+
| ---- | ----------- | ---------- | ---------- |
112+
| `get_all_alerts` | List all configured alerts. | None | [Link](https://api-docs.logz.io/docs/logz/get-all-alerts) |
113+
| `get_triggered_alerts` | List all triggered alerts. | None | [Link](https://api-docs.logz.io/docs/logz/triggered-alerts) |
114+
| `get_insights` | Get insights matching criteria. | `startDate` (int, optional), `endDate` (int, optional), `size` (int, optional, 1–100), `search` (string, optional)| [Link](https://api-docs.logz.io/docs/logz/get-public-insights) |
115115

116116
## Best practices
117117

@@ -120,4 +120,8 @@ Tools for alerts and insights:
120120
* Start with smaller query sizes to validate setup before scaling.
121121
* Secure your tokens; do not hard-code in public repos.
122122

123-
For additional help, contact [Logz.io's Support](mailto:help@logz.io).
123+
For additional help, contact [Logz.io's Support](mailto:help@logz.io).
124+
125+
---
126+
127+
**Any use of Logz.io's MCP is subject to our [Terms of Use](https://logz.io/about-us/terms-of-use/).**

0 commit comments

Comments
 (0)