@polymorphism-tech/morph-spec 7.7.3 → 7.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (187) hide show
  1. package/README.md +2 -2
  2. package/bin/validate.js +379 -379
  3. package/claude-plugin.json +1 -1
  4. package/docs/CHEATSHEET.md +1 -1
  5. package/docs/QUICKSTART.md +1 -1
  6. package/framework/CLAUDE.md +1 -1
  7. package/framework/MORPH.md +3 -2
  8. package/framework/agents.json +1 -1
  9. package/framework/commands/commit.md +166 -166
  10. package/framework/commands/morph-infra.md +215 -215
  11. package/framework/commands/morph-preflight.md +205 -205
  12. package/framework/commands/morph-troubleshoot.md +124 -124
  13. package/framework/evals/scenarios/dotnet-crud.yaml +1 -1
  14. package/framework/hooks/claude-code/statusline.py +679 -679
  15. package/framework/hooks/claude-code/statusline.sh +11 -11
  16. package/framework/hooks/git/commit-msg/conventional-commits.sh +33 -33
  17. package/framework/hooks/git/pre-commit/agents.sh +25 -25
  18. package/framework/hooks/git/pre-commit/orchestrator.sh +64 -64
  19. package/framework/hooks/git/pre-commit/specs.sh +50 -50
  20. package/framework/hooks/git/pre-push/run-tests.sh +44 -44
  21. package/framework/hooks/shared/activity-logger.js +160 -160
  22. package/framework/hooks/shared/hook-response.js +45 -45
  23. package/framework/hooks/shared/payload-utils.js +78 -78
  24. package/framework/hooks/shared/stdin-reader.js +26 -26
  25. package/framework/rubrics/backend.json +41 -41
  26. package/framework/rules/ai-agents-standards.md +45 -45
  27. package/framework/rules/dotnet-templates.md +86 -87
  28. package/framework/rules/frontend-standards.md +13 -13
  29. package/framework/rules/infrastructure-standards.md +27 -27
  30. package/framework/rules/neon-standards.md +25 -25
  31. package/framework/rules/nextjs-standards.md +20 -20
  32. package/framework/rules/nextjs-templates.md +40 -40
  33. package/framework/skills/core/create-umbraco-lp/SKILL.md +1 -1
  34. package/framework/skills/core/migrate-lp-to-umbraco/SKILL.md +1 -1
  35. package/framework/skills/core/morph-apply/SKILL.md +1 -1
  36. package/framework/skills/core/morph-brainstorming/SKILL.md +9 -5
  37. package/framework/skills/core/morph-eval/SKILL.md +1 -1
  38. package/framework/skills/core/morph-implement/SKILL.md +1 -1
  39. package/framework/skills/core/morph-plan/SKILL.md +11 -6
  40. package/framework/skills/core/morph-proposal/SKILL.md +1 -1
  41. package/framework/skills/core/morph-review/SKILL.md +13 -7
  42. package/framework/skills/core/morph-stack-scan/SKILL.md +5 -5
  43. package/framework/skills/core/morph-standards/SKILL.md +1 -1
  44. package/framework/standards/STANDARDS.json +1 -1
  45. package/framework/standards/ai-agents/agent-session.md +160 -160
  46. package/framework/standards/ai-agents/batching.md +193 -193
  47. package/framework/standards/ai-agents/context-providers.md +188 -188
  48. package/framework/standards/ai-agents/mcp-server.md +250 -250
  49. package/framework/standards/ai-agents/mcp-tools.md +197 -197
  50. package/framework/standards/ai-agents/middleware-patterns.md +207 -207
  51. package/framework/standards/ai-agents/modalities-image-gen.md +173 -173
  52. package/framework/standards/ai-agents/modalities-speech-to-text.md +171 -171
  53. package/framework/standards/ai-agents/modalities-text-to-speech.md +181 -181
  54. package/framework/standards/ai-agents/modalities-vision.md +201 -201
  55. package/framework/standards/ai-agents/multi-agent-patterns.md +155 -155
  56. package/framework/standards/ai-agents/production.md +275 -275
  57. package/framework/standards/ai-agents/prompts-in-db.md +214 -214
  58. package/framework/standards/ai-agents/providers/model-registry.md +158 -158
  59. package/framework/standards/ai-agents/service-tier-flex.md +135 -135
  60. package/framework/standards/ai-agents/structured-output.md +249 -249
  61. package/framework/standards/ai-agents/sweet-spot.md +109 -109
  62. package/framework/standards/architecture/vertical-slice/vertical-slice.md +34 -35
  63. package/framework/standards/backend/api/validation.md +2 -2
  64. package/framework/standards/backend/dotnet/scrutor.md +1 -3
  65. package/framework/standards/backend/dotnet/vsa-handler-patterns.md +42 -37
  66. package/framework/standards/data/nosql/cache/redis.md +2 -2
  67. package/framework/templates/CLAUDE.md.core.template +1 -1
  68. package/framework/templates/IDE-SNIPPETS.md +262 -262
  69. package/framework/templates/README.md +0 -1
  70. package/framework/templates/REGISTRY.json +0 -21
  71. package/framework/templates/code/dotnet/abstractions/api-endpoint.cs +7 -7
  72. package/framework/templates/code/dotnet/abstractions/handler.cs +0 -3
  73. package/framework/templates/code/dotnet/ai-agents/AgentBootstrap.cs.template +39 -39
  74. package/framework/templates/code/dotnet/ai-agents/EmbeddingService.cs.template +68 -68
  75. package/framework/templates/code/dotnet/ai-agents/ModelRegistry.cs.template +117 -117
  76. package/framework/templates/code/dotnet/ai-agents/PromptRepository.cs.template +95 -95
  77. package/framework/templates/code/dotnet/ai-agents/ResilientToolMiddleware.cs.template +61 -61
  78. package/framework/templates/code/dotnet/ai-agents/VectorSearchTool.cs.template +107 -107
  79. package/framework/templates/code/dotnet/ai-agents/model-registry.json.template +58 -58
  80. package/framework/templates/code/dotnet/constants/api-tags.cs +1 -1
  81. package/framework/templates/code/dotnet/contracts/contracts-vsa.cs +281 -282
  82. package/framework/templates/code/dotnet/database/migration.cs +83 -83
  83. package/framework/templates/code/dotnet/feature/endpoint.cs.hbs +21 -21
  84. package/framework/templates/code/dotnet/feature/handler.cs.hbs +23 -24
  85. package/framework/templates/code/dotnet/feature/request.cs.hbs +4 -4
  86. package/framework/templates/code/dotnet/feature/response.cs.hbs +4 -4
  87. package/framework/templates/code/dotnet/feature/validator.cs.hbs +15 -15
  88. package/framework/templates/code/dotnet/jobs/job.cs +15 -15
  89. package/framework/templates/code/dotnet/test.cs +72 -101
  90. package/framework/templates/code/sql/ai-agents/agent-prompts-migration.sql.template +58 -58
  91. package/framework/templates/code/sql/ai-agents/pgvector-embeddings-migration.sql.template +91 -91
  92. package/framework/templates/code/typescript/contracts.ts +167 -167
  93. package/framework/templates/docs/clarifications.md +253 -253
  94. package/framework/templates/docs/schema-analysis.md +119 -119
  95. package/framework/templates/docs/ui-components.md +52 -52
  96. package/framework/templates/docs/ui-design-system.md +76 -76
  97. package/framework/templates/docs/ui-flows.md +167 -167
  98. package/framework/templates/docs/ui-mockups.md +98 -98
  99. package/framework/templates/feature/decisions.md +122 -122
  100. package/framework/templates/frontend/nextjs/Dockerfile.nextjs.hbs +43 -43
  101. package/framework/templates/frontend/nextjs/client-component.tsx.hbs +26 -26
  102. package/framework/templates/frontend/nextjs/env.mjs.hbs +32 -32
  103. package/framework/templates/frontend/nextjs/feature-form.tsx.hbs +56 -56
  104. package/framework/templates/frontend/nextjs/page.tsx.hbs +22 -22
  105. package/framework/templates/frontend/nextjs/tsconfig.json.hbs +26 -26
  106. package/framework/templates/frontend/nextjs/use-feature.ts.hbs +54 -54
  107. package/framework/templates/infrastructure/docker/Dockerfile.template +58 -58
  108. package/framework/templates/infrastructure/docker/docker-compose.template.yml +50 -50
  109. package/framework/templates/infrastructure/docker/dockerfile-api.dockerfile +38 -38
  110. package/framework/templates/infrastructure/docker/dockerfile-web.dockerfile +48 -48
  111. package/framework/templates/infrastructure/github/README.md +56 -56
  112. package/framework/templates/infrastructure/github/actions/docker-build-push/action.yml.hbs +45 -45
  113. package/framework/templates/infrastructure/github/actions/health-check/action.yml.hbs +27 -27
  114. package/framework/templates/infrastructure/github/workflows/docker-build-push.yml.hbs +59 -59
  115. package/framework/templates/infrastructure/github/workflows/dotnet-build.yml.hbs +39 -39
  116. package/framework/templates/integrations/asaas-client.cs +387 -387
  117. package/framework/templates/integrations/asaas-webhook.cs +351 -351
  118. package/framework/templates/meta-prompts/fusion/fusion-agent.md +76 -76
  119. package/framework/templates/meta-prompts/fusion/fusion-aggregator.md +100 -100
  120. package/framework/templates/meta-prompts/parallel-workers/parallel-coordinator.md +113 -113
  121. package/framework/templates/meta-prompts/validators/pre-commit-validator.md +95 -95
  122. package/framework/templates/project/validate.js +120 -120
  123. package/framework/templates/state.template.json +17 -17
  124. package/framework/templates/ui/design-system.css +226 -226
  125. package/package.json +1 -1
  126. package/src/commands/dashboard/dashboard.js +53 -53
  127. package/src/commands/index.js +13 -13
  128. package/src/commands/mcp/mcp-setup.js +519 -519
  129. package/src/commands/project/checkpoint.js +209 -209
  130. package/src/commands/project/update.js +7 -4
  131. package/src/core/state/phase-state-machine.js +197 -197
  132. package/src/core/templates/template-renderer.js +477 -477
  133. package/src/dashboard/app/components/DetailPanel.jsx +11 -11
  134. package/src/dashboard/app/components/FlowGraph.jsx +17 -17
  135. package/src/dashboard/app/components/SearchFilter.jsx +22 -22
  136. package/src/dashboard/app/hooks/useDetailPanel.js +15 -15
  137. package/src/dashboard/app/main.jsx +13 -13
  138. package/src/dashboard/app/pages/AgentMap.jsx +370 -370
  139. package/src/dashboard/app/pages/HookInspector.jsx +418 -418
  140. package/src/dashboard/app/pages/LiveState.jsx +239 -239
  141. package/src/dashboard/app/pages/PhasePipeline.jsx +408 -408
  142. package/src/dashboard/app/pages/RulesMap.jsx +273 -273
  143. package/src/dashboard/app/pages/SkillsLibrary.jsx +366 -366
  144. package/src/dashboard/app/pages/Standards.jsx +332 -332
  145. package/src/dashboard/app/styles/index.css +47 -47
  146. package/src/dashboard/index.html +12 -12
  147. package/src/dashboard/package.json +24 -24
  148. package/src/dashboard/scanner/hooks-scanner.js +41 -41
  149. package/src/dashboard/scanner/phases-scanner.js +15 -15
  150. package/src/dashboard/scanner/rubrics-scanner.js +12 -12
  151. package/src/dashboard/scanner/rules-scanner.js +37 -37
  152. package/src/dashboard/scanner/skills-scanner.js +43 -43
  153. package/src/dashboard/scanner/squads-scanner.js +13 -13
  154. package/src/dashboard/scanner/standards-scanner.js +26 -26
  155. package/src/dashboard/vite-plugin-morph-data.js +17 -17
  156. package/src/dashboard/vite.config.js +24 -24
  157. package/src/lib/agents/metrics-aggregator.js +56 -56
  158. package/src/lib/agents/metrics-calculator.js +125 -125
  159. package/src/lib/agents/output-collector.js +73 -73
  160. package/src/lib/detectors/claude-config-detector.js +152 -152
  161. package/src/lib/detectors/design-system-detector.js +231 -231
  162. package/src/lib/detectors/index.js +217 -217
  163. package/src/lib/generators/architecture-scanner.js +639 -639
  164. package/src/lib/generators/design-system-generator.js +508 -508
  165. package/src/lib/generators/index.js +13 -13
  166. package/src/lib/generators/settings-generator.js +209 -209
  167. package/src/lib/hooks/hook-executor.js +167 -167
  168. package/src/lib/installers/mcp-installer.js +719 -719
  169. package/src/lib/tasks/task-classifier.js +30 -30
  170. package/src/lib/tasks/task-parser.js +209 -209
  171. package/src/lib/tasks/test-runner.js +81 -81
  172. package/src/lib/validators/architecture/architecture-validator.js +259 -259
  173. package/src/lib/validators/checkpoint-persistence.js +39 -39
  174. package/src/lib/validators/contracts/contract-compliance-validator.js +274 -274
  175. package/src/lib/validators/css/css-validator.js +340 -340
  176. package/src/lib/validators/packages/package-validator.js +347 -347
  177. package/src/lib/validators/shared/emit-validator-dispatch.js +14 -14
  178. package/src/lib/validators/shared/issue-counter.js +14 -14
  179. package/src/lib/validators/validation-runner.js +349 -349
  180. package/src/scripts/setup-infra.js +383 -383
  181. package/src/utils/agent-id-mapper.js +11 -11
  182. package/src/utils/banner.js +52 -43
  183. package/src/utils/claude-settings-manager.js +300 -300
  184. package/src/utils/skills-installer.js +172 -172
  185. package/framework/templates/.idea/morph-templates.xml +0 -92
  186. package/framework/templates/.vscode/morph-templates.code-snippets +0 -186
  187. package/framework/templates/code/dotnet/backend/repository.cs +0 -141
