chore docs: standalone MCP-only AGENT-GUIDE#181
Conversation
Drop LanceDB/Kuzu framing, CLI references, and external doc links from the copy-paste block; document Producer kind, DECLARES_PRODUCER, and align README MCP table with the current find/resolve surface. Co-authored-by: Cursor <cursoragent@cursor.com>
HumanBean17
left a comment
There was a problem hiding this comment.
Review summary
Verdict: Approve direction; suggest a few small fixes before merge (or as immediate follow-up).
The README find/resolve producer kinds are clearly correct and match server.py. The AGENT-GUIDE rewrite fixes real staleness in the copy block (master still listed three node kinds / omitted Producer). Dropping aspirational edge_filter from the paste block is correct — it is not on the MCP surface yet.
What works well
- Producer surface documented end-to-end:
DECLARES_PRODUCER,producer:/p:ids,producer_kind/topic_prefix,/producers, decision-tree row. - Edge taxonomy matches implementation (
HTTP_CALLSClient→Route,ASYNC_CALLSProducer→Route, composed keys, virtual keys describe-only). - Standalone goal achieved: no Lance/Kuzu framing, no CLI commands inside the copy block.
Requested changes (before or right after merge)
-
Restore maintenance section outside the copy markers — master had repo-only guidance (bump ontology version, sync README when
NodeFilter/MCP changes). The file now ends at<!-- END -->; that hurts maintainers and is not a “CLI dependency” for pasted agents. -
Brownfield section is HTTP-only — please mention
@CodebaseAsyncRoute/@CodebaseProducerwith the same exclusivity rule as HTTP stubs (framework listener/producer inference on the same method is not merged). README already treats these as first-class. -
Ontology version stamp inside the copy block — old guide said “calibrated against v15”; standalone agents cannot detect guide/index drift. One line is enough, e.g.
Ontology: 15 — re-pull when your index ontology_version changes(no repo links required).
Strongly recommended (minimal scope)
-
Staleness / empty index — one recovery line without CLI names: if results are empty across tools, the index may be missing or stale; agents cannot reindex via MCP — ask the operator. Old guide’s
metacheck was valuable for pasted-only setups;java-codebase-explorecovers CLI but many users paste only this block. -
resolvewhenhint_kindomitted — state explicitly that omission searches all four kinds (symbol, route, client, producer). Master incorrectly said “three”. -
Optional: one line under
searchthattablesupportssql/yaml/all(old “indexes Java, SQL, YAML” framing was removed).
Accepted trade-offs
- Compressed
describe/ override-axis detail — OK ifneighbors(..., ["OVERRIDES"])+edge_summarysuffice for most cases. - Removing CLI rows from decision tree and
/health— fine given standalone scope; pair with (4) above.
CI green; docs-only scope is appropriate. Happy to re-review after the maintenance + async brownfield + ontology stamp tweaks.
Restore repo-only maintenance notes outside the copy block; add async brownfield stubs, ontology 15 stamp, four-kind resolve default, and index-missing recovery without CLI names. Co-authored-by: Cursor <cursoragent@cursor.com>
Summary
docs/AGENT-GUIDE.mdcopy-paste block as a standalone MCP operating manual: no LanceDB/Kuzu framing, no CLI commands, no links to other repo docs, no ontology migration notes.DECLARES_PRODUCERedge,producer:/p:ids, and producerNodeFilterkeys.find/resolve) with the same surface.Test plan
<!-- BEGIN/<!-- ENDmarkers.Made with Cursor