Skip to main content
Glama
aliyun

Alibaba Cloud Observability MCP Server

Official
by aliyun

arms_search_apps

Search ARMS applications by name to retrieve basic details such as app name, PID, user ID, and type. Useful for locating specific applications, obtaining PIDs for ARMS operations, or checking user-owned app lists.

Instructions

搜索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:
            包含应用信息的字典
        

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
app_name_queryYesapp name query
page_numberNopage number,default is 1
page_sizeNopage size,max is 100
region_idYesregion id,region id format like 'xx-xxx',like 'cn-hangzhou'
Behavior4/5

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.

Conciseness3/5

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.

Completeness4/5

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.

Parameters3/5

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.

Purpose5/5

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.

Usage Guidelines5/5

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.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/aliyun/alibabacloud-observability-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server