Function generateCompactSchemaGuide

packages/graph/src/generateSchemaGuide.ts:810–868

(schema: TSchema)

 * in system prompts or context windows with token limits.
 */
export function generateCompactSchemaGuide<TSchema extends GraphSchema>(schema: TSchema): string {
  const sections: string[] = [];

  sections.push("# Graph Query Language");
  sections.push("");

  // Compact Schema
  sections.push("**Schema:**");
  const vertexLabels = Object.keys(schema.vertices);
  const edgeLabels = Object.keys(schema.edges);

  if (vertexLabels.length > 0) {
    sections.push(`Vertices: ${vertexLabels.join(", ")}`);
    for (const label of vertexLabels) {
      const props = schema.vertices[label]?.properties;
      if (props && Object.keys(props).length > 0) {
        const propList = Object.keys(props).join(", ");
        sections.push(`  ${label}: {${propList}}`);
      }
    }
  }

  if (edgeLabels.length > 0) {
    sections.push(`Edges: ${edgeLabels.join(", ")}`);
  }
  sections.push("");

  // Compact Syntax
  sections.push("**Syntax:**");
  sections.push("```");
  sections.push("MATCH (v:Label)-[:edge]->(v2:Label2)");
  sections.push("WHERE v.property > value");
  sections.push("RETURN v [DISTINCT] [ORDER BY v.prop] [LIMIT n]");
  sections.push("```");
  sections.push("");
  sections.push(
    "**Note:** IDs use format `<EntityName>:<uuid>` (e.g., `User:12345678-1234-1234-1234-123456789abc`)",
  );
  sections.push("");

  // One complete example
  if (vertexLabels.length >= 2 && edgeLabels.length > 0) {
    const v1 = vertexLabels[0];
    const v2 = vertexLabels[1];
    const edge = edgeLabels[0];
    sections.push("**Examples:**");
    sections.push("```");
    sections.push(`// Query by ID`);
    sections.push(
      `MATCH (a:${v1}) WHERE a.@id = "${v1}:12345678-1234-1234-1234-123456789abc" RETURN a`,
    );
    sections.push("");
    sections.push(`// Traverse relationships`);
    sections.push(`MATCH (a:${v1})-[:${edge}]->(b:${v2}) RETURN b LIMIT 10`);
    sections.push("```");
  }

  return sections.join("\n");