Skip to main content
Glama
kesslerio

YOURLS-MCP

by kesslerio

YOURLS-MCP

用于集成 YOURLS URL 缩短与 Claude Desktop 的模型控制协议 (MCP) 服务器。

**作者:**马丁·凯斯勒

概述

YOURLS-MCP 在Claude 桌面和您自托管的YOURLS网址缩短服务实例之间搭建了一座桥梁。配置完成后,Claude 可以使用您个人的 YOURLS 安装自动缩短网址。

Related MCP server: NotePlan MCP Server

特征

  • 使用 YOURLS 实例缩短 URL

  • 使用特定关键字创建自定义短网址

  • **重复 URL 处理:**为同一目标 URL 创建多个短 URL(YOURLS-MCP 独有)

  • 扩展的 URL 信息和统计信息

  • 数据库统计信息

  • 插件的智能回退

  • 全面的文档和测试工具

快速入门

安装

# Clone the repository
git clone https://github.com/kesslerio/yourls-mcp.git
cd yourls-mcp

# Install dependencies
npm install

配置

创建指向您的 YOURLS-MCP 安装的 Claude Desktop 配置文件:

{
  "mcpServers": {
    "yourls": {
      "command": "node",
      "args": [
        "/full/path/to/yourls-mcp/yourls-mcp.js"
      ],
      "env": {
        "YOURLS_API_URL": "https://your-yourls-domain.com/yourls-api.php",
        "YOURLS_AUTH_METHOD": "signature", 
        "YOURLS_SIGNATURE_TOKEN": "your-secret-signature-token"
      }
    }
  }
}

将此文件保存到您的 Claude Desktop 配置目录,通常是:

  • macOS: ~/Library/Application Support/Claude/config.json

  • Windows: %APPDATA%\Claude\config.json

  • Linux: ~/.config/Claude/config.json

特征

  • 通过 MCP 与 Claude Desktop 无缝集成

  • 直接通过 Claude 缩短 URL

  • 展开缩短的 URL 以查看其目标

  • 检索链接的点击统计信息

  • 自定义关键字支持

  • 基于签名的安全身份验证

  • 环境变量配置

配置选项

可以在 Claude Desktop 配置中设置以下环境变量:

多变的

描述

默认

必需的

YOURLS_API_URL

您的 YOURLS API 端点的 URL

-

是的

YOURLS_AUTH_METHOD

