Feature: generate a version-accurate Unity API index for lookup_api

未关闭
#40 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
csharp, unity
领域
game-dev, tooling

调研方向

Start by reading the existing lookup_api implementation and the lifecycle-only weekly data workflow; the issue does not name their file paths. Then assess Unity ScriptReference or reference assemblies as data sources and how analyze_project determines the Unity version. Done means version-selectable generated indexes provide accurate signatures and obsolete warnings for supported public UnityEngine types while keeping the data size reasonable.

由索引模型根据 Issue 内容生成。

描述

feature mcp-server priority: medium

Why it matters

A hand-curated list of 59 entries cannot compete with the model's own memory, so lookup_api adds little value today. What models genuinely lack is version-accurate facts: which members exist in Unity 6.x, which are obsolete, and what the exact signatures are. A generated index makes the tool authoritative instead of decorative, and fulfils the M2 roadmap goal of "500+ entries".

Proposal

  • A build script that generates unity_api_index.json from Unity's ScriptReference (or from the UnityEngine/UnityEditor reference assemblies via reflection / System.Reflection.Metadata), capturing type, member, signature, [Obsolete] message, and since-version.
  • Store per Unity version (6000.0 LTS, latest 6.x), selectable via a unity_version argument (defaulting to the version found by analyze_project).
  • Keep the curated entries as "examples/notes" layered on top.
  • Ranked fuzzy search; return obsolete status and replacement prominently.
  • Run the generator in the weekly data workflow (as a PR), replacing the current lifecycle-only refresh.

Done when

lookup_api returns accurate signatures and obsolete warnings for any public UnityEngine type in the supported versions, with size kept reasonable (compressed or SQLite).

主要语言
C#
星标
4
派生
0
PR 合并指标
30 天内没有已合并 PR

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

TMHSDigital/Unity-Developer-Tools 的其他 Issue

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

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。