@@ -1,61 +1,61 @@
1
- // TEMPLATE: ResilientToolMiddleware.cs
2
- // PURPOSE: Function-calling middleware — retry/rate-limit resilience + anti-hallucination arg validation.
3
- // READS STANDARD: ai-agents-middleware-patterns
4
- // PLACEHOLDERS:
5
- // {{PROJECT_NAMESPACE}} — root namespace of the project
6
- // LAST-VERIFIED: 2026-05-19
7
-
8
- using Microsoft.Agents.AI;
9
- using Microsoft.Extensions.AI;
10
-
11
- namespace {{PROJECT_NAMESPACE}}.AI;
12
-
13
- /// <summary>
14
- /// Function-calling middleware that provides resilience (rate-limit + timeout handling)
15
- /// and anti-hallucination argument validation.
16
- ///
17
- /// Registration:
18
- /// agent.AsBuilder().Use(ResilientToolMiddleware.Handle).Build();
19
- /// </summary>
20
- public static class ResilientToolMiddleware
21
- {
22
- public static async ValueTask<object?> Handle(
23
- AIAgent agent,
24
- FunctionInvocationContext context,
25
- Func<FunctionInvocationContext, CancellationToken, ValueTask<object?>> next,
26
- CancellationToken cancellationToken)
27
- {
28
- // ─── Anti-hallucination: validate LLM-generated arguments BEFORE calling the tool ───
29
- // If an argument is malformed, return a descriptive error string — the agent will
30
- // self-correct on the next iteration without needing an external retry.
31
- //
32
- // Example: validate 'date' is ISO 8601
33
- if (context.Arguments.TryGetValue("date", out var dateArg)
34
- && !DateTime.TryParse(dateArg?.ToString(), out _))
35
- {
36
- return $"Invalid date format for '{context.Function.Name}'. Expected ISO 8601 (e.g. 2026-01-31).";
37
- }
38
- //
39
- // Add additional argument validations here following the same pattern:
40
- // if (context.Arguments.TryGetValue("argName", out var val) && <invalid condition>)
41
- // return $"Descriptive error for '{context.Function.Name}': <what was wrong>.";
42
-
43
- // ─── Resilience: execute tool and handle failures ───
44
- try
45
- {
46
- return await next(context, cancellationToken);
47
- }
48
- catch (HttpRequestException ex) when (ex.StatusCode == System.Net.HttpStatusCode.TooManyRequests)
49
- {
50
- return "Service is temporarily busy. Please try again in a moment.";
51
- }
52
- catch (TimeoutException)
53
- {
54
- return $"Tool '{context.Function.Name}' timed out. Try a simpler query.";
55
- }
56
- catch (Exception ex)
57
- {
58
- return $"Error in {context.Function.Name}: {ex.Message}";
59
- }
60
- }
61
- }
1
+ // TEMPLATE: ResilientToolMiddleware.cs
2
+ // PURPOSE: Function-calling middleware — retry/rate-limit resilience + anti-hallucination arg validation.
3
+ // READS STANDARD: ai-agents-middleware-patterns
4
+ // PLACEHOLDERS:
5
+ // {{PROJECT_NAMESPACE}} — root namespace of the project
6
+ // LAST-VERIFIED: 2026-05-19
7
+
8
+ using Microsoft.Agents.AI;
9
+ using Microsoft.Extensions.AI;
10
+
11
+ namespace {{PROJECT_NAMESPACE}}.AI;
12
+
13
+ /// <summary>
14
+ /// Function-calling middleware that provides resilience (rate-limit + timeout handling)
15
+ /// and anti-hallucination argument validation.
16
+ ///
17
+ /// Registration:
18
+ /// agent.AsBuilder().Use(ResilientToolMiddleware.Handle).Build();
19
+ /// </summary>
20
+ public static class ResilientToolMiddleware
21
+ {
22
+ public static async ValueTask<object?> Handle(
23
+ AIAgent agent,
24
+ FunctionInvocationContext context,
25
+ Func<FunctionInvocationContext, CancellationToken, ValueTask<object?>> next,
26
+ CancellationToken cancellationToken)
27
+ {
28
+ // ─── Anti-hallucination: validate LLM-generated arguments BEFORE calling the tool ───
29
+ // If an argument is malformed, return a descriptive error string — the agent will
30
+ // self-correct on the next iteration without needing an external retry.
31
+ //
32
+ // Example: validate 'date' is ISO 8601
33
+ if (context.Arguments.TryGetValue("date", out var dateArg)
34
+ && !DateTime.TryParse(dateArg?.ToString(), out _))
35
+ {
36
+ return $"Invalid date format for '{context.Function.Name}'. Expected ISO 8601 (e.g. 2026-01-31).";
37
+ }
38
+ //
39
+ // Add additional argument validations here following the same pattern:
40
+ // if (context.Arguments.TryGetValue("argName", out var val) && <invalid condition>)
41
+ // return $"Descriptive error for '{context.Function.Name}': <what was wrong>.";
42
+
43
+ // ─── Resilience: execute tool and handle failures ───
44
+ try
45
+ {
46
+ return await next(context, cancellationToken);
47
+ }
48
+ catch (HttpRequestException ex) when (ex.StatusCode == System.Net.HttpStatusCode.TooManyRequests)
49
+ {
50
+ return "Service is temporarily busy. Please try again in a moment.";
51
+ }
52
+ catch (TimeoutException)
53
+ {
54
+ return $"Tool '{context.Function.Name}' timed out. Try a simpler query.";
55
+ }
56
+ catch (Exception ex)
57
+ {
58
+ return $"Error in {context.Function.Name}: {ex.Message}";
59
+ }
60
+ }
61
+ }
@@ -1,107 +1,107 @@
1
- // TEMPLATE: VectorSearchTool.cs
2
- // PURPOSE: A typed MAF tool that retrieves relevant chunks from the pgvector knowledge base.
3
- // READS STANDARD: ai-agents-rag-custom-pgvector
4
- // PLACEHOLDERS:
5
- // {{PROJECT_NAMESPACE}} — root namespace of the project (e.g., MyProject)
6
- // LAST-VERIFIED: 2026-05-19
7
- //
8
- // SECURITY NOTE — tenant_id:
9
- // tenant_id is resolved from the injected ITenantContext (or equivalent auth accessor),
10
- // NEVER from a tool parameter visible to the LLM. A model-facing tenant parameter would
11
- // allow prompt-injection to cross tenant boundaries.
12
- //
13
- // NPGSQL + PGVECTOR PARAMETER BINDING:
14
- // This template uses NpgsqlDataSource (raw SQL) for the cosine-distance query.
15
- // The project must call dataSourceBuilder.UseVector() before building the data source
16
- // so Npgsql can map the vector type — see infrastructure-neon-pgvector.
17
- //
18
- // // VERIFY: The exact Npgsql parameter binding for a pgvector type has been written
19
- // // conservatively below using new Pgvector.Vector(float[]).
20
- // // Confirmed pattern from neon-pgvector standard (Pgvector package):
21
- // // cmd.Parameters.AddWithValue("queryVec", new Pgvector.Vector(embedding.ToArray()));
22
- // // If the project uses a different Npgsql/Pgvector version, verify the parameter API.
23
- //
24
- // REGISTRATION (in agent setup code):
25
- // var tool = sp.GetRequiredService<VectorSearchTool>();
26
- // var agent = modelRegistry.GetChatClient("text-default")
27
- // .AsAIAgent(
28
- // instructions: systemPrompt,
29
- // tools: [AIFunctionFactory.Create(tool.SearchAsync)]);
30
- //
31
- // ALTERNATIVE — EF Core:
32
- // If the project already wires pgvector through EF Core (UseVector(), HasMethod("hnsw")),
33
- // replace the NpgsqlDataSource usage with db.Database.SqlQuery<string>() per
34
- // infrastructure-neon-pgvector. The tool method signature stays identical.
35
-
36
- using System.ComponentModel;
37
- using Npgsql;
38
- using Pgvector;
39
-
40
- namespace {{PROJECT_NAMESPACE}}.AI;
41
-
42
- /// <summary>
43
- /// MAF tool: searches the knowledge base for chunks semantically similar to a query.
44
- /// Registered on an agent via <c>AIFunctionFactory.Create(tool.SearchAsync)</c>.
45
- /// The agent calls this autonomously when it needs grounding context.
46
- /// </summary>
47
- public sealed class VectorSearchTool(
48
- EmbeddingService embeddingService,
49
- NpgsqlDataSource dataSource,
50
- ITenantContext tenantContext) // Resolved from DI — scoped to the authenticated request.
51
- // Replace with Guid currentTenantId if a simpler accessor is preferred.
52
- {
53
- private const int DefaultTopK = 5;
54
-
55
- /// <summary>
56
- /// Searches the knowledge base for context relevant to a question.
57
- /// </summary>
58
- /// <param name="query">The natural-language search query.</param>
59
- /// <param name="ct">Cancellation token.</param>
60
- /// <returns>
61
- /// Concatenated text of the top matching chunks, separated by double newlines.
62
- /// Returns an empty string if no results are found.
63
- /// </returns>
64
- [Description("Searches the knowledge base for context relevant to a question")]
65
- public async Task<string> SearchAsync(
66
- [Description("the natural-language search query")] string query,
67
- CancellationToken ct = default)
68
- {
69
- // 1. Embed the query at search time.
70
- ReadOnlyMemory<float> queryVector = await embeddingService.EmbedAsync(query, ct);
71
-
72
- // 2. Resolve tenant from auth context — never from a model-supplied parameter.
73
- Guid tenantId = tenantContext.CurrentTenantId;
74
-
75
- // 3. Run parameterized cosine-distance query.
76
- // ORDER BY embedding <=> @queryVec sorts ascending by distance (most similar first).
77
- const string sql = """
78
- SELECT content
79
- FROM kb_embeddings
80
- WHERE tenant_id = @tenant
81
- ORDER BY embedding <=> @queryVec
82
- LIMIT @topK
83
- """;
84
-
85
- var chunks = new List<string>(DefaultTopK);
86
-
87
- await using var conn = await dataSource.OpenConnectionAsync(ct);
88
- await using var cmd = new NpgsqlCommand(sql, conn);
89
-
90
- cmd.Parameters.AddWithValue("tenant", tenantId);
91
-
92
- // VERIFY: Pgvector.Vector wraps a float[] for Npgsql parameter binding.
93
- // The project must have called dataSourceBuilder.UseVector() on NpgsqlDataSourceBuilder.
94
- // NuGet: Pgvector (matches the Pgvector.EntityFrameworkCore used in neon-pgvector.md).
95
- cmd.Parameters.AddWithValue("queryVec", new Vector(queryVector.ToArray()));
96
-
97
- cmd.Parameters.AddWithValue("topK", DefaultTopK);
98
-
99
- await using var reader = await cmd.ExecuteReaderAsync(ct);
100
- while (await reader.ReadAsync(ct))
101
- {
102
- chunks.Add(reader.GetString(0));
103
- }
104
-
105
- return string.Join("\n\n", chunks);
106
- }
107
- }
1
+ // TEMPLATE: VectorSearchTool.cs
2
+ // PURPOSE: A typed MAF tool that retrieves relevant chunks from the pgvector knowledge base.
3
+ // READS STANDARD: ai-agents-rag-custom-pgvector
4
+ // PLACEHOLDERS:
5
+ // {{PROJECT_NAMESPACE}} — root namespace of the project (e.g., MyProject)
6
+ // LAST-VERIFIED: 2026-05-19
7
+ //
8
+ // SECURITY NOTE — tenant_id:
9
+ // tenant_id is resolved from the injected ITenantContext (or equivalent auth accessor),
10
+ // NEVER from a tool parameter visible to the LLM. A model-facing tenant parameter would
11
+ // allow prompt-injection to cross tenant boundaries.
12
+ //
13
+ // NPGSQL + PGVECTOR PARAMETER BINDING:
14
+ // This template uses NpgsqlDataSource (raw SQL) for the cosine-distance query.
15
+ // The project must call dataSourceBuilder.UseVector() before building the data source
16
+ // so Npgsql can map the vector type — see infrastructure-neon-pgvector.
17
+ //
18
+ // // VERIFY: The exact Npgsql parameter binding for a pgvector type has been written
19
+ // // conservatively below using new Pgvector.Vector(float[]).
20
+ // // Confirmed pattern from neon-pgvector standard (Pgvector package):
21
+ // // cmd.Parameters.AddWithValue("queryVec", new Pgvector.Vector(embedding.ToArray()));
22
+ // // If the project uses a different Npgsql/Pgvector version, verify the parameter API.
23
+ //
24
+ // REGISTRATION (in agent setup code):
25
+ // var tool = sp.GetRequiredService<VectorSearchTool>();
26
+ // var agent = modelRegistry.GetChatClient("text-default")
27
+ // .AsAIAgent(
28
+ // instructions: systemPrompt,
29
+ // tools: [AIFunctionFactory.Create(tool.SearchAsync)]);
30
+ //
31
+ // ALTERNATIVE — EF Core:
32
+ // If the project already wires pgvector through EF Core (UseVector(), HasMethod("hnsw")),
33
+ // replace the NpgsqlDataSource usage with db.Database.SqlQuery<string>() per
34
+ // infrastructure-neon-pgvector. The tool method signature stays identical.
35
+
36
+ using System.ComponentModel;
37
+ using Npgsql;
38
+ using Pgvector;
39
+
40
+ namespace {{PROJECT_NAMESPACE}}.AI;
41
+
42
+ /// <summary>
43
+ /// MAF tool: searches the knowledge base for chunks semantically similar to a query.
44
+ /// Registered on an agent via <c>AIFunctionFactory.Create(tool.SearchAsync)</c>.
45
+ /// The agent calls this autonomously when it needs grounding context.
46
+ /// </summary>
47
+ public sealed class VectorSearchTool(
48
+ EmbeddingService embeddingService,
49
+ NpgsqlDataSource dataSource,
50
+ ITenantContext tenantContext) // Resolved from DI — scoped to the authenticated request.
51
+ // Replace with Guid currentTenantId if a simpler accessor is preferred.
52
+ {
53
+ private const int DefaultTopK = 5;
54
+
55
+ /// <summary>
56
+ /// Searches the knowledge base for context relevant to a question.
57
+ /// </summary>
58
+ /// <param name="query">The natural-language search query.</param>
59
+ /// <param name="ct">Cancellation token.</param>
60
+ /// <returns>
61
+ /// Concatenated text of the top matching chunks, separated by double newlines.
62
+ /// Returns an empty string if no results are found.
63
+ /// </returns>
64
+ [Description("Searches the knowledge base for context relevant to a question")]
65
+ public async Task<string> SearchAsync(
66
+ [Description("the natural-language search query")] string query,
67
+ CancellationToken ct = default)
68
+ {
69
+ // 1. Embed the query at search time.
70
+ ReadOnlyMemory<float> queryVector = await embeddingService.EmbedAsync(query, ct);
71
+
72
+ // 2. Resolve tenant from auth context — never from a model-supplied parameter.
73
+ Guid tenantId = tenantContext.CurrentTenantId;
74
+
75
+ // 3. Run parameterized cosine-distance query.
76
+ // ORDER BY embedding <=> @queryVec sorts ascending by distance (most similar first).
77
+ const string sql = """
78
+ SELECT content
79
+ FROM kb_embeddings
80
+ WHERE tenant_id = @tenant
81
+ ORDER BY embedding <=> @queryVec
82
+ LIMIT @topK
83
+ """;
84
+
85
+ var chunks = new List<string>(DefaultTopK);
86
+
87
+ await using var conn = await dataSource.OpenConnectionAsync(ct);
88
+ await using var cmd = new NpgsqlCommand(sql, conn);
89
+
90
+ cmd.Parameters.AddWithValue("tenant", tenantId);
91
+
92
+ // VERIFY: Pgvector.Vector wraps a float[] for Npgsql parameter binding.
93
+ // The project must have called dataSourceBuilder.UseVector() on NpgsqlDataSourceBuilder.
94
+ // NuGet: Pgvector (matches the Pgvector.EntityFrameworkCore used in neon-pgvector.md).
95
+ cmd.Parameters.AddWithValue("queryVec", new Vector(queryVector.ToArray()));
96
+
97
+ cmd.Parameters.AddWithValue("topK", DefaultTopK);
98
+
99
+ await using var reader = await cmd.ExecuteReaderAsync(ct);
100
+ while (await reader.ReadAsync(ct))
101
+ {
102
+ chunks.Add(reader.GetString(0));
103
+ }
104
+
105
+ return string.Join("\n\n", chunks);
106
+ }
107
+ }
@@ -1,58 +1,58 @@
1
- // TEMPLATE: model-registry.json (place in project at config/model-registry.json)
2
- // PURPOSE: Single source of truth for model selection. Agents reference aliases, not models.
3
- // READS STANDARD: ai-agents-providers-model-registry
4
- // PROVIDERS: openai + ollama work out-of-the-box with the ModelRegistry template.
5
- // For google / anthropic, add a provider branch first (see the standard).
6
- // PLACEHOLDERS:
7
- // {{PROJECT_DEFAULT_ALIAS}} — alias used when none specified (default: "text-default")
8
- // LAST-VERIFIED: 2026-05-19
9
- {
10
- "$schema": "./model-registry.schema.json",
11
- "version": "1.0",
12
- "defaultAlias": "{{PROJECT_DEFAULT_ALIAS}}",
13
- "aliases": {
14
- "text-default": {
15
- "provider": "openai",
16
- "model": "gpt-4o-mini",
17
- "options": { "temperature": 0.7 }
18
- },
19
- "text-heavy": {
20
- "provider": "openai",
21
- "model": "gpt-4o",
22
- "options": { "temperature": 0.5 }
23
- },
24
- "reasoning": {
25
- "provider": "openai",
26
- "model": "o3-mini",
27
- "options": { "reasoningEffort": "medium" }
28
- },
29
- "long-form": {
30
- "provider": "anthropic",
31
- "model": "claude-sonnet-4-6",
32
- "options": {}
33
- },
34
- "vision": {
35
- "provider": "google",
36
- "model": "gemini-2.5-flash",
37
- "options": {}
38
- },
39
- "embeddings": {
40
- "provider": "openai",
41
- "model": "text-embedding-3-small",
42
- "options": { "dimensions": 1536 }
43
- },
44
- "local-dev": {
45
- "provider": "ollama",
46
- "model": "llama3.2:3b",
47
- "options": { "endpoint": "http://localhost:11434/v1" }
48
- },
49
- "transcription": {
50
- "provider": "openai",
51
- "model": "whisper-1",
52
- "options": {}
53
- }
54
- },
55
- "fallback": {
56
- "text-default": "ollama/llama3.2:3b"
57
- }
58
- }
1
+ // TEMPLATE: model-registry.json (place in project at config/model-registry.json)
2
+ // PURPOSE: Single source of truth for model selection. Agents reference aliases, not models.
3
+ // READS STANDARD: ai-agents-providers-model-registry
4
+ // PROVIDERS: openai + ollama work out-of-the-box with the ModelRegistry template.
5
+ // For google / anthropic, add a provider branch first (see the standard).
6
+ // PLACEHOLDERS:
7
+ // {{PROJECT_DEFAULT_ALIAS}} — alias used when none specified (default: "text-default")
8
+ // LAST-VERIFIED: 2026-05-19
9
+ {
10
+ "$schema": "./model-registry.schema.json",
11
+ "version": "1.0",
12
+ "defaultAlias": "{{PROJECT_DEFAULT_ALIAS}}",
13
+ "aliases": {
14
+ "text-default": {
15
+ "provider": "openai",
16
+ "model": "gpt-4o-mini",
17
+ "options": { "temperature": 0.7 }
18
+ },
19
+ "text-heavy": {
20
+ "provider": "openai",
21
+ "model": "gpt-4o",
22
+ "options": { "temperature": 0.5 }
23
+ },
24
+ "reasoning": {
25
+ "provider": "openai",
26
+ "model": "o3-mini",
27
+ "options": { "reasoningEffort": "medium" }
28
+ },
29
+ "long-form": {
30
+ "provider": "anthropic",
31
+ "model": "claude-sonnet-4-6",
32
+ "options": {}
33
+ },
34
+ "vision": {
35
+ "provider": "google",
36
+ "model": "gemini-2.5-flash",
37
+ "options": {}
38
+ },
39
+ "embeddings": {
40
+ "provider": "openai",
41
+ "model": "text-embedding-3-small",
42
+ "options": { "dimensions": 1536 }
43
+ },
44
+ "local-dev": {
45
+ "provider": "ollama",
46
+ "model": "llama3.2:3b",
47
+ "options": { "endpoint": "http://localhost:11434/v1" }
48
+ },
49
+ "transcription": {
50
+ "provider": "openai",
51
+ "model": "whisper-1",
52
+ "options": {}
53
+ }
54
+ },
55
+ "fallback": {
56
+ "text-default": "ollama/llama3.2:3b"
57
+ }
58
+ }
@@ -2,5 +2,5 @@ namespace {{pascalCase PROJECT_NAME}}.Constants;
2
2
 
3
3
  public static class ApiTags
4
4
  {
5
- public const string {{pascalCase FEATURE_NAME}} = "{{pascalCase FEATURE_NAME}}";
5
+ public const string {{pascalCase FEATURE_NAME}}s = "{{kebabCase FEATURE_NAME}}s";
6
6
  }