认证方式( signaturepassword

signature

YOURLS_SIGNATURE_TOKEN

基于签名的身份验证的秘密令牌

-

是(如果使用签名授权)

YOURLS_USERNAME

基于密码的身份验证的用户名

-

是(如果使用密码验证)

YOURLS_PASSWORD

基于密码的身份验证的密码

-

是(如果使用密码验证)

YOURLS_SIGNATURE_TTL

签名的生存时间以秒为单位

43200(12小时)

可用的 MCP 工具

YOURLS-MCP 为 Claude 提供了以下工具:

核心工具

1. 缩短网址

使用您的 YOURLS 实例缩短长 URL。

参数:

  • url (必填):需要缩短的长 URL

  • keyword (可选):短网址的自定义关键字

  • title (可选):URL 的标题

2. expand_url

将短 URL 扩展为原始长 URL。

参数:

  • shorturl (必填):需要扩展的短网址或关键字

3. url_stats

获取缩短的 URL 的统计信息。

参数:

  • shorturl (必填):获取统计数据的短网址或关键字

4. db_stats

获取您的 YOURLS 实例的全局统计信息。

**参数:**

5. 创建自定义 URL

使用特定关键字创建自定义短 URL,即使对于数据库中已经存在的 URL 也是如此。

参数:

  • url (必填):需要缩短的目标 URL

  • keyword (必需):短 URL 的自定义关键字(例如,bysha.pe/web 的关键字为“web”)

  • title (可选):URL 的标题

  • bypass_shortshort (可选):是否绕过阻止缩短已缩短 URL 的 ShortShort 插件(默认值:false)

  • force_url_modification (可选):是否强制使用 URL 修改方法为同一目的地创建多个短 URL(默认值:false)

6. 使用分析缩短

使用 Google Analytics UTM 参数缩短长 URL。

参数:

  • url (必填):需要缩短的 URL

  • source (必需):UTM 源参数 - 标识流量来源(例如“google”、“newsletter”、“twitter”)

  • medium (必需):UTM 媒介参数 - 标识营销媒介(例如“cpc”、“社交”、“电子邮件”)

  • campaign (必需):UTM 活动参数 - 标识特定活动(例如“summer_sale”、“product_launch”)

  • term (可选):UTM 术语参数 - 标识付费搜索术语

  • content (可选):UTM 内容参数 - 区分指向同一 URL 的广告或链接

  • keyword (可选):短网址的自定义关键字

  • title (可选):URL 的标题

基于插件的工具

7. url_analytics

获取指定日期范围内短网址的详细点击分析数据。需要安装 API ShortURL Analytics 插件。

参数:

  • shorturl (必填):用于获取分析的短 URL 或关键字

  • date (必填):分析的开始日期,格式为 YYYY-MM-DD

  • date_end (可选):分析的结束日期,格式为 YYYY-MM-DD(如果未提供,则默认为开始日期)

8. contract_url

检查 URL 是否已被缩短,无需创建新的短 URL。需要安装 API Contract 插件。

参数:

  • url (必填):用于检查是否已缩短的 URL

9. 更新网址

更新现有的短网址,使其指向其他目标网址。需要安装 API 编辑网址插件。

参数:

  • shorturl (必填):需要更新的短网址或关键字

  • url (必填):新的目标网址

  • title (可选):可选的新标题(“keep”表示保留现有标题,“auto”表示从 URL 获取)

10. 更改关键字

更改现有短网址的关键字。需要安装 API Edit URL 插件。

参数:

  • oldshorturl (必填):现有的短网址或关键词

  • newshorturl (必需):要使用的新关键字

  • url (可选):可选 URL(如果未提供,则将使用 oldshorturl 中的 URL)

  • title (可选):可选的新标题(“keep”表示保留现有标题,“auto”表示从 URL 获取)

11. 获取 URL 关键字

获取长 URL 的关键字。需要安装 API Edit URL 插件。

参数:

  • url (必填):需要查找的长 URL

  • exactly_one (可选):如果为 false,则返回此 URL 的所有关键字(默认值:true)

12. 删除网址

删除短网址。需要安装 API Delete 插件。

参数:

  • shorturl (必填):需要删除的短网址或关键字

13. 列表网址

获取包含排序、分页和筛选选项的 URL 列表。需要安装 API List Extended 插件。

参数:

  • sortby (可选):排序依据的字段(关键字、url、标题、ip、时间戳、点击次数)(默认值:时间戳)

  • sortorder (可选):排序顺序(ASC 或 DESC)(默认:DESC)

  • offset (可选):分页偏移量(默认值:0)

  • perpage (可选):每页结果数(默认值:50)

  • query (可选):按关键字过滤的可选搜索查询

  • fields (可选):要返回的字段(关键字、url、标题、时间戳、ip、点击次数)(默认:所有字段)

14. 生成二维码

为缩短的 URL 生成二维码。需要安装 YOURLS-IQRCodes 插件。

参数:

  • shorturl (必填):用于生成二维码的短网址或关键字

  • size (可选):二维码大小(以像素为单位)

  • border (可选):二维码周围的边框宽度

  • ecc (可选):错误更正级别:L(低)、M(中)、Q(四分位数)或 H(高)

  • format (可选):图像格式(png、jpg、svg 等)

使用示例

配置完成后,Claude 将能够使用 YOURLS 工具并提示如下:

核心功能示例

  • “帮我缩短这个 URL: https://example.com/very-long-url-that-needs-shortening

  • “为https://example.com/documentation创建包含关键字‘docs’的短网址”

  • “设置指向shapescale.com的自定义URL bysha.pe/web”

  • “使用关键字‘docs’为我们的文档创建自定义短网址”

  • “为同一个文档 URL 创建多个关键字 (docs、docs2、docs3)”

  • “使用 UTM 跟踪参数为我们的广告系列创建一个短 URL”

  • “使用 Google Analytics 跟踪缩短此营销 URL:source=newsletter、medium=email、campaign=summer_launch”

  • “扩展此短网址: https://yourdomain.com/abc

  • “我的短网址https://yourdomain.com/abc有多少次点击?”

  • “显示我的 YOURLS 实例的统计信息”

基于插件的功能示例

  • “请提供 2025 年 1 月短网址‘abc’的详细分析数据”

  • “显示 2025 年 1 月 1 日至 2025 年 1 月 31 日 bysha.pe/abc 的点击统计数据”

  • “上个月我的短网址‘web’的每日流量是多少?”

  • “检查此 URL 是否已缩短: https://example.com/page

  • “有人已经为https://example.com/page创建了短网址吗?”

  • “将短网址‘docs’的目标更新为指向https://example.com/new-documentation

  • “更改关键字‘docs’指向的位置”

  • “将短网址‘docs’重命名为‘documentation’”

  • “将我的短网址的关键字从‘docs’更改为‘documentation’”

  • “这个长 URL 的关键字是什么: https://example.com/page ?”

  • “列出https://example.com/page的所有短网址”

  • “删除短网址‘docs’”

  • “从我的 YOURLS 实例中删除关键字‘docs’”

  • “显示我的 YOURLS 数据库中最近的 10 个短网址”

  • “列出所有短网址,按点击次数排序”

  • “搜索包含‘产品’的短网址”

  • “为我的短网址‘docs’生成二维码”

  • “为 bysha.pe/web 创建二维码”

  • “给我一个具有高纠错能力的产品页面二维码”

  • “我需要一个更大的二维码作为‘登陆’短网址,将其设置为 300 像素”

  • “为我们的文档链接生成 SVG QR 码”

发展

# Clone the repository
git clone https://github.com/kesslerio/yourls-mcp.git
cd yourls-mcp

# Install dependencies
npm install

# For local testing, create a claude-local-config.json file:
{
  "mcpServers": {
    "yourls": {
      "command": "node",
      "args": [
        "/full/path/to/yourls-mcp/yourls-mcp.js"
      ],
      "env": {
        "YOURLS_API_URL": "https://your-yourls-domain.com/yourls-api.php",
        "YOURLS_AUTH_METHOD": "signature",
        "YOURLS_SIGNATURE_TOKEN": "your-secret-signature-token"
      }
    }
  }
}

# Start the server directly (for testing)
node yourls-mcp.js

工作原理

YOURLS-MCP 充当 Claude Desktop 和您的 YOURLS 实例之间的桥梁:

  1. Claude Desktop 在需要时启动 YOURLS-MCP 服务器

  2. 服务器从环境变量中读取配置

  3. 当 Claude 调用工具时,服务器会对您的 YOURLS 实例进行适当的 API 调用

  4. 结果以结构化格式返回给 Claude

该服务器使用模型上下文协议 (MCP) 标准与 Claude Desktop 进行通信,从而实现与您的 URL 缩短器的无缝集成和自然语言交互。

重复 URL 处理

YOURLS-MCP 提供了一项独特的功能,可以为同一个目标网址创建多个短网址,而 YOURLS 原生不支持此功能。有关此功能的详细信息,请参阅重复网址处理文档

支持两种方法:

  1. 插件方法(推荐):使用包含的强制允许重复插件来创建真正的重复 URL

  2. URL 修改方法(后备):添加时间戳参数,使每个 URL 在技术上唯一,同时保留功能

系统会根据您的 YOURLS 设置自动选择适当的方法。

与 YOURLS 插件的兼容性

YOURLS-MCP 旨在与标准 YOURLS 安装和各种插件配合使用,并在插件不可用时提供内置的回退功能:

支持的插件及后备功能

当未安装插件时,YOURLS-MCP 包含扩展功能的智能回退功能:

  • API ShortURL Analytics :提供日期范围的详细点击统计信息

    • 回退行为:当插件不可用时,通过核心 YOURLS API 提供基本的点击统计信息

  • API 契约:在不创建 URL 的情况下检查 URL 是否存在

    • 回退行为:使用核心 YOURLS 统计 API 通过过滤搜索现有 URL

  • API 编辑 URL :用于更新短 URL 和更改关键字

    • 后备行为

      • 对于更新 URL:尝试使用相同的关键字重新创建 URL

      • 更改关键字:使用新关键字创建一个新的短网址(保留旧网址,因为删除需要 API Delete 插件)

      • 获取 URL 关键字:使用核心 YOURLS 统计 API 进行过滤

  • API Delete :用于删除短网址

    • 回退行为:有限 - 提供删除需要插件的信息,因为核心 YOURLS API 不支持删除

  • API 列表扩展:用于通过排序和过滤增强 URL 列表

    • 回退行为:使用核心 YOURLS 统计 API 进行客户端排序和分页

  • YOURLS-IQRCodes :用于从短 URL 生成二维码

    • 后备行为:无 - 需要安装插件

  • ShortShort :尝试缩短已缩短的 URL 时正确处理错误

    • 兼容性:无论是否安装插件,错误处理都可以进行

  • 允许现有 URL :修改 YOURLS 处理重复 URL 的方式

    • 插件网址https://github.com/elder-oss/yourls-allow-existing-urls

    • 注意:此插件将错误响应更改为成功响应,但实际上不会为现有目标 URL 创建新的短 URL

    • 我们的解决方案:YOURLS-MCP 实现了一种 URL 修改方法,该方法添加了时间戳参数,使 URL 在数据库中保持唯一,同时保留用户体验

    • 安装:可选 - 无论是否安装此插件,我们的 URL 修改方法均可使用

  • 强制允许重复:真正允许为同一目标 URL 创建多个短 URL

    • 插件库https://github.com/kesslerio/yourls-force-allow-duplicates (即将推出)

    • 描述:绕过 YOURLS 唯一 URL 约束的自定义插件

    • 使用方法:将force=1添加到您的 API 请求中,或将force_url_modification=falsecreate_custom_url工具一起使用

    • 安装

      1. 从插件库下载

      2. force-allow-duplicates文件夹复制到YOURLS/user/plugins/目录

      3. 在您的 YOURLS 管理界面中激活该插件

回退机制

当使用依赖插件的功能但未安装该插件时,YOURLS-MCP:

  1. 自动检测缺失的插件

  2. 尽可能提供适当的后备功能

  3. 当激活回退时,在响应中包含fallback_used: true属性

  4. 当回退功能减少时添加fallback_limitations信息

  5. 对于完全不受支持的操作,返回信息性错误消息

这种方法确保 YOURLS-MCP 能够与尽可能多的 YOURLS 安装兼容,同时仍提供有关插件可用的增强功能的清晰信息。

开发和测试

测试脚本

该项目在tests/integration/目录中包含各种测试脚本:

  • URL缩短测试

    • test-custom-url.js :测试使用特定关键字创建自定义 URL

    • test-url-modification.js :测试处理重复 URL 的 URL 修改方法

    • test-plugin-behavior.js :测试允许现有 URL 插件的行为

  • 插件测试

    • test-duplicate-urls.js :测试使用不同的关键字创建重复的 URL

    • test-plugin-approach.js :测试直接插件方法处理重复项

  • 运行测试

    # Run a specific test
    node tests/integration/test-custom-url.js

实用程序脚本

scripts/目录包含常见操作的实用程序脚本:

  • create-random.js :为指定目的地创建一个随机短 URL

  • 用于特定 URL 创建任务的其他脚本

执照

麻省理工学院

关于

YOURLS-MCP 由 Martin Kessler 创建,用于通过模型上下文协议 (MCP) 将 YOURLS 与 Claude Desktop 和其他 Claude 产品集成。

强制允许重复插件是为了解决为同一目的地创建多个短 URL 的难题而开发的,而 YOURLS 本身并不支持这一难题。

对于支持、问题或功能请求:

Available Tools

14 tools
change_keywordC

Change the keyword of an existing short URL

ParametersJSON Schema
NameRequiredDescriptionDefault
newshorturlYesThe new keyword to use
oldshorturlYesThe existing short URL or keyword
titleNoOptional new title

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It implies a mutation ('change') but doesn't specify permissions needed, whether changes are reversible, rate limits, or error handling. This is inadequate for a tool that modifies existing data without structured safety hints.

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

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the core action without unnecessary words. Every part earns its place by directly stating the tool's function, making it highly concise and well-structured.

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

Completeness2/5

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

Given the tool performs a mutation with no annotations and no output schema, the description is insufficient. It doesn't explain what happens on success (e.g., returns updated URL), error cases, or how it fits among siblings like 'update_url'. For a 3-parameter tool that alters data, more context is needed.

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%, so parameters are well-documented in the schema. The description adds no additional meaning beyond implying 'oldshorturl' and 'newshorturl' relate to keywords, but doesn't clarify format or constraints. This meets the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('change') and resource ('keyword of an existing short URL'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'update_url' or 'get_url_keyword', which could handle similar operations, so it doesn't reach the highest score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'update_url' or 'create_custom_url'. It lacks context about prerequisites (e.g., needing an existing short URL) or exclusions, leaving the agent to infer usage from the name alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

contract_urlA

Check if a URL has already been shortened without creating a new short URL

ParametersJSON Schema
NameRequiredDescriptionDefault
urlYesThe URL to check if it exists in the database

TDQS

A4.1/5.0
Behavior3/5

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 discloses the tool's read-only behavior by stating it checks without creating, but lacks details on error handling, response format, or database interaction specifics, leaving gaps in 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.

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the purpose and usage, with zero wasted words, making it highly concise and well-structured for quick understanding.

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

Completeness3/5

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 is adequate for a simple lookup tool but incomplete in explaining return values or potential errors, which could hinder agent usage in more complex scenarios.

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%, so the schema already documents the 'url' parameter. The description adds minimal semantic context by implying the URL is checked against a database, but does not provide additional syntax or format details beyond what the schema covers.

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 specific action ('Check if a URL has already been shortened') and the resource ('URL'), distinguishing it from sibling tools like 'shorten_url' or 'expand_url' by emphasizing it does not create new short URLs.

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?

It explicitly states when to use this tool ('Check if a URL has already been shortened') and when not to ('without creating a new short URL'), providing clear alternatives by contrasting with sibling tools like 'shorten_url' for creation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_custom_urlA

Create a custom short URL with a specific keyword, even for URLs that already exist in the database

ParametersJSON Schema
NameRequiredDescriptionDefault
force_url_modificationNoWhether to force URL modification to allow duplicates
keywordYesThe custom keyword for the short URL
titleNoOptional title for the URL
urlYesThe URL to shorten

TDQS

A3.9/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden. It discloses the key behavioral trait about handling existing URLs, which is valuable. However, it doesn't mention permission requirements, rate limits, whether the operation is idempotent, or what happens on failure - significant gaps for a creation tool.

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

Conciseness5/5

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

The description is a single, efficient sentence that communicates the core purpose and key differentiator without any wasted words. It's appropriately sized and front-loaded with the main action.

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

Completeness3/5

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

For a creation tool with no annotations and no output schema, the description provides the essential purpose but lacks important context about permissions, error conditions, return values, and system constraints. The 100% schema coverage helps, but behavioral aspects remain underspecified.

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%, so the schema already documents all parameters thoroughly. The description doesn't add any parameter-specific information beyond what's in the schema descriptions. This meets the baseline expectation when schema coverage is complete.

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 specific action ('Create a custom short URL'), identifies the resource ('with a specific keyword'), and distinguishes it from siblings by mentioning 'even for URLs that already exist in the database' - which differentiates it from tools like 'shorten_url' that might not handle duplicates.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context about when to use this tool ('for URLs that already exist in the database'), but doesn't explicitly mention when NOT to use it or name specific alternatives among the many sibling tools. It implies this is for custom keyword creation with duplicate handling.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

db_statsB

Get global statistics for the YOURLS instance

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries full burden for behavioral disclosure. While 'Get' implies a read operation, it doesn't specify whether this requires authentication, what format the statistics are returned in, whether there are rate limits, or if the data is cached. For a statistics tool with zero annotation coverage, this leaves significant gaps.

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

Conciseness5/5

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

The description is a single, efficient sentence that gets straight to the point without any unnecessary words. It's perfectly front-loaded with the core functionality, making it easy for an AI agent to quickly understand what the tool does.

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

Completeness2/5

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

Given that this is a statistics tool with no annotations and no output schema, the description is insufficient. It doesn't explain what kind of statistics are returned (e.g., total URLs, clicks, users), the format of the response, or any behavioral characteristics. For a tool that presumably returns structured data, more context is needed.

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

Parameters4/5

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

The tool has zero parameters, and schema description coverage is 100%, so there are no parameters to document. The description appropriately doesn't waste space discussing nonexistent parameters, earning a baseline score of 4 for this dimension.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Get') and target resource ('global statistics for the YOURLS instance'), making the tool's purpose immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'url_stats' or 'url_analytics', which also provide statistical data but for different scopes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'url_stats' and 'url_analytics' that also provide statistics, there's no indication whether this tool should be used for system-wide metrics versus URL-specific data, or any prerequisites for its use.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

