Function generateSchemaGuide

packages/graph/src/generateSchemaGuide.ts:400–804

(schema: TSchema)

 * the LLM about both the query language syntax and the specific graph structure.
 */
export function generateSchemaGuide<TSchema extends GraphSchema>(schema: TSchema): string {
  const sections: string[] = [];

  // Header
  sections.push("# Graph Query Language Guide");
  sections.push("");
  sections.push(
    "This graph database supports a declarative query language for traversing and querying graph data.",
  );
  sections.push("");

  // Schema Overview
  sections.push("## Graph Schema");
  sections.push("");
  sections.push("### Vertex Types");
  sections.push("");

  const vertexLabels = Object.keys(schema.vertices);
  if (vertexLabels.length === 0) {
    sections.push("No vertex types defined.");
  } else {
    for (const label of vertexLabels) {
      const properties = schema.vertices[label]?.properties;
      sections.push(`**${label}**`);

      if (properties && Object.keys(properties).length > 0) {
        sections.push("Properties:");
        for (const [propName] of Object.entries(properties)) {
          sections.push(`  - \`${propName}\``);
        }
      } else {
        sections.push("  No properties defined.");
      }
      sections.push("");
    }
  }

  sections.push("### Edge Types");
  sections.push("");

  const edgeLabels = Object.keys(schema.edges);
  if (edgeLabels.length === 0) {
    sections.push("No edge types defined.");
  } else {
    for (const label of edgeLabels) {
      const properties = schema.edges[label]?.properties;
      sections.push(`**${label}**`);

      if (properties && Object.keys(properties).length > 0) {
        sections.push("Properties:");
        for (const [propName] of Object.entries(properties)) {
          sections.push(`  - \`${propName}\``);
        }
      } else {
        sections.push("  No properties defined.");
      }
      sections.push("");
    }