Skip to main content
Glama

get_channel_format_guide

Retrieve formatting guides for notification channels to understand supported Markdown features, limitations, and best practices, ensuring properly formatted messages before sending.

Instructions

获取通知渠道的格式化策略指南

返回各渠道支持的 Markdown 特性、格式限制和最佳格式化提示词。 在调用 send_notification 之前使用此工具,可以了解目标渠道的格式要求, 从而生成最佳排版效果的消息内容。

各渠道格式差异概览:

  • 飞书:支持 粗体彩色文本、链接、--- 分割线

  • 钉钉:支持 ### 标题、粗体、> 引用、--- 分割线,不支持颜色

  • 企业微信:仅支持 粗体链接、> 引用,不支持标题和分割线

  • Telegram:自动转为 HTML,支持粗体/斜体/删除线/代码/链接/引用块

  • ntfy:支持标准 Markdown,不支持颜色

  • Bark:iOS 推送,仅支持粗体和链接,内容需精简

  • Slack:自动转为 mrkdwn,粗体删除线、<url|链接>

  • 邮件:自动转为完整 HTML 网页,支持标题/样式/分割线

  • 通用 Webhook:标准 Markdown 或自定义模板

Args: channel: 指定渠道 ID(可选),不指定返回所有渠道策略 可选值: feishu, dingtalk, wework, telegram, email, ntfy, bark, slack, generic_webhook

Returns: JSON格式的渠道格式化策略,包含支持特性、限制和格式化提示词

Examples: - get_channel_format_guide() # 获取所有渠道策略 - get_channel_format_guide(channel="feishu") # 获取飞书策略 - get_channel_format_guide(channel="telegram") # 获取 Telegram 策略

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
channelNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of transparency. It clearly states what the tool returns (supported Markdown features, format restrictions, and formatting prompts) and describes the optional channel behavior ('不指定返回所有渠道策略'). Examples illustrate expected outputs. However, it does not disclose handling of invalid channel IDs or potential errors, which is a minor gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with an intro, a bullet list of channel differences, Args/Returns sections, and examples. It front-loads the main purpose. However, the channel differences bullet list is quite verbose and repeats information the tool itself will return; while useful for deciding whether to call the tool, it could be trimmed to the most essential contrasts without losing value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is simple with one optional parameter and an output schema present (as indicated by 'has_output_schema: true'). The description provides a clear return type ('JSON格式的渠道格式化策略'), mentions the optional channel behavior, and includes two examples. This is comprehensive for the tool's complexity and leaves no major gaps for the agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema provides only a 'channel' parameter with anyOf string/null and no description. The tool description fully compensates by explaining the parameter's meaning ('指定渠道 ID', optional), default behavior ('不指定返回所有渠道策略'), and valid enum values (feishu, dingtalk, wework, telegram, email, ntfy, bark, slack, generic_webhook). This rich semantic addition is essential for correct usage.

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's purpose: '获取通知渠道的格式化策略指南' (get notification channel formatting guide). It explicitly names the resource (channel formatting strategies) and the verb (get), and distinguishes itself from sibling tools like send_notification and get_notification_channels by focusing on formatting details. The bullet list of channel-specific features further clarifies its scope.

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 instructs to '在调用 send_notification 之前使用此工具' (use this tool before calling send_notification), providing a clear when-to-use directive. It also explains the optional channel parameter and the behavior when omitted. Though it doesn't mention alternatives by name, the primary alternative (send_notification) is directly referenced, giving strong contextual guidance.

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

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/2134863176/TrendRadar'

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