delete_urlC

Delete a short URL

ParametersJSON Schema
NameRequiredDescriptionDefault
shorturlYesThe short URL or keyword to delete

TDQS

C2.9/5.0
Behavior2/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 behavioral disclosure. 'Delete' implies a destructive mutation, but the description doesn't specify whether this action is reversible, what permissions are required, or what the response looks like. It lacks details on side effects or error conditions.

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

Conciseness5/5

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

The description is a single, efficient sentence with zero waste. It's front-loaded and appropriately sized for a simple tool, making it easy to parse quickly.

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

Completeness2/5

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

For a destructive mutation tool with no annotations and no output schema, the description is incomplete. It doesn't explain what 'delete' entails (e.g., permanent removal, effects on analytics), return values, or error handling, leaving significant gaps for an AI agent.

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%, with the parameter 'shorturl' documented as 'The short URL or keyword to delete'. The description adds no additional meaning beyond this, so it meets the baseline of 3 where the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Delete a short URL' clearly states the action (delete) and resource (short URL). It distinguishes from siblings like 'update_url' or 'change_keyword' by specifying deletion rather than modification, though it doesn't explicitly contrast with all alternatives.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives like 'update_url' or 'change_keyword'. The description states what it does but offers no context about prerequisites, when deletion is appropriate, or what happens after deletion.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

