Native lookup has no relevance ranking or pagination

未關閉
#56 1 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
3/5
預估耗時
半天
新手友好度
45/100
Issue 類型
功能
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
github-actions, lua, python
領域
api, tooling

研究方向

Start in mcp-server/tools/natives.py, where lookup_native applies an unranked substring filter and _format_results caps output at show_limit = 25, then check the lookup_native_tool signature in mcp-server/server.py. Deprecation parsing lives in .github/scripts/transform_natives.py near line 197. There is no test suite, so verify by running the MCP server and calling the lookup. Done means exact-name matches rank first, limit and offset page results, and deprecated natives expose a replacement.

由索引模型根據 Issue 內容生成。

描述

enhancement severity: medium

Summary

lookup_native_tool returns matches in file (alphabetical) order and cuts them at 25 with no offset. Broad queries hide the most relevant natives, deprecated natives do not expose their replacement in a structured way, and the output is prose only.

Where

  • mcp-server/tools/natives.py:46-62 (lookup_native, unranked substring filter)
  • mcp-server/tools/natives.py:104-141 (_format_results, show_limit = 25)
  • mcp-server/server.py:51-66 (lookup_native_tool signature)
  • .github/scripts/transform_natives.py:197 (deprecation detection)

Details

  • lookup_native("vehicle") returns "Found 1077 native(s)" and shows only the first 25 alphabetical names, followed by "Narrow your search". There is no limit or offset.
  • A name match ranks the same as a description match.
  • For deprecated natives the replacement appears only as a markdown link inside the description text (for example use [HINT_SCRIPT_AUDIO_BANK](#\_0xFB38...)), with no replaced_by field.

SCREAMING_SNAKE name matching is tracked in "lookup_native returns nothing for canonical SCREAMING_SNAKE native names".

Impact

For partial or broad queries the native the agent wants is often past the cutoff and unreachable without guessing a narrower string. Agents cannot reliably follow a deprecation to its replacement or parse results.

Suggested fix

  • Score matches: exact name, then name prefix, then name substring, then category, then description; sort by score.
  • Add limit (default 25, max 100) and offset parameters.
  • In transform_natives.py, extract the linked replacement into a replaced_by field and render it as "Use X instead".
  • Add an optional format="json" that returns the raw records.

Acceptance criteria

  • An exact-name query lists that native first even when many others match the description.
  • offset pages through results beyond the first 25.
  • Deprecated natives with a known replacement show it.
  • format="json" returns parseable records.

Getting started

  • Relevant files: mcp-server/tools/natives.py, mcp-server/server.py, .github/scripts/transform_natives.py
  • How to run checks: there is no test suite yet; run the MCP server with cd mcp-server && pip install -r requirements.txt && python server.py, and CI checks live in .github/workflows/validate.yml
  • Related docs: skills/native-functions/SKILL.md

Filed by repo-audit/full-audit at 701824d. Severity: medium. Effort: S. audit-key: enhancement|mcp-server/tools/natives.py|ranking

主要語言
Python
星號
7
分支
4
PR 合併指標
30 天內沒有已合併 PR

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

TMHSDigital/CFX-Developer-Tools 的其他 Issue

查看 TMHSDigital/CFX-Developer-Tools 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。