Native lookup has no relevance ranking or pagination

Offen
#56 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
Ein halber Tag
Anfängerfreundlichkeit
45/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Aktiv
Tech-Stack
github-actions, lua, python
Bereich
api, tooling

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
Python
Sterne
7
Forks
4
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TMHSDigital/CFX-Developer-Tools

Alle Issues in TMHSDigital/CFX-Developer-Tools

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.