expand_urlA

Expand a short URL to its original long URL

ParametersJSON Schema
NameRequiredDescriptionDefault
shorturlYesThe short URL or keyword to expand

TDQS

A3.7/5.0
Behavior2/5

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 states the basic function but lacks details on behavioral traits such as error handling (e.g., invalid URLs), rate limits, authentication needs, or whether it follows redirects. This is a significant gap 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.

Conciseness5/5

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

The description is a single, clear sentence with no wasted words. It is front-loaded with the core purpose and efficiently communicates the tool's function.

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

Completeness3/5

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

Given the tool's low complexity (one parameter, no output schema, no annotations), the description is minimally adequate. However, it lacks completeness in behavioral aspects like error cases or output format, which would be helpful for an agent to use it correctly.

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

Parameters4/5

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

The description adds meaning by clarifying that the 'shorturl' parameter can be a 'short URL or keyword', which provides context beyond the schema's generic description. With 100% schema description coverage, the baseline is 3, but this extra semantic detail justifies a higher score.

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 verb 'expand' and the resource 'short URL', specifying the action of converting a short URL to its original long URL. It distinguishes itself from sibling tools like 'shorten_url' and 'contract_url' by focusing on the reverse operation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage when needing to resolve a short URL, but does not explicitly state when to use this tool versus alternatives like 'get_url_keyword' or 'url_analytics'. No guidance on exclusions or prerequisites is provided.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

