Native lookup has no relevance ranking or pagination

Aperta
#56 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
Mezza giornata
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github-actions, lua, python
Ambito
api, tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Python
Stelle
7
Fork
4
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/CFX-Developer-Tools

Tutte le issue di TMHSDigital/CFX-Developer-Tools

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.