Alibaba Cloud Observability MCP Server
OfficialAlibaba Cloud Observability MCP Server (Go-Version)
📌 Wichtiger Hinweis
Dieses Projekt wurde mit der Go-Sprache neu implementiert. Wenn Sie die ursprüngliche Python-Version verwenden möchten, besuchen Sie bitte das Verzeichnis
v1:
📖 v1/README.md - Dokumentation der Python-Version
📦 Die Python-Version kann über
pip install mcp-server-aliyun-observabilityinstalliert werden
Die Go-Implementierung des Alibaba Cloud Observability MCP Servers bietet KI-Modellen Zugriff auf strukturierte Daten des Alibaba Cloud Log Service (SLS) und Cloud Monitor (CMS). Basierend auf dem Model Context Protocol lässt es sich nahtlos in KI-Tools wie Cursor, Kiro, Cline, Windsurf usw. integrieren.
Funktionen
Unterstützt drei Übertragungsmodi: stdio, SSE und streamable-http
Modulare Toolset-Architektur: PaaS (Cloud Monitor 2.0), IaaS (direkter Zugriff auf SLS/CMS), Shared
Flexible Analyse von Zeitausdrücken: relative Zeit, absolute Zeitstempel, Grafana-Stil, voreingestellte Schlüsselwörter
Analyse von Zeitreihendaten: statistische Berechnungen, Trendanalysen, Differenzbewertung
Strukturierte Fehlerbehandlung: englische Fehlerbeschreibungen und Lösungsvorschläge
Stabilitätsgarantie: Wiederholungsversuche (exponentielles Backoff), Circuit Breaker, geordnetes Herunterfahren
Strukturierte JSON-Protokollierung (slog)
Einzelne Binärdatei, keine Laufzeitabhängigkeiten
Related MCP server: aliyun-sls-mcp
Schnellstart
Download und Installation
Laden Sie die Binärdatei für die entsprechende Plattform von der Releases-Seite herunter:
# Linux amd64
wget https://github.com/aliyun/alibabacloud-observability-mcp-server/releases/latest/download/alibabacloud-observability-mcp-server-linux-amd64.tar.gz
tar -xzf alibabacloud-observability-mcp-server-linux-amd64.tar.gz
# macOS arm64 (M1/M2)
wget https://github.com/aliyun/alibabacloud-observability-mcp-server/releases/latest/download/alibabacloud-observability-mcp-server-darwin-arm64.tar.gz
tar -xzf alibabacloud-observability-mcp-server-darwin-arm64.tar.gzNach dem Entpacken sind enthalten:
alibabacloud-observability-mcp-server- Ausführbare Dateiconfig.yaml- Standardkonfigurationsdatei
Anmeldedaten konfigurieren
# 设置阿里云 AccessKey
export ALIBABA_CLOUD_ACCESS_KEY_ID=<your_access_key_id>
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<your_access_key_secret>So erhalten Sie den AccessKey: Alibaba Cloud AccessKey Management
Dienst starten
# 以 stdio 模式启动(MCP 客户端直接调用)
./alibabacloud-observability-mcp-server start --stdio
# 以网络模式启动(默认 transport 在 config.yaml 中配置)
./alibabacloud-observability-mcp-server start --config config.yamlCLI-Befehle
# 查看版本信息
./alibabacloud-observability-mcp-server version
# 列出所有已注册工具
./alibabacloud-observability-mcp-server toolsAus Quellcode erstellen
Voraussetzungen
Go 1.23+
Build
# 克隆仓库
git clone https://github.com/aliyun/alibabacloud-observability-mcp-server.git
cd alibabacloud-observability-mcp-server
# 构建当前平台
make build
# 构建所有平台(linux/darwin/windows × amd64/arm64)
make build-allDie generierte Binärdatei befindet sich im Verzeichnis bin/.
Konfiguration
Die Konfiguration verwendet eine zweistufige Struktur:
config.yaml- Serverkonfiguration (Übertragungsmodus, Protokollierung, Netzwerk usw.).env-Datei oder Umgebungsvariablen - Anmeldedaten und Laufzeitparameter
Konfigurationsdatei
cp config.yaml config.yaml.bak # 备份默认配置(可选)
cp .env.example .env # 凭证(AccessKey)Suchpfad für config.yaml: aktuelles Verzeichnis → ./config/
Die .env-Datei wird aus dem aktuellen Verzeichnis geladen und eignet sich zum Speichern von Anmeldedaten, die nicht in die Versionskontrolle eingecheckt werden sollten.
Struktur von config.yaml
# 服务器配置
server:
transport: streamable-http # stdio, sse, streamable-http
host: "0.0.0.0"
port: 8080
# 日志配置
logging:
level: info # debug, info, warn, error
debug_mode: false
# 工具集配置
toolkit:
scope: all # all, paas, iaas
# 精细化工具选择(可选,非空时仅注册列表中的工具)
# enabled_tools:
# - list_workspace
# - umodel_get_entities
# - sls_execute_sql
# 网络配置
network:
max_retry: 1
retry_wait_seconds: 1
read_timeout_ms: 610000
connect_timeout_ms: 30000
# 本地化配置
locale:
timezone: Asia/Shanghai
language: zh-CN
# 运行时默认值(可选)
# 优先级: 环境变量 > .env 文件 > config.yaml
runtime:
region: cn-hangzhou
# workspace: ""
# 端点覆盖(可选,用于内网访问)
# endpoints:
# sls:
# cn-hongkong: "cn-hongkong-intranet.log.aliyuncs.com"
# cms:
# cn-hongkong: "cms.cn-hongkong.aliyuncs.com"Feinabstimmung der Tool-Auswahl
Standardmäßig steuert toolkit.scope die Aktivierung von Tools nach Kategorie (all/paas/iaas). Wenn eine feinere Steuerung erforderlich ist, können Sie mit toolkit.enabled_tools eine Liste der zu aktivierenden Tools angeben:
toolkit:
scope: all
enabled_tools:
- list_workspace
- list_domains
- umodel_get_entities
- umodel_get_metrics
- sls_execute_sqlWenn enabled_tools nicht leer ist, werden nur die Tools in der Liste registriert, die anderen sind nicht verfügbar. scope bestimmt weiterhin, welche Toolkit-Module geladen werden; enabled_tools filtert diese zusätzlich.
Die vollständige Liste der Tools und Klassifizierungsbeschreibungen finden Sie in den Kommentarvorlagen in config.yaml.
CLI-Parameter
Parameter | Beschreibung | Standardwert |
| Pfad zur Konfigurationsdatei angeben | Automatische Suche |
| Erzwingt den stdio-Übertragungsmodus | false |
Umgebungsvariablen (Anmeldedaten und Laufzeitparameter)
Umgebungsvariable | Beschreibung | Erforderlich |
| AccessKey ID | Nein* |
| AccessKey Secret | Nein* |
| STS Token (temporäre Anmeldedaten) | Nein |
| Standardregion | Nein |
| Standard-Arbeitsbereich (für PaaS-Tools erforderlich) | Nein |
* Wenn kein AccessKey konfiguriert ist, verwendet der Dienst automatisch die Standard-Anmeldedatenkette, um Anmeldedaten abzurufen (unterstützt ECS RAM Role, OIDC, Konfigurationsdateien usw.). In Cloud-Umgebungen wie ECS oder Function Compute ist keine manuelle Konfiguration des AccessKey erforderlich.
Priorität der Anmeldedatenauflösung: CLI-Parameter / .env-Datei > Shell-Umgebungsvariablen > Standard-Anmeldedatenkette.
💡 Automatische Ausfüllung von Standardwerten
Wenn
ALIBABA_CLOUD_REGIONoderALIBABA_CLOUD_WORKSPACEfestgelegt sind, verwendet der Dienst diese Werte automatisch als Standard, falls die ParameterregionIdoderworkspacebeim Tool-Aufruf nicht angegeben wurden. Explizit übergebene Werte werden nicht überschrieben.
KI-Tool-Integration
Cursor / Kiro / Cline
streamable-http-Modus (empfohlen):
config.yamlkonfigurieren (setzen Sieserver.transport: streamable-http)Dienst starten:
./bin/alibabacloud-observability-mcp-server startmcp.jsonkonfigurieren:
{
"mcpServers": {
"alibaba_cloud_observability": {
"url": "http://localhost:8080"
}
}
}stdio-Modus:
mcp.jsonkonfigurieren:
{
"mcpServers": {
"alibaba_cloud_observability": {
"command": "./bin/alibabacloud-observability-mcp-server",
"args": ["start", "--stdio"],
"env": {
"ALIBABA_CLOUD_ACCESS_KEY_ID": "<your_access_key_id>",
"ALIBABA_CLOUD_ACCESS_KEY_SECRET": "<your_access_key_secret>"
}
}
}
}Hinweis: Im stdio-Modus werden die integrierten Standardwerte verwendet, falls config.yaml nicht existiert.
Toolsets
Insgesamt 33 Tools, unterteilt in drei Ebenen.
PaaS-Toolsets (Cloud Monitor 2.0, empfohlen)
Basierend auf einem einheitlichen Datenmodell, Toolnamen mit dem Präfix umodel_ oder cms_. Insgesamt 16 Tools.
Entitätsverwaltungstools
Tool | Beschreibung | Wichtige Parameter |
| Liste der Entitäten abrufen |
|
| Nachbarbeziehungen von Entitäten abrufen |
|
| Entitäten suchen |
|
Datensatzverwaltungstools
Tool | Beschreibung | Wichtige Parameter |
| Datensätze auflisten |
|
| Entitätensets suchen |
|
| Schema-Definition des Entitätensets abrufen |
|
| Verknüpfte Entitätensets auflisten |
|
Datenabfragetools
Tool | Beschreibung | Wichtige Parameter |
| Metrikdaten abfragen |
|
| Goldene Metriken abfragen |
|
| Beziehungsmetriken abfragen |
|
| Protokolldaten abfragen |
|
| Ereignisdaten abfragen |
|
| Trace-Daten abfragen |
|
| Traces suchen |
|
| Performance-Profiling-Daten abfragen |
|
| Datenabfrage in natürlicher Sprache |
|
IaaS-Toolsets (direkter Zugriff auf SLS/CMS)
Direkter Zugriff auf die zugrunde liegende API, Toolnamen mit dem Präfix sls_ oder cms_. Insgesamt 14 Tools.
SLS-Tools
Tool | Beschreibung | Wichtige Parameter |
| Projekte auflisten |
|
| Logstores auflisten |
|
| Natürliche Sprache zu SQL |
|
| Natürliche Sprache zu SQL (alt, kompatibel mit Python-Version) |
|
| Natürliche Sprache zu SPL |
|
| SQL-Abfrage ausführen |
|
| Native SPL-Abfrage ausführen |
|
| Protokollkontext abrufen |
|
| Protokoll-Exploration und -Analyse |
|
| Protokoll-Vergleichsanalyse |
|
| SLS-Betriebsassistent |
|
CMS-Tools
Tool | Beschreibung | Wichtige Parameter |
| PromQL-Abfrage ausführen |
|
| Natürliche Sprache zu PromQL |
|
Shared-Toolsets
Insgesamt 3 Tools.
Tool | Beschreibung | Wichtige Parameter |
| Arbeitsbereiche auflisten |
|
| Entitätsdomänen auflisten |
|
| Dienstvorstellung | Keine Parameter |
Zeitausdrücke
Alle Datenabfragetools unterstützen flexible Zeitbereichsformate:
Format | Beispiel |
Relative Voreinstellung |
|
Relative Zeit |
|
Grafana-Stil |
|
Schlüsselwörter |
|
Absolute Zeitstempel |
|
Datums-/Zeit-Strings |
|
Erweiterte Funktionen
Zeitreihen-Vergleichsanalyse
umodel_get_metrics und umodel_get_golden_metrics unterstützen Zeitreihenvergleiche über den offset-Parameter:
# 对比当前1小时与1天前的数据
umodel_get_metrics(
domain="apm", entity_set_name="apm.service",
metric_domain_name="apm.metric.apm.service", metric="request_count",
time_range="last_1h", offset="1d"
)Die Ergebnisse enthalten:
current: Statistik des aktuellen Zeitraums (max, min, avg, count)compare: Statistik des Vergleichszeitraumsdiff: Analyse der Änderungen (trend, avg_change, avg_change_percent)diff_score: Differenzbewertung (0-1, je höher, desto signifikanter der Unterschied)
Erweiterte Analysemodi
umodel_get_metrics unterstützt vier Analysemodi:
Modus | Beschreibung | Ausgabefelder |
| Rohdaten der Zeitreihe (Standard) |
|
| K-Means Zeitreihen-Clustering |
|
| Zeitreihenprognose (erfordert 1-5 Tage historische Daten) |
|
| Anomalieerkennung (erfordert 1-3 Tage Daten) |
|
Projektstruktur
├── cmd/server/ # CLI 入口(cobra)
├── pkg/
│ ├── client/ # SLS/CMS 客户端封装
│ ├── config/ # 配置管理(viper + sync.Once)
│ ├── endpoint/ # 端点解析
│ ├── errors/ # 结构化错误与错误码映射
│ ├── logger/ # 结构化日志(slog)
│ ├── server/ # MCP Server 核心(传输层、生命周期、健康检查)
│ ├── stability/ # 重试与熔断器
│ ├── timeparse/ # 时间表达式解析
│ └── toolkit/ # 工具集接口与注册中心
│ ├── paas/ # PaaS 工具集(umodel_*、cms_natural_language_query)
│ ├── iaas/ # IaaS 工具集(sls_*、cms_execute_promql、cms_text_to_promql)
│ └── shared/ # Shared 工具集(list_workspace、list_domains、introduction)
├── v1/ # Python 版本(历史参考)
├── Makefile
├── go.mod
└── go.sumEntwicklung
# 构建
make build
# 运行测试
make test
# 代码检查
make lint
# 清理构建产物
make cleanTests
Das Projekt verwendet eine Drei-Wege-Strategie: Unit-Tests + Eigenschaftstests + Regressionstests:
Unit-Tests: Tabellengesteuerte Tests, die spezifische Beispiele und Randbedingungen abdecken
Eigenschaftstests: Verwendung von gopter, um allgemeine Korrektheitseigenschaften über alle Eingaben hinweg zu verifizieren
Regressionstests: Integrationstests (
//go:build integration), Vergleich der Parameterkonsistenz mit der Python-Version, erfordert echte Alibaba Cloud-Anmeldedaten
# 运行所有单元测试
go test ./... -v
# 仅运行属性测试
go test ./... -run TestProperty_
# 运行回归测试(需要配置环境变量)
ALIBABA_CLOUD_ACCESS_KEY_ID=xxx \
ALIBABA_CLOUD_ACCESS_KEY_SECRET=xxx \
ALIBABA_CLOUD_REGION=cn-hongkong \
ALIBABA_CLOUD_WORKSPACE=xxx \
go test -tags=integration ./pkg/toolkit/... -vEntwicklungsrichtlinien für KI-Agenten
Siehe docs/AGENTS.md, enthält Erläuterungen zur Projektstruktur, Code-Stil-Konventionen, Prozess zum Hinzufügen neuer Tools, Testspezifikationen usw.
Berechtigungsanforderungen
Um sicherzustellen, dass der MCP Server erfolgreich auf Ihre Alibaba Cloud Observability-Ressourcen zugreifen und diese verwalten kann, müssen Sie die folgenden Berechtigungen konfigurieren:
Alibaba Cloud AccessKey
Der Dienst benötigt für den Betrieb gültige Alibaba Cloud-Anmeldedaten, die auf folgende Weise unterstützt werden (nach Priorität sortiert):
AccessKey ID + AccessKey Secret (über
.env-Datei, Umgebungsvariablen oder CLI-Parameter übergeben)STS temporäre Anmeldedaten (Umgebungsvariable
ALIBABA_CLOUD_SECURITY_TOKENsetzen)Automatische Erkennung der Standard-Anmeldedatenkette (ECS RAM Role, OIDC, Anmeldedaten-Konfigurationsdateien usw.)
Informationen zum Abrufen und Verwalten von AccessKeys finden Sie in der offiziellen Dokumentation zur Alibaba Cloud AccessKey-Verwaltung
RAM-Autorisierung
Dem mit dem AccessKey verknüpften RAM-Benutzer oder der Rolle muss die erforderliche Berechtigung für den Zugriff auf die relevanten Cloud-Dienste erteilt werden.
Es wird dringend empfohlen, dem "Prinzip der geringsten Rechte" zu folgen: Erteilen Sie nur die minimal erforderlichen Berechtigungen, die für die Ausführung der geplanten MCP-Tools erforderlich sind.
Konfigurieren Sie die Berechtigungen basierend auf den Tools, die Sie verwenden möchten, gemäß den folgenden Dokumenten:
Dienst | Berechtigungsdokumentation | Beschreibung |
Log Service (SLS) | Erforderlich für | |
Application Real-time Monitoring (ARMS) | Erforderlich für | |
Cloud Monitor (CMS) | Erforderlich für |
Besondere Berechtigungshinweise:
Die Verwendung von SQL-Generierungstools (wie
sls_text_to_sql) erfordert die separate Erteilung der Berechtigungsls:CallAiToolsDie Verwendung der Abfragefunktion in natürlicher Sprache (
cms_natural_language_query) erfordert die Erteilung von:cms:CreateChat,cms:CreateThread,cms:GetThread,cms:ListThreads
Sicherheitsempfehlungen
Der Dienst speichert keine AccessKeys, diese werden nur zur Laufzeit für API-Aufrufe verwendet
Stellen Sie im SSE/HTTP-Modus sicher, dass Sie die Zugriffskontrolle für die Endpunkte selbst verwalten
Es wird empfohlen, den Dienst in einem internen Netzwerk oder einer VPC bereitzustellen, um eine direkte Exposition gegenüber dem öffentlichen Internet zu vermeiden
Setzen Sie niemals einen Serverendpunkt mit konfiguriertem AccessKey ohne Authentifizierung dem öffentlichen Internet aus
Es wird empfohlen, Alibaba Cloud Function Compute (FC) für die Bereitstellung zu verwenden und den Zugriff nur innerhalb der VPC zu konfigurieren
Lizenz
Dieses Projekt unterliegt derselben Lizenzvereinbarung wie die ursprüngliche Python-Version.
Available Tools
9 toolsarms_generate_trace_queryA
生成ARMS应用的调用链查询语句。
## 功能概述
该工具用于将自然语言描述转换为ARMS调用链查询语句,便于分析应用性能和问题。
## 使用场景
- 当需要查询应用的调用链信息时
- 当需要分析应用性能问题时
- 当需要跟踪特定请求的执行路径时
- 当需要分析服务间调用关系时
## 查询处理
工具会将自然语言问题转换为SLS查询,并返回:
- 生成的SLS查询语句
- 存储调用链数据的项目名
- 存储调用链数据的日志库名
## 查询上下文
查询会考虑以下信息:
- 应用的PID
- 响应时间以纳秒存储,需转换为毫秒
- 数据以span记录存储,查询耗时需要对符合条件的span进行求和
- 服务相关信息使用serviceName字段
- 如果用户明确提出要查询 trace信息,则需要在查询问题上question 上添加说明返回trace信息
## 查询示例
- "帮我查询下 XXX 的 trace 信息"
- "分析最近一小时内响应时间超过1秒的调用链"
Args:
ctx: MCP上下文,用于访问ARMS和SLS客户端
user_id: 用户阿里云账号ID
pid: 应用的PID
region_id: 阿里云区域ID
question: 查询调用链的自然语言问题
Returns:
包含查询信息的字典,包括sls_query、project和log_store
| Name | Required | Description | Default |
|---|---|---|---|
| pid | Yes | pid,the pid of the app | |
| question | Yes | question,the question to query the trace | |
| region_id | Yes | region id,region id format like 'xx-xxx',like 'cn-hangzhou' | |
| user_id | Yes | user aliyun account id |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes what the tool does (converts natural language to SLS queries), what it returns (generated SLS query, project name, log store name), and important contextual behaviors like response time conversion from nanoseconds to milliseconds and handling of trace-specific queries. The main gap is lack of information about error conditions or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (功能概述, 使用场景, 查询处理, 查询上下文, 查询示例, Args, Returns), but it's quite verbose at approximately 400 Chinese characters. Some sections like the detailed query context could be more concise while maintaining clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 4 parameters, 100% schema coverage, but no annotations or output schema, the description provides substantial contextual information. It explains the transformation process, return format, query considerations, and includes examples. The main gap is the lack of output schema documentation, but the Returns section partially compensates for this.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all four parameters. The description's Args section restates the parameter names but doesn't add significant semantic value beyond what's in the schema. However, it does provide useful context about how 'question' parameters should be formulated with natural language queries.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the tool's purpose as '将自然语言描述转换为ARMS调用链查询语句' (converting natural language descriptions to ARMS trace query statements), which is a specific verb+resource combination. It clearly distinguishes this from sibling tools like 'sls_translate_natural_language_to_query' by focusing specifically on ARMS application trace queries rather than general SLS queries.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The '使用场景' section provides four explicit scenarios for when to use this tool, including querying trace information, analyzing performance problems, tracking specific request execution paths, and analyzing service call relationships. This gives clear guidance on appropriate usage contexts without needing to reference specific alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
arms_search_appsA
搜索ARMS应用。
## 功能概述
该工具用于根据应用名称搜索ARMS应用,返回应用的基本信息,包括应用名称、PID、用户ID和类型。
## 使用场景
- 当需要查找特定名称的应用时
- 当需要获取应用的PID以便进行其他ARMS操作时
- 当需要检查用户拥有的应用列表时
## 搜索条件
- app_name_query必须是应用名称的一部分,而非自然语言
- 搜索结果将分页返回,可以指定页码和每页大小
## 返回数据结构
返回一个字典,包含以下信息:
- total: 符合条件的应用总数
- page_size: 每页大小
- page_number: 当前页码
- trace_apps: 应用列表,每个应用包含app_name、pid、user_id和type
## 查询示例
- "帮我查询下 XXX 的应用"
- "找出名称包含'service'的应用"
Args:
ctx: MCP上下文,用于访问ARMS客户端
app_name_query: 应用名称查询字符串
region_id: 阿里云区域ID
page_size: 每页大小,范围1-100,默认20
page_number: 页码,默认1
Returns:
包含应用信息的字典
| Name | Required | Description | Default |
|---|---|---|---|
| app_name_query | Yes | app name query | |
| page_number | No | page number,default is 1 | |
| page_size | No | page size,max is 100 | |
| region_id | Yes | region id,region id format like 'xx-xxx',like 'cn-hangzhou' |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full behavioral disclosure burden. It effectively describes the search functionality, pagination behavior (page_size range 1-100, defaults), and return data structure. It could improve by mentioning authentication requirements or rate limits, but covers core behavioral aspects well.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (功能概述, 使用场景, etc.), but contains some redundancy. The Args/Returns section repeats information already covered in the 返回数据结构 section, and the 查询示例 section adds minimal practical value, making the description longer than necessary.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a search tool with 4 parameters and no output schema, the description provides comprehensive context including purpose, usage scenarios, search constraints, pagination behavior, and detailed return data structure. The main gap is lack of authentication/rate limit information, but otherwise covers most essential aspects.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, providing solid parameter documentation. The description adds some value by explaining app_name_query must be part of app name (not natural language) and providing region_id format examples ('cn-hangzhou'), but doesn't significantly enhance understanding beyond what the schema already documents.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool searches for ARMS applications by name and returns basic information including app name, PID, user ID, and type. It uses specific verbs ('搜索ARMS应用', '根据应用名称搜索') and distinguishes itself from sibling tools by focusing on ARMS applications rather than SLS operations or trace queries.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly provides three usage scenarios: when needing to find apps by specific name, when needing PIDs for other ARMS operations, and when checking user-owned app lists. It also includes search condition guidance (app_name_query must be part of app name, not natural language) and pagination instructions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sls_describe_logstoreA
获取SLS日志库的结构信息。
## 功能概述
该工具用于获取指定SLS项目中日志库的索引信息和结构定义,包括字段类型、别名、是否大小写敏感等信息。
## 使用场景
- 当需要了解日志库的字段结构时
- 当需要获取日志库的索引配置信息时
- 当构建查询语句前需要了解可用字段时
- 当需要分析日志数据结构时
## 返回数据结构
返回一个字典,键为字段名,值包含以下信息:
- alias: 字段别名
- sensitive: 是否大小写敏感
- type: 字段类型
- json_keys: JSON字段的子字段信息
## 查询示例
- "我想查询 XXX 的日志库的 schema"
- "我想查询 XXX 的日志库的 index"
- "我想查询 XXX 的日志库的结构信息"
Args:
ctx: MCP上下文,用于访问SLS客户端
project: SLS项目名称,必须精确匹配
log_store: SLS日志库名称,必须精确匹配
region_id: 阿里云区域ID
Returns:
包含日志库结构信息的字典
| Name | Required | Description | Default |
|---|---|---|---|
| log_store | Yes | sls log store name,must exact match,not fuzzy search | |
| project | Yes | sls project name,must exact match,not fuzzy search | |
| region_id | Yes | aliyun region id,region id format like 'xx-xxx',like 'cn-hangzhou' |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It effectively discloses behavioral traits: it describes the return data structure in detail ('返回数据结构' section), including keys like alias, sensitive, type, and json_keys. It also specifies that parameters '必须精确匹配' (must exact match) and provides query examples. However, it doesn't mention potential errors, rate limits, or authentication needs, which are gaps for a tool with no annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is structured with sections (功能概述, 使用场景, 返回数据结构, 查询示例, Args, Returns), which aids readability. However, it includes redundant elements: the Args and Returns sections largely repeat information from the schema and return structure description, and the query examples are somewhat verbose. While not overly long, it could be more front-loaded and efficient, with some sentences not earning their place fully.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's moderate complexity (3 parameters, no output schema, no annotations), the description is fairly complete. It covers purpose, usage scenarios, return data structure, and parameter basics. The lack of output schema is mitigated by the detailed return structure explanation. However, it misses some contextual details like error handling or dependencies, which would enhance completeness for a tool with no annotations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all three parameters with descriptions (e.g., 'must exact match, not fuzzy search'). The description adds minimal value beyond the schema: it repeats the exact match requirement in Chinese and lists parameters in the Args section without additional semantics. This meets the baseline of 3, as the schema does the heavy lifting, but the description doesn't compensate with extra insights like format examples or constraints.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: '获取SLS日志库的结构信息' (Get SLS log store structure information) and elaborates with '获取指定SLS项目中日志库的索引信息和结构定义' (Get index information and structure definition of a specified SLS project's log store). It specifies the verb '获取' (get) and resource 'SLS日志库的结构信息' (SLS log store structure information). However, it doesn't explicitly differentiate from sibling tools like 'sls_list_logstores' or 'sls_execute_query', which reduces clarity slightly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear usage scenarios in a '使用场景' (Usage scenarios) section, listing four specific cases (e.g., '当需要了解日志库的字段结构时' - When needing to understand the field structure of a log store). It implicitly distinguishes from siblings by focusing on structure retrieval rather than listing or querying. However, it lacks explicit when-not-to-use guidance or named alternatives, such as contrasting with 'sls_execute_query' for actual data queries.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sls_diagnose_queryA
诊断SLS查询语句。
## 功能概述
当 SLS 查询语句执行失败时,可以调用该工具,根据错误信息,生成诊断结果。诊断结果会包含查询语句的正确性、性能分析、优化建议等信息。
## 使用场景
- 当需要诊断SLS查询语句的正确性时
- 当 SQL 执行错误需要查找原因时
## 查询示例
- "帮我诊断下 XXX 的日志查询语句"
- "帮我分析下 XXX 的日志查询语句"
Args:
ctx: MCP上下文,用于访问SLS客户端
query: SLS查询语句
error_message: 错误信息
project: SLS项目名称
log_store: SLS日志库名称
region_id: 阿里云区域ID
| Name | Required | Description | Default |
|---|---|---|---|
| error_message | Yes | error message | |
| log_store | Yes | sls log store name | |
| project | Yes | sls project name | |
| query | Yes | sls query | |
| region_id | Yes | aliyun region id,region id format like 'xx-xxx',like 'cn-hangzhou' |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It describes the tool's function (diagnosing failed queries) and output (diagnostic results with correctness, performance analysis, optimization suggestions), which is adequate for a read-only diagnostic tool. However, it lacks details about authentication requirements, rate limits, error handling, or response format specifics, leaving gaps in behavioral understanding.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (功能概述, 使用场景, 查询示例, Args), making it easy to scan. However, the query examples are somewhat redundant ('帮我诊断下 XXX 的日志查询语句' and '帮我分析下 XXX 的日志查询语句' are very similar), and the Args section could be more integrated with the functional explanation. Overall, it's appropriately sized but has minor inefficiencies.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a diagnostic tool with 5 required parameters and no output schema, the description adequately covers purpose and usage but lacks details on output format, error cases, or dependencies. Without annotations, it should provide more behavioral context (e.g., what the diagnostic results look like, whether it modifies data). The absence of an output schema increases the need for description completeness, which is only partially met.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, providing basic descriptions for all 5 parameters. The description lists parameters in an Args section but only repeats their names without adding meaningful semantics beyond the schema. It implies that 'error_message' is used for diagnosis and 'query' is the SLS statement to analyze, but this is already evident from parameter names and schema descriptions. The baseline score of 3 reflects adequate but minimal added value.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: '诊断SLS查询语句' (diagnose SLS query statements) when they fail, generating diagnostic results including correctness, performance analysis, and optimization suggestions. It specifies the verb ('诊断' - diagnose) and resource ('SLS查询语句' - SLS query statements), distinguishing it from siblings like sls_execute_query (executes queries) and sls_translate_natural_language_to_query (translates natural language to queries).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool: '当 SLS 查询语句执行失败时' (when SLS query statements fail to execute) and provides specific usage scenarios like diagnosing query correctness or finding causes of SQL execution errors. It implicitly distinguishes from siblings by focusing on failure diagnosis rather than execution, translation, or listing operations.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sls_execute_queryB
执行SLS日志查询。
## 功能概述
该工具用于在指定的SLS项目和日志库上执行查询语句,并返回查询结果。查询将在指定的时间范围内执行。
## 使用场景
- 当需要根据特定条件查询日志数据时
- 当需要分析特定时间范围内的日志信息时
- 当需要检索日志中的特定事件或错误时
- 当需要统计日志数据的聚合信息时
## 查询语法
查询必须使用SLS有效的查询语法,而非自然语言。如果不了解日志库的结构,可以先使用sls_describe_logstore工具获取索引信息。
## 时间范围
查询必须指定时间范围:
- from_timestamp: 开始时间戳(秒)
- to_timestamp: 结束时间戳(秒)
## 查询示例
- "帮我查询下 XXX 的日志信息"
- "查找最近一小时内的错误日志"
## 错误处理
- Column xxx can not be resolved 如果是 sls_translate_natural_language_to_query 工具生成的查询语句 可能存在查询列未开启统计,可以提示用户增加相对应的信息,或者调用 sls_describe_logstore 工具获取索引信息之后,要用户选择正确的字段或者提示用户对列开启统计。当确定列开启统计之后,可以再次调用sls_translate_natural_language_to_query 工具生成查询语句
Args:
ctx: MCP上下文,用于访问SLS客户端
project: SLS项目名称
log_store: SLS日志库名称
query: SLS查询语句
from_timestamp: 查询开始时间戳(秒)
to_timestamp: 查询结束时间戳(秒)
limit: 返回结果的最大数量,范围1-100,默认10
region_id: 阿里云区域ID
Returns:
查询结果列表,每个元素为一条日志记录
| Name | Required | Description | Default |
|---|---|---|---|
| from_timestamp | Yes | from timestamp,unit is second | |
| limit | No | limit,max is 100 | |
| log_store | Yes | sls log store name | |
| project | Yes | sls project name | |
| query | Yes | query | |
| region_id | Yes | aliyun region id,region id format like 'xx-xxx',like 'cn-hangzhou' | |
| to_timestamp | Yes | to timestamp,unit is second |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden. It discloses that queries must use SLS syntax (not natural language), specifies required time range parameters, mentions error handling scenarios, and indicates results are returned as a list of log records. However, it doesn't cover important behavioral aspects like authentication requirements, rate limits, pagination behavior, or what happens with malformed queries beyond the specific error example.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is excessively long with redundant sections. The 'Args' and 'Returns' sections duplicate information that should be in the schema. The query examples are in natural language despite explicitly stating queries must use SLS syntax, creating confusion. The error handling section is overly specific to one sibling tool interaction. Much of this content could be streamlined or moved to structured documentation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 7-parameter query execution tool with no annotations and no output schema, the description provides adequate functional coverage but lacks important operational context. It explains what the tool does and when to use it, but doesn't sufficiently cover error patterns beyond one example, performance characteristics, or result format details. The description compensates somewhat for the lack of structured metadata but leaves gaps in behavioral transparency.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all 7 parameters thoroughly. The description adds minimal value beyond the schema - it mentions time range requirements and provides an example limit value, but doesn't explain parameter interactions, constraints beyond what's in the schema, or the significance of region_id selection. The baseline 3 is appropriate when the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool 'executes SLS log queries' with specific resources (SLS project and log store) and mentions returning query results. It distinguishes from siblings like sls_describe_logstore and sls_translate_natural_language_to_query by focusing on query execution rather than metadata or translation. However, it doesn't explicitly contrast with sls_diagnose_query which might have overlapping functionality.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The '使用场景' section provides clear context for when to use this tool (querying logs with specific conditions, time ranges, events, or aggregations). It explicitly references sibling tools sls_describe_logstore and sls_translate_natural_language_to_query for prerequisite steps. However, it doesn't explicitly state when NOT to use this tool or provide clear alternatives among siblings like sls_diagnose_query.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sls_get_current_timeA
获取当前时间信息。
## 功能概述
该工具用于获取当前的时间戳和格式化的时间字符串,便于在执行SLS查询时指定时间范围。
## 使用场景
- 当需要获取当前时间以设置查询的结束时间
- 当需要获取当前时间戳进行时间计算
- 在构建查询时间范围时使用当前时间作为参考点
## 返回数据格式
返回包含两个字段的字典:
- current_time: 格式化的时间字符串 (YYYY-MM-DD HH:MM:SS)
- current_timestamp: 整数形式的Unix时间戳(秒)
Args:
ctx: MCP上下文
Returns:
包含当前时间信息的字典
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden and does well by disclosing the return format (dictionary with current_time and current_timestamp fields), data formats (YYYY-MM-DD HH:MM:SS string and Unix timestamp in seconds), and context about SLS query usage. It doesn't mention performance characteristics or error conditions, but provides substantial behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (功能概述, 使用场景, 返回数据格式) and efficiently communicates essential information. While slightly verbose due to the section headers, every sentence adds value and the information is appropriately front-loaded with the core purpose first.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter tool with no annotations and no output schema, the description provides complete context: clear purpose, specific usage scenarios, detailed return format with field descriptions and data types. This gives the agent everything needed to understand when and how to use this tool effectively.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has 0 parameters with 100% schema description coverage, so the baseline would be 4. The description correctly notes 'Args: ctx: MCP上下文' which acknowledges the context parameter, though this is standard for MCP tools. It adds no additional parameter semantics beyond what's implied by having no parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: '获取当前时间信息' (get current time information). It specifies the exact resource (timestamp and formatted time string) and distinguishes it from sibling tools like sls_execute_query or sls_describe_logstore by focusing solely on time retrieval rather than query execution or metadata inspection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The '使用场景' (usage scenarios) section explicitly lists three specific situations when to use this tool: setting query end times, performing timestamp calculations, and using current time as a reference point for query time ranges. This provides clear guidance on when this tool is appropriate versus alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sls_list_logstoresA
列出SLS项目中的日志库。
## 功能概述
该工具可以列出指定SLS项目中的所有日志库,如果不选,则默认为日志库类型
支持通过日志库名称进行模糊搜索。如果不提供日志库名称,则返回项目中的所有日志库。
## 使用场景
- 当需要查找特定项目下是否存在某个日志库时
- 当需要获取项目中所有可用的日志库列表时
- 当需要根据日志库名称的部分内容查找相关日志库时
## 是否指标库
如果需要查找指标或者时序相关的库,请将is_metric_store参数设置为True
## 查询示例
- "我想查询有没有 XXX 的日志库"
- "某个 project 有哪些 log store"
Args:
ctx: MCP上下文,用于访问SLS客户端
project: SLS项目名称,必须精确匹配
log_store: 日志库名称,支持模糊搜索
limit: 返回结果的最大数量,范围1-100,默认10
is_metric_store: 是否指标库,可选值为True或False,默认为False
region_id: 阿里云区域ID
Returns:
日志库名称的字符串列表
| Name | Required | Description | Default |
|---|---|---|---|
| is_metric_store | No | is metric store,default is False,only use want to find metric store | |
| limit | No | limit,max is 100 | |
| log_store | No | log store name,fuzzy search | |
| log_store_type | No | log store type,default is logs,should be logs,metrics | |
| project | Yes | sls project name,must exact match | |
| region_id | Yes | aliyun region id,region id format like 'xx-xxx',like 'cn-hangzhou' |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key behaviors: the tool lists log stores with fuzzy search capabilities, defaults to log store type if unspecified, supports pagination via limit (range 1-100), and distinguishes between log and metric stores. It doesn't mention rate limits, authentication needs, or error handling, but covers core operational traits well.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (功能概述, 使用场景, etc.), but it includes redundant information. The Args and Returns sections repeat what's in the schema, and the query examples add little practical value. While not overly verbose, some content doesn't earn its place, reducing efficiency.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 6 parameters, no annotations, and no output schema, the description does a good job. It explains the tool's purpose, usage, and key behaviors, and the schema covers parameter details. The main gap is the lack of output format explanation beyond '日志库名称的字符串列表' (list of log store names), but given the tool's simplicity, this is sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description adds minimal value beyond the schema: it mentions fuzzy search for log_store and clarifies is_metric_store usage in a dedicated section. However, it doesn't provide additional context like examples for region_id format or interactions between parameters. Baseline 3 is appropriate given the schema does most of the work.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: '列出SLS项目中的日志库' (list log stores in SLS projects). It specifies the exact action (list) and resource (log stores), and distinguishes it from siblings like sls_describe_logstore (which describes a single log store) and sls_list_projects (which lists projects). The functional overview reinforces this with details about fuzzy search and default behavior.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit usage scenarios: finding if a specific log store exists, getting all available log stores, or searching by partial name. It also includes a dedicated section '是否指标库' (Is it a metric store) that explicitly guides when to set is_metric_store to True versus False, offering clear alternatives for different data types.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sls_list_projectsA
列出阿里云日志服务中的所有项目。
## 功能概述
该工具可以列出指定区域中的所有SLS项目,支持通过项目名进行模糊搜索。如果不提供项目名称,则返回该区域的所有项目。
## 使用场景
- 当需要查找特定项目是否存在时
- 当需要获取某个区域下所有可用的SLS项目列表时
- 当需要根据项目名称的部分内容查找相关项目时
## 返回数据结构
返回的项目信息包含:
- project_name: 项目名称
- description: 项目描述
- region_id: 项目所在区域
## 查询示例
- "有没有叫 XXX 的 project"
- "列出所有SLS项目"
Args:
ctx: MCP上下文,用于访问SLS客户端
project_name_query: 项目名称查询字符串,支持模糊搜索
limit: 返回结果的最大数量,范围1-100,默认10
region_id: 阿里云区域ID,region id format like "xx-xxx",like "cn-hangzhou"
Returns:
包含项目信息的字典列表,每个字典包含project_name、description和region_id
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | limit,max is 100 | |
| project_name_query | No | project name,fuzzy search | |
| region_id | Yes | aliyun region id |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden. It discloses key behavioral traits: it's a read-only listing operation (implied by '列出'), supports fuzzy search ('模糊搜索'), has a default limit of 10 with range 1-100, and requires region_id. However, it doesn't mention rate limits, authentication needs, or pagination behavior, leaving some gaps for a tool with no annotation coverage.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is structured with clear sections (功能概述, 使用场景, etc.), but it's verbose with redundant information. For example, the '返回数据结构' section repeats what's in the Returns docstring, and the '查询示例' adds little operational value. Some sentences don't earn their place, making it less concise than ideal.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no annotations and no output schema, the description does a good job covering the tool's purpose, usage, parameters, and return format. It explains what the tool does, when to use it, and what data it returns. However, it lacks details on error handling, authentication, or rate limits, which would be helpful for a cloud service tool with no structured metadata.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all three parameters well. The description adds minimal value beyond the schema: it reiterates that project_name_query supports fuzzy search and that region_id is required, but doesn't provide additional context like format examples beyond 'xx-xxx' or practical usage tips. Baseline 3 is appropriate when schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the specific verb ('列出' - list) and resource ('阿里云日志服务中的所有项目' - all projects in Alibaba Cloud Log Service). It distinguishes from siblings like sls_list_logstores (which lists logstores within projects) by focusing on projects rather than logstores, making the scope unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The '使用场景' section explicitly provides three scenarios for when to use this tool: checking if a specific project exists, getting all SLS projects in a region, and searching by partial project name. It also mentions '如果不提供项目名称,则返回该区域的所有项目' (if no project name is provided, returns all projects in the region), clarifying the default behavior.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sls_translate_natural_language_to_queryA
将自然语言转换为SLS查询语句。
## 功能概述
该工具可以将自然语言描述转换为有效的SLS查询语句,便于用户使用自然语言表达查询需求。
## 使用场景
- 当用户不熟悉SLS查询语法时
- 当需要快速构建复杂查询时
- 当需要从自然语言描述中提取查询意图时
## 使用限制
- 仅支持生成SLS查询,不支持其他数据库的SQL如MySQL、PostgreSQL等
- 生成的是查询语句,而非查询结果,需要配合sls_execute_query工具使用
- 如果查询涉及ARMS应用,应优先使用arms_generate_trace_query工具
- 需要对应的 log_sotre 已经设定了索引信息,如果生成的结果里面有字段没有索引或者开启统计,可能会导致查询失败,需要友好的提示用户增加相对应的索引信息
## 最佳实践
- 提供清晰简洁的自然语言描述
- 不要在描述中包含项目或日志库名称
- 如有需要,指定查询的时间范围
- 首次生成的查询可能不完全符合要求,可能需要多次尝试
## 查询示例
- "帮我生成下 XXX 的日志查询语句"
- "查找最近一小时内的错误日志"
Args:
ctx: MCP上下文,用于访问SLS客户端
text: 用于生成查询的自然语言文本
project: SLS项目名称
log_store: SLS日志库名称
region_id: 阿里云区域ID
Returns:
生成的SLS查询语句
| Name | Required | Description | Default |
|---|---|---|---|
| log_store | Yes | sls log store name | |
| project | Yes | sls project name | |
| region_id | Yes | aliyun region id,region id format like 'xx-xxx',like 'cn-hangzhou' | |
| text | Yes | the natural language text to generate sls log store query |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden and does an excellent job disclosing behavioral traits. It explains: '生成的是查询语句,而非查询结果' (generates query statements, not query results), '需要对应的 log_store 已经设定了索引信息' (requires log_store to have index settings), '可能会导致查询失败' (may cause query failure), and '首次生成的查询可能不完全符合要求' (first generated query may not fully meet requirements). This covers limitations, prerequisites, and expected behavior beyond basic functionality.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with clear sections (功能概述, 使用场景, 使用限制, 最佳实践, 查询示例, Args, Returns) and appropriately sized. While comprehensive, some sections like the detailed usage restrictions could be slightly more concise. Every sentence earns its place by providing valuable guidance, but there's minor room for tightening.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (natural language to query translation with multiple parameters and behavioral constraints) and the absence of both annotations and output schema, the description provides complete context. It covers purpose, usage scenarios, limitations, best practices, examples, parameters, and return values. The description fully compensates for the lack of structured metadata.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3 even though the description doesn't add parameter details beyond what's in the schema. The Args section in the description merely lists parameters (text, project, log_store, region_id) without providing additional semantic context beyond what the schema already documents with its descriptions. The description adds value through usage context but not parameter semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: '将自然语言转换为SLS查询语句' (translate natural language to SLS query statements). It specifies both the verb (convert/translate) and resource (natural language to SLS queries), and distinguishes it from sibling tools like sls_execute_query (which executes queries) and arms_generate_trace_query (for ARMS applications).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit guidance on when to use this tool vs alternatives. It states: '当用户不熟悉SLS查询语法时' (when users are unfamiliar with SLS query syntax), '需要配合sls_execute_query工具使用' (needs to be used with sls_execute_query tool), and '如果查询涉及ARMS应用,应优先使用arms_generate_trace_query工具' (if the query involves ARMS applications, prioritize using arms_generate_trace_query tool). This clearly defines usage context and exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
9 tool updates
v1.0.0- First observed
arms_generate_trace_query - First observed
arms_search_apps - First observed
sls_describe_logstore - First observed
sls_diagnose_query - First observed
sls_execute_query - First observed
sls_get_current_time - First observed
sls_list_logstores - First observed
sls_list_projects - First observed
sls_translate_natural_language_to_query
TDQS
Scored across 9 tools
Each tool has a clearly distinct purpose with no overlap. The tools are organized into two main categories: ARMS application monitoring tools (arms_generate_trace_query, arms_search_apps) and SLS log service tools (the remaining seven), with each addressing specific operations like query generation, search, description, diagnosis, execution, time retrieval, listing, and translation. The descriptions clearly differentiate their functions, preventing misselection.
Tool names follow a highly consistent pattern throughout. All names use snake_case and a clear prefix-action-resource structure (e.g., arms_search_apps, sls_execute_query). The prefixes 'arms_' and 'sls_' denote the service domain, followed by a verb (e.g., generate, search, describe, diagnose) and a noun (e.g., trace_query, apps, logstore), making the set predictable and readable.
With 9 tools, the count is well-scoped for an observability server covering ARMS and SLS services. Each tool earns its place by addressing core operations like listing resources, executing queries, generating queries from natural language, and diagnosing issues. This provides comprehensive coverage without being overwhelming or too sparse for the domain.
The tool set offers complete coverage for the observability domain, including CRUD-like operations for logs and traces. It supports listing projects and logstores, describing structures, executing and diagnosing queries, translating natural language, and managing ARMS applications. There are no obvious gaps; tools like sls_get_current_time and sls_diagnose_query add utility for time handling and error analysis, ensuring agents can handle full workflows without dead ends.
Maintenance
Related MCP Connectors
- SpanlyOAuthcom.spanly
MCP observability. Query live traffic, errors, duration, and alerts from your AI agent.
Read-only MCP tools for AI agent discovery, structured resources, and NIULAI information.
Your org's AI agents, tasks, runs, search, and brain files as MCP tools and resources.
Pay-per-use tool marketplace for AI agents. Search, price-check, and call APIs via MCP.
Related MCP Servers
- AlicenseCqualityAmaintenanceEnables AI assistants to interact with Alibaba Cloud Yunxiao DevOps platform for managing projects, code repositories, work items, pipelines, deployments, and testing workflows through comprehensive organization, development, and delivery tools.81828 npm175Apache 2.0
- AlicenseAqualityDmaintenanceEnables AI assistants to query and analyze Alibaba Cloud SLS logs using natural language, supporting multiple log sources like Function Compute and ECS. It provides tools for searching logs, performing SQL analysis, and visualizing log distributions directly within Cursor or Claude.643 npm11MIT
- AlicenseAqualityDmaintenanceProvides a suite of 33 tools for interacting with Tencent Cloud Log Service (CLS), enabling log analysis, PromQL metrics queries, and resource management. It allows AI assistants to perform CQL/SQL retrieval, manage alarm strategies, and handle data processing tasks with tiered permission controls.246Apache 2.0
- FlicenseCqualityDmaintenanceEnables AI assistants to manage Alibaba Cloud resources via natural language, with explicit tools for common services and a universal API invoker for full cloud coverage.92-