generate_qr_codeC

Generate a QR code for a shortened URL

ParametersJSON Schema
NameRequiredDescriptionDefault
formatNoImage format (png, svg, etc.)
marginNoMargin size
shorturlYesThe short URL to generate a QR code for
sizeNoSize of the QR code in pixels

TDQS

C2.9/5.0
Behavior2/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 behavioral disclosure. It states what the tool does but doesn't cover key aspects like whether it's a read-only or mutation operation, authentication requirements, rate limits, or error handling. This is inadequate for a tool that likely involves external resources.

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

Conciseness5/5

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

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It's front-loaded and appropriately sized, making it easy to understand at a glance.

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

Completeness2/5

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

Given the tool's complexity (generating QR codes with multiple parameters) and lack of annotations and output schema, the description is incomplete. It doesn't explain what the output looks like (e.g., image data or URL), potential side effects, or how it integrates with sibling tools, leaving significant gaps for an AI agent.

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?

The description implies the 'shorturl' parameter is required, but doesn't add meaning beyond the input schema, which has 100% coverage and already describes all parameters clearly. Since schema coverage is high, the baseline score of 3 is appropriate, as the description doesn't compensate with extra details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'generate' and the resource 'QR code', specifying it's for a 'shortened URL'. This distinguishes it from general QR code generators, though it doesn't explicitly differentiate from sibling tools like 'shorten_url' or 'url_analytics' that might also involve URLs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives, such as whether it's for generating QR codes specifically for URLs shortened by this service or any shortened URL. It lacks context on prerequisites or exclusions, leaving usage ambiguous.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_url_keywordC

