PulseAugur
实时 05:32:49
English(EN) My MCP Tool's Docstring Promised sort="stars". GitHub's API Was Never Going to Honor That Value.

开发者发现工具文档中的 GitHub API 排序顺序不匹配

一位开发者在其工具的文档中发现了一个细微的错误,其中承诺的 GitHub API 排序选项与实际 API 的功能不符。该工具的文档字符串声称支持按“stars”和“forks”排序,但所使用的 GitHub REST API 端点仅接受用户存储库的“created”、“updated”、“pushed”和“full_name”。这种差异导致 API 默默地忽略了无效的排序参数,并默认使用自己的顺序,为该工具创建了一个误导性的成功状态。开发者通过在获取数据后实现客户端排序来解决“stars”和“forks”的问题,确保该工具的行为现在与其文档匹配。 AI

影响 强调了准确的文档和 API 合约遵守对于 AI 代理工具的重要性。

排序理由 文章详细介绍了与 API 交互和文档相关的特定开发者工具中的一个错误修复。

在 dev.to — MCP tag 阅读 →

AI 生成摘要 · Google Gemini · 来自 1 个来源。 我们如何撰写摘要 →

开发者发现工具文档中的 GitHub API 排序顺序不匹配

报道来源 [1]

  1. dev.to — MCP tag TIER_1 English(EN) · Enjoy Kumawat ·

    我的MCP工具的Docstring承诺了sort="stars"。GitHub的API永远不会遵守那个值。

    <p>Every tool in my <code>developer-presence</code> MCP server has a one-line docstring, because that's the only documentation an agent calling the tool ever sees — no README, no OpenAPI spec, just whatever string sits under the <code>@mcp.tool()</code> decorator. I've already fo…