Goal
Treat the XRK-AGT documentation system as executable navigation: when a user asks "where is this configured/where is this changed/how do I integrate this", directly give theshortest path(configuration path, code file, corresponding document).
Authoritative entry points (by priority)
- Documentation navigation:
docs/README.md - Factory and LLM:
docs/factory.md - Workflow (AIStream):
docs/aistream.md - system-Core capabilities:
docs/system-core.md - HTTP API and business layer:
docs/http-api.md、docs/http-business-layer.md - Authentication:
docs/AUTH.md - MCP:
docs/mcp-guide.md、docs/mcp-config-guide.md - Extensibility (7 major extension points, Core development):
docs/框架可扩展性指南.md
Common questions → jump paths
- v3 OpenAI-compatible entry:
core/system-Core/http/ai.js - LLM provider selection:
data/server_bots/{port}/aistream.yamlfieldllm.Provider(with the port; template seeconfig/default_config/aistream.yaml) - Workflow discovery: fixed scan
core/*/stream/*.js, unrelated toaistream.streamDir(seedocs/aistream.md) - Configuration for a given LLM:
data/server_bots/{port}/*_llm.yamlor*_compat_llm.yaml - Frontend form Schema:
core/system-Core/commonconfig/*.js - Authentication responsibilities: see
docs/AUTH.md(the Server layer only does basic pass-through; system-Core HTTP usesBot.checkApiAuthorization(req)inside the module for system-level authentication; other Cores may decide on their own whether to integrate). - HTTP unified response:
src/utils/http-utils.js(HttpResponse). Error handling:src/utils/error-handler.js(ErrorCodes、BotError)。 - Infrastructure layer (loaders/base classes/paths/errors): skill
xrk-infrastructure、docs/框架可扩展性指南.md。
Answering standards
- For "how to configure": must provideconfiguration file path + key fields + minimal example snippet。
- For "why it behaves this way": must providecode entry path + function/class name。
- When documentation and code are inconsistent: usecode as the source of truth, and note the documentation path that needs revision.
Applicable scenarios
- Need to locate the implementation path and configuration entry for this subsystem.
- Need to quickly provide the change location and compatibility considerations.
Non-applicable scenarios
- Not used to replace implementation descriptions of other subsystems.
- Do not fabricate paths or fields when evidence is lacking.
Execution steps
- First confirm the requirement falls within the responsibility boundary of this skill.
- Then provide the code path, configuration path, and key fields.
- Finally add risk points, verification steps, and regression scope.
Common pitfalls
- Giving only concepts without specific file paths.
- Failing to note that code is the source of truth when documentation and code conflict.
- Ignoring consistency among configuration, Schema, and consuming code.