Get the keyword(s) for a long URL

ParametersJSON Schema
NameRequiredDescriptionDefault
exactly_oneNoWhether to return only one result (default: false)
urlYesThe URL to find keywords for

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states what the tool does but lacks details on how it works (e.g., how keywords are extracted, any rate limits, error handling, or response format). This is a significant gap for a tool with no structured safety or behavioral hints.

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

Conciseness5/5

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

The description is a single, efficient sentence that directly states the tool's purpose without any wasted words. It is appropriately sized and front-loaded, making it easy for an agent to parse quickly.

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

Completeness2/5

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 is incomplete. It does not explain what the return value looks like (e.g., format of keywords, potential errors), and with siblings like 'url_analytics', more context on use cases would be helpful. The tool's complexity is low, but the description lacks necessary behavioral details.

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%, so the input schema already documents both parameters ('url' and 'exactly_one') with clear descriptions. The description does not add any meaning beyond this, such as examples or edge cases, but the schema provides adequate baseline information.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get' and the resource 'keyword(s) for a long URL', making the purpose understandable. However, it does not explicitly differentiate this tool from siblings like 'url_analytics' or 'url_stats', which might also involve URL analysis, so it falls short of a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'url_analytics' or 'list_urls', there is no indication of context, prerequisites, or exclusions, leaving the agent to guess based on tool names alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_urlsC

Get a list of URLs with sorting, pagination, and filtering options

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number
perpageNoNumber of results per page
searchNoSearch term to filter results
sortbyNoField to sort by (e.g., "clicks", "timestamp")
sortorderNoSort order ("asc" or "desc")

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It mentions the tool's capabilities (sorting, pagination, filtering) but doesn't describe what the tool returns (e.g., format, fields), error conditions, rate limits, or authentication requirements. For a list operation with no annotation coverage, this leaves significant gaps.

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

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the core purpose ('Get a list of URLs') followed by key capabilities. Every word earns its place with zero waste or redundancy.

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

Completeness2/5

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

For a tool with 5 parameters, no annotations, and no output schema, the description is incomplete. It doesn't explain what the returned list contains, how results are structured, or any behavioral aspects beyond basic capabilities. Given the complexity and lack of structured data, more context is needed.

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%, so the schema already documents all 5 parameters thoroughly. The description adds minimal value by mentioning 'sorting, pagination, and filtering' which aligns with parameters like sortby/sortorder, page/perpage, and search, but doesn't provide additional semantic context beyond what's in the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get' and resource 'list of URLs', making the purpose understandable. However, it doesn't distinguish this tool from potential siblings like 'url_stats' or 'url_analytics' that might also provide URL-related information, so it doesn't reach the highest score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description mentions 'sorting, pagination, and filtering options' which implies when to use this tool, but provides no explicit guidance on when to choose this over alternatives like 'url_stats' or 'url_analytics'. There's no mention of prerequisites, exclusions, or specific contexts for use.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

shorten_urlC

