Skip to content

README.md

Latest commit

 

History

History
59 lines (46 loc) · 6.98 KB

README.md

File metadata and controls

59 lines (46 loc) · 6.98 KB
Raw

Documentation Index

The binding product references are these current-state pages and local Navigator code and tests. Task specifications describe acceptance requirements.

Installed executables provide selected canonical pages offline through --doc topics and --doc <topic>. The setup guide describes server discovery; the assembly export guide describes exporter discovery. The embedded selection covers product orientation, setup, tool usage, and export operation.

Embedded documentation map and maintenance

These are the complete canonical Markdown sources available through --doc:

Canonical source Executable and topic Purpose Output stream
README.md AiNetCodeNavigator.exe --doc overview Product orientation and installed-server quick start stderr
docs/setup/README.md AiNetCodeNavigator.exe --doc setup Installation, MCP client process configuration, and optional host settings stderr
docs/tools/README.md AiNetCodeNavigator.exe --doc tools Tool discovery, source/assembly walkthroughs, and response recovery stderr
docs/assembly-export.md AiNetCodeNavigator.AssemblyExport.exe --doc guide Offline assembly export stdout

The server and exporter projects embed these same files as EmbeddedResource items at build time. There is no second CLI text copy to maintain. All other docs/ pages, including this index, are repository-only references and are not available through --doc.

When changing documentation:

  1. Use the map above to identify whether the page is embedded or repository-only, and edit its canonical source. If the embedded selection changes, update the project resource entries, CLI topic handling, and this map together.
  2. Keep embedded pages readable for users without a repository checkout. Include essential usage instructions in the page itself; repository-relative links may provide optional detail, but essential usage must not depend on following them.
  3. After building or publishing a changed embedded page, run --doc topics and the affected --doc <topic> with the corresponding built or published executable and inspect the emitted text. Capture server documentation from stderr (2>); capture exporter documentation from stdout (>). Confirm the edited content is present and readable.

The installed MCP client's tools/list is the authority for current tool names, descriptions, and input schemas; read schema defaults and bounds together with parameter descriptions for effective defaults and semantic limits. The embedded usage guide explains navigation choices rather than duplicating those schemas. Repository links below are optional deeper contracts for readers with a checkout.

Development and host contracts

  • Build and Tests: Solution structure, PowerShell scripts, and static log files in temp/.
  • Manual MCP Exploration: On-demand C# scenarios, real local tool output, and inspection artifacts under temp/exploration/.
  • MCP Response Budgets: Host-side UTF-8 limits, token accounting, explicit truncation, and recoverable undersized-budget results.
  • MCP Tool Results: Internal CallToolResult builders, status text, structured success content, and error classification.
  • MCP Argument Validation: SDK input-schema validation, binder compatibility checks, safe field paths, and error-budget behavior.
  • MCP Long-Running Calls and Continuations: Operation token lifecycle, polling, immutable text snapshots, continuation tokens, and their limits.
  • MCP Host: Stdio lifecycle, the navigation tool catalog, and startup host settings.
  • MCP Traffic Capture: Optional raw tool-call frames, session summaries, measurements, and storage limits.
  • MCP Navigation Registration Status: Current transport-free handler contracts and the boundary around retained end-to-end tests.

Navigation

  • Index Scope: Roslyn solution and project document inventory, bounds, completeness, errors, and read-only behavior.
  • Namespace Tree Core Scanner: Source namespace hierarchy, project aggregation, depth and result bounds, truncation, and read-only behavior.
  • Shared Symbol Resolution: Stable source and assembly references, exact owner resolution, unsupported declarations, and recovery errors.
  • Find Symbol: Name and pattern matching, kind filters, and source scope behavior for the Core symbol scanner.
  • Get Symbol Body: AST declaration extraction, batching, line windows, and unavailable-source cases.
  • Get File Skeleton: Top-level declarations without method bodies, structured Core results, and Markdown rendering.
  • Member Structure: Declared members, visibility, records and interfaces, filters, and truncation.
  • Call Tree Core Engine: Bounded Roslyn call graph traversal and ASCII/Mermaid rendering.
  • Find References and Implementations Core Engines: Solution-wide reference locations, implementation and override discovery, and result limits.
  • Reference summary: Discovered site counts, owner-qualified project/file identities, paging, and partial analysis.
  • Get Type Hierarchy Core Engine: Base chains, interfaces, transitive cross-project subtypes, and subtype limits.
  • Dependency Graph Core Scanner: Project and source type dependencies, project-qualified edges, paging, scan bounds, and recoverable document errors.
  • Resolve Type Origin: Source and metadata type origin results, exact source project ownership, and assembly-reference lookup.
  • Cross-Feature Relationship Contract: Caller-site identity, cross-project relationship behavior, and per-engine result limits.
  • Shared Navigation Context: Explicit Source and Assembly sections, shared symbol resolution, per-section paging, and partial errors.
  • Static Test Candidates: Test project/file/class detection and heuristic fixture and method recommendations.
  • Assembly Decompilation Core: Read-only binary fingerprinting, decompilation cache generations, native/invalid image handling, and the virtual Roslyn snapshot.
  • Assembly Navigation Core Scanners: Assembly context, bounded text/data/external-call searches, extension method discovery, and referenced type origins.