Skip to main content

LLM-MCP Documentation Cross-Reference Guide

This document maps the relationships between different documentation sections and identifies where cross-references should be added to improve navigation and discoverability.

Table of Contents​

Documentation Relationship Map​

graph TD;
  A[Getting Started] --> B[Basic Usage Examples];
  A --> C[Tool Registration];
  A --> D[Vector Operations];
  A --> E[Configuration Guide];
  
  F[Architecture Overview] --> G[MCP Configuration];
  F --> H[API Reference];
  F --> I[Security Best Practices];
  
  J[Advanced Configuration] --> K[Performance Tuning];
  J --> L[Security Best Practices];
  J --> M[Monitoring and Logging];
  
  N[Custom Tool Development] --> O[Tool Registration];
  N --> P[API Reference];
  N --> Q[Examples];
  
  R[Deployment] --> S[Monitoring and Logging];
  R --> T[Security Best Practices];
  R --> U[Performance Tuning];
  
  V[Troubleshooting] --> W[Monitoring and Logging];
  V --> X[Common Issues];
  V --> Y[Performance Tuning];
  
  Z[Integration] --> AA[API Reference];
  Z --> AB[Custom Tool Development];
  Z --> AC[Examples];

Core Documentation Cross-References​

Architecture Overview (architecture/architecture-overview.md)​

Should reference:

  • API Reference (api/api-reference.md)
  • MCP Configuration (architecture/mcp-config.md)
  • Security Best Practices (security/security-best-practices.md)
  • Deployment Documentation (deployment/index.md)

API Reference (api/api-reference.md)​

Should reference:

  • Architecture Overview (architecture/architecture-overview.md)
  • Getting Started Guide (guides/getting-started.md)
  • Tool Registration Guide (guides/tool-registration.md)
  • Custom Tool Development (tools/custom-tool-development.md)
  • Examples (examples/basic-usage.md)

Getting Started Guide (guides/getting-started.md)​

Should reference:

  • Architecture Overview (architecture/architecture-overview.md)
  • Basic Usage Examples (examples/basic-usage.md)
  • Tool Registration Guide (guides/tool-registration.md)
  • Vector Operations Guide (guides/vector-operations.md)
  • Configuration Guide (guides/configuration.md)
  • Troubleshooting (troubleshooting/troubleshooting.md)

Tool Registration Guide (guides/tool-registration.md)​

Should reference:

  • Custom Tool Development (tools/custom-tool-development.md)
  • API Reference (api/api-reference.md)
  • Basic Usage Examples (examples/basic-usage.md)
  • Vector Operations Guide (guides/vector-operations.md)

Vector Operations Guide (guides/vector-operations.md)​

Should reference:

  • API Reference (api/api-reference.md)
  • Basic Usage Examples (examples/basic-usage.md)
  • Performance Tuning (performance/performance-tuning.md)

Advanced Documentation Cross-References​

Advanced Configuration (configuration/advanced-configuration.md)​

Should reference:

  • MCP Configuration (architecture/mcp-config.md)
  • Security Best Practices (security/security-best-practices.md)
  • Performance Tuning (performance/performance-tuning.md)
  • Monitoring and Logging (monitoring/monitoring-and-logging.md)
  • Deployment Documentation (deployment/index.md)

Performance Tuning (performance/performance-tuning.md)​

Should reference:

  • Advanced Configuration (configuration/advanced-configuration.md)
  • Monitoring and Logging (monitoring/monitoring-and-logging.md)
  • Vector Operations Guide (guides/vector-operations.md)
  • Troubleshooting (troubleshooting/troubleshooting.md)

Security Best Practices (security/security-best-practices.md)​

Should reference:

  • Advanced Configuration (configuration/advanced-configuration.md)
  • Deployment Documentation (deployment/index.md)
  • Monitoring and Logging (monitoring/monitoring-and-logging.md)
  • API Reference (api/api-reference.md)

Custom Tool Development (tools/custom-tool-development.md)​

Should reference:

  • Tool Registration Guide (guides/tool-registration.md)
  • API Reference (api/api-reference.md)
  • Security Best Practices (security/security-best-practices.md)
  • Performance Tuning (performance/performance-tuning.md)
  • Examples (examples/basic-usage.md)

Monitoring and Logging (monitoring/monitoring-and-logging.md)​

Should reference:

  • Advanced Configuration (configuration/advanced-configuration.md)
  • Performance Tuning (performance/performance-tuning.md)
  • Deployment Documentation (deployment/index.md)
  • Troubleshooting (troubleshooting/troubleshooting.md)

Integration Cross-References​

BFAPI-BFLLM Integration (integration/bfapi-bfllm-integration.md)​

Should reference:

  • API Reference (api/api-reference.md)
  • Custom Tool Development (tools/custom-tool-development.md)
  • Examples (examples/basic-usage.md)
  • Architecture Overview (architecture/architecture-overview.md)

Drupal Integration (integration/drupal-integration.md)​

Should reference:

  • API Reference (api/api-reference.md)
  • Custom Tool Development (tools/custom-tool-development.md)
  • Examples (examples/basic-usage.md)
  • Architecture Overview (architecture/architecture-overview.md)

Examples Cross-References​

Basic Usage Examples (examples/basic-usage.md)​

Should reference:

  • Getting Started Guide (guides/getting-started.md)
  • API Reference (api/api-reference.md)
  • Tool Registration Guide (guides/tool-registration.md)
  • Vector Operations Guide (guides/vector-operations.md)
  • Custom Tool Development (tools/custom-tool-development.md)

Troubleshooting Cross-References​

Troubleshooting Guide (troubleshooting/troubleshooting.md)​

Should reference:

  • Monitoring and Logging (monitoring/monitoring-and-logging.md)
  • Performance Tuning (performance/performance-tuning.md)
  • Advanced Configuration (configuration/advanced-configuration.md)
  • API Reference (api/api-reference.md)
  • Security Best Practices (security/security-best-practices.md)

Implementation Guide​

To add cross-references to a document:

  1. Add a "Related Documentation" or "See Also" section at the end of the document
  2. Use relative paths for links to other documentation files
  3. Include a brief description of what the reader will find in the linked document
  4. Also add contextual links within the document text where appropriate

Example "See Also" Section​

## See Also

- [API Reference](../../api/api-reference.md) - Detailed API endpoint documentation
- [Custom Tool Development](../../tools/custom-tool-development.md) - Guide for developing custom tools
- [Performance Tuning](../../performance/performance-tuning.md) - Tips for optimizing performance
Configure the authentication method in your `config.json` file. See the [Advanced Configuration Guide](../../configuration/advanced-configuration.md#authentication) for detailed options.

This cross-reference guide should be used when updating documentation to ensure proper connections between related topics.