Shorten a long URL using YOURLS

ParametersJSON Schema
NameRequiredDescriptionDefault
keywordNoOptional custom keyword for the short URL
titleNoOptional title for the URL
urlYesThe URL to shorten

TDQS

C2.9/5.0
Behavior2/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 behavioral disclosure. It mentions the service ('YOURLS') but doesn't describe whether this is a read-only or mutating operation, what permissions are required, rate limits, error handling, or what the output looks like. For a tool that likely creates a new short URL, this is a significant gap in transparency.

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

Conciseness5/5

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

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It is front-loaded with the core action and resource, making it easy to parse quickly.

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

Completeness2/5

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

Given the complexity of a URL shortening tool with no annotations and no output schema, the description is incomplete. It doesn't explain the return value (e.g., the shortened URL), error conditions, or behavioral traits like whether it's idempotent or requires authentication. This leaves gaps for an agent to understand how to use it effectively.

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?

The input schema has 100% description coverage, clearly documenting all three parameters (url, keyword, title) with their types and optionality. The description adds no additional parameter semantics beyond what the schema provides, so it meets the baseline of 3 for adequate but not enhanced coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('shorten') and resource ('a long URL'), and specifies the service used ('using YOURLS'). It distinguishes from siblings like 'expand_url' or 'generate_qr_code' by focusing on shortening. However, it doesn't explicitly differentiate from 'shorten_with_analytics' or 'contract_url', which might offer similar functionality.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'shorten_with_analytics', 'contract_url', or 'create_custom_url'. It lacks context about use cases, prerequisites, or exclusions, leaving the agent to infer usage from the tool name alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

shorten_with_analyticsC

Shorten a long URL with Google Analytics UTM parameters

ParametersJSON Schema
NameRequiredDescriptionDefault
keywordNoOptional custom keyword for the short URL
titleNoOptional title for the URL
urlYesThe URL to shorten
utm_campaignNoUTM campaign parameter
utm_contentNoUTM content parameter
utm_mediumYesUTM medium parameter
utm_sourceYesUTM source parameter
utm_termNoUTM term parameter

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations provided, the description carries full burden but only states what the tool does, not how it behaves. It doesn't disclose whether this creates a permanent short URL, requires authentication, has rate limits, returns a specific format, or what happens on failure. For a write operation with zero annotation coverage, this is insufficient.

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

Conciseness5/5

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

Single sentence, zero waste. Every word earns its place by conveying the core functionality efficiently. No fluff or redundant information.

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

Completeness2/5

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

For a write operation (URL shortening with analytics) with no annotations and no output schema, the description is incomplete. It doesn't explain what gets returned (e.g., short URL format), error conditions, or behavioral aspects. Given the complexity and lack of structured data, more context is needed.

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%, so the schema already documents all 8 parameters thoroughly. The description adds no additional parameter information beyond implying UTM parameters are included. Baseline 3 is appropriate when schema does the heavy lifting, though the description doesn't compensate with any extra context.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('shorten') and resource ('a long URL') with the specific feature of adding Google Analytics UTM parameters. It distinguishes from sibling 'shorten_url' by mentioning analytics parameters, but doesn't explicitly contrast them. The purpose is specific and actionable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives like 'shorten_url' (which presumably doesn't include UTM parameters) or 'create_custom_url'. The description implies usage for tracking purposes but doesn't provide explicit when/when-not scenarios or mention sibling tools as alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

update_urlB

Update an existing short URL to point to a different destination URL

ParametersJSON Schema
NameRequiredDescriptionDefault
shorturlYesThe short URL or keyword to update
titleNoOptional new title for the URL
urlYesThe new destination URL

TDQS

B3.2/5.0
Behavior2/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 behavioral disclosure. It states the tool updates a short URL but does not mention permissions required, whether changes are reversible, rate limits, or error handling. This leaves significant gaps for a mutation tool.

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

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the core action ('update an existing short URL') and specifies the purpose ('to point to a different destination URL'). There is no wasted text, making it highly concise and well-structured.

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

Completeness2/5

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

Given the tool is a mutation with no annotations and no output schema, the description is incomplete. It does not cover behavioral aspects like side effects, return values, or error conditions, which are critical for safe and effective use in this context.

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?

The schema description coverage is 100%, so the schema already documents all parameters. The description adds no additional meaning beyond implying the 'url' parameter is the new destination, which is already clear from the schema. This meets the baseline for high schema coverage.

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 verb 'update' and the resource 'existing short URL', specifying the action of changing its destination. It distinguishes from siblings like 'create_custom_url' (creation) and 'delete_url' (deletion), making the purpose specific and unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives, such as 'change_keyword' (which might update keywords) or 'contract_url' (which could modify URLs differently). It lacks context on prerequisites or exclusions, offering only a basic functional statement.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

url_analyticsC

Get detailed click analytics for a shortened URL within a date range

ParametersJSON Schema
NameRequiredDescriptionDefault
periodNoThe time period for analytics (e.g., "day", "week", "month")
shorturlYesThe short URL to get analytics for

TDQS

C2.9/5.0
Behavior2/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 behavioral disclosure. It states the tool retrieves analytics (implying read-only) but doesn't mention authentication needs, rate limits, error conditions, or what 'detailed click analytics' includes (e.g., metrics like clicks, locations, devices). This leaves significant gaps for safe and effective use.

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

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the core purpose without unnecessary words. Every part earns its place by specifying the action, resource, and scope concisely.

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

Completeness2/5

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

Given the complexity of analytics tools, no annotations, and no output schema, the description is incomplete. It doesn't explain what data is returned, how to interpret results, or handle edge cases (e.g., invalid URLs, no data in range). For a tool with potential rich outputs, this leaves the agent under-informed.

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%, so the schema already documents both parameters ('shorturl' and 'period') adequately. The description adds minimal value beyond implying date-range filtering, but doesn't provide additional syntax, format examples, or constraints beyond what's in the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Get detailed click analytics') and resource ('for a shortened URL within a date range'), making the purpose immediately understandable. However, it doesn't explicitly distinguish this tool from sibling tools like 'url_stats' or 'shorten_with_analytics', which likely have overlapping analytics functionality.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'url_stats' or 'shorten_with_analytics'. It mentions a date range but doesn't specify prerequisites, exclusions, or comparative contexts with sibling tools, leaving the agent to guess based on tool names alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

url_statsC

Get statistics for a shortened URL

ParametersJSON Schema
NameRequiredDescriptionDefault
shorturlYesThe short URL or keyword to get stats for

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the action ('Get statistics') but fails to describe key traits like what statistics are returned, whether authentication is required, rate limits, or error handling. This leaves significant gaps for a tool that likely involves data retrieval.

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

Conciseness5/5

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

The description is a single, efficient sentence that directly states the tool's purpose without unnecessary words. It is front-loaded and appropriately sized, making it easy for an agent to parse quickly and understand the core functionality.

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

Completeness2/5

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

Given the lack of annotations and output schema, the description is incomplete for a tool that retrieves statistics. It doesn't specify what statistics are included, the format of the response, or any behavioral nuances, leaving the agent with insufficient context to use the tool effectively beyond basic invocation.

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?

The input schema has 100% description coverage, clearly documenting the 'shorturl' parameter. The description adds no additional meaning beyond this, as it doesn't elaborate on parameter syntax, examples, or constraints. With high schema coverage, the baseline score of 3 is appropriate, as the schema handles the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/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 with a specific verb ('Get') and resource ('statistics for a shortened URL'), making it immediately understandable. However, it doesn't differentiate from sibling tools like 'url_analytics' or 'shorten_with_analytics', which might offer similar statistical functionality, preventing a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. With sibling tools like 'url_analytics', 'db_stats', and 'shorten_with_analytics' potentially overlapping in functionality, the agent lacks explicit direction on selection criteria, such as specific use cases or data scope differences.

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. Dates show when Glama detected each change.

  1. 14 tool updatesv1.0.0
    • First observedchange_keyword
    • First observedcontract_url
    • First observedcreate_custom_url
    • First observeddb_stats
    • First observeddelete_url
    • First observedexpand_url
    • First observedgenerate_qr_code
    • First observedget_url_keyword
    • First observedlist_urls
    • First observedshorten_url
    • First observedshorten_with_analytics
    • First observedupdate_url
    • First observedurl_analytics
    • First observedurl_stats

TDQS

A3.7/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose with no ambiguity. For example, 'shorten_url' creates a basic short URL, 'shorten_with_analytics' adds analytics parameters, 'contract_url' checks for existing URLs, and 'update_url' modifies destinations. The tools cover different aspects of URL management without overlap.

Naming Consistency5/5

Tool names follow a consistent verb_noun pattern throughout, such as 'change_keyword', 'create_custom_url', 'delete_url', and 'expand_url'. All tools use snake_case with clear action-object naming, making them predictable and easy to understand.

Tool Count5/5

With 14 tools, the server is well-scoped for URL shortening and management. Each tool serves a specific function in the YOURLS domain, from creation and deletion to analytics and utilities like QR code generation, without being excessive or insufficient.

Completeness5/5

The tool set provides complete CRUD and lifecycle coverage for URL management, including create, read, update, delete, analytics, and utilities. There are no obvious gaps; tools like 'update_url' and 'change_keyword' cover modifications, while 'url_analytics' and 'db_stats' handle monitoring, ensuring agents can perform all necessary operations.

Maintenance

ActivityInactive
ResponsivenessNo issues

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

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/kesslerio/yourls-mcp'

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