feat: Added wrap-up prompt to save database context

Author: ESnark

.changeset/gold-dancers-judge.md

@@ -0,0 +1,5 @@
+---
+"ansible-database-mcp": minor
+---
+
+Added `wrap-up` prompt to save database context

src/assets/wrap-up.md

@@ -0,0 +1,84 @@
+Please analyze the SQL queries and database structure information from our previous conversation to generate a structured schema document in the following format.
+
+If you have access to Claude Desktop, please create the document as an artifact.
+If you have access to the file system, please create the document as a file.
+
+# Writing Guidelines
+
+1. Conciseness
+    - Include only essential information
+    - Remove unnecessary explanations
+    - Focus on information immediately usable in practice
+2. Consistency
+    - Use table names and column names exactly as they appear in the actual database
+    - Maintain case sensitivity
+    - Unify naming conventions
+3. Practicality
+    - Format should allow copy-paste for actual query writing
+    - Specify JOIN conditions and WHERE clause conditions
+    - Prioritize frequently used patterns
+4. Scalability
+    - Maintain existing structure when adding new information
+    - Enable independent management by section
+
+# Important Notes
+
+- Exclude sensitive information (passwords, personal data, etc.)
+- Focus on structure and relationships rather than actual data values
+- Focus on subject of the conversation, do not include any information that is not directly related to the subject
+- Prioritize key information over overly detailed explanations
+- Keep section titles and headings as provided, but write section content in the user's language
+
+# Output Format
+
+## [DB Schema] {Main Task or Domain Name}
+
+### Keywords
+{List key keywords related to this query, separated by commas}
+- Table names, Column names
+- Business terms
+- Domain-specific terms
+
+### Datasource
+* {Database Platform Name}
+   * {List all tables used in database.table format}
+   * {For Databricks platform, use catalog.database.table format}
+   * {Each table should be listed with its full path}
+
+### Database Structure
+
+#### {Database Name 1}
+{Brief description of the database's main purpose and role}
+
+##### Main Tables
+| Table | Key Columns | Description |
+|-------|-------------|-------------|
+| {table_name} | {column_name}(PK), {column_name}(FK→referenced_table), {other important columns} | {table purpose} |
+
+#### {Database Name 2}
+{Additional database information if needed}
+
+### Context
+
+#### Key Relationships
+{parent_table}.{column} → {child_table}.{column}
+{Add comments if relationship explanation is needed}
+
+#### Additional Notes
+- {Performance-related considerations}
+- {Data characteristics information}
+- {Business logic specifics}
+- {Index information (if important)}
+
+### Common Queries
+{List common query patterns}
+```sql
+-- {JOIN pattern description}
+SELECT {key columns}
+FROM {table1} t1
+JOIN {table2} t2 ON t1.{column} = t2.{column}
+WHERE {common conditions}
+
+-- {Additional JOIN pattern}
+{Actual usable JOIN query}
+```

src/config/paths.ts

@@ -3,7 +3,7 @@
  */
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { existsSync } from 'node:fs';
+import { existsSync, readFileSync } from 'node:fs';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const PROJECT_ROOT = path.resolve(__dirname, '../..');
@@ -16,15 +16,32 @@ export class Paths {
     return path.join(PROJECT_ROOT, 'env.yml');
   }
 
+  static getAssetsPath(): string {
+    if (process.env.ASSETS_FILE) {
+      return path.resolve(process.env.ASSETS_FILE);
+    }
+    
+    const defaultPath = process.env.NODE_ENV === 'development'
+      ? path.join(PROJECT_ROOT, 'src', 'assets')
+      : path.join(PROJECT_ROOT, 'dist', 'assets');
+
+    return existsSync(defaultPath) ? defaultPath : path.join(PROJECT_ROOT, 'src', 'assets');
+  }
+
+  static getAssetsTextFile(fileName: string): string {
+    const defaultPath = path.join(this.getAssetsPath(), fileName);
+    if (existsSync(defaultPath)) {
+      return readFileSync(defaultPath, 'utf-8');
+    }
+    return '';
+  }
+
   static getContextPath(): string {
     if (process.env.CONTEXT_FILE) {
       return path.resolve(process.env.CONTEXT_FILE);
     }
-    
-    const defaultPath = process.env.NODE_ENV === 'development'
-      ? path.join(PROJECT_ROOT, 'src', 'assets', 'context.md')
-      : path.join(PROJECT_ROOT, 'dist', 'assets', 'context.md');
-    
+
+    const defaultPath = path.join(this.getAssetsPath(), 'context.md');
     return existsSync(defaultPath) ? defaultPath : path.join(PROJECT_ROOT, 'src', 'assets', 'context.md');
   }
 
@@ -33,10 +50,7 @@ export class Paths {
       return path.resolve(process.env.GUIDE_FILE);
     }
 
-    const defaultPath = process.env.NODE_ENV === 'development'
-      ? path.join(PROJECT_ROOT, 'src', 'assets', 'guide.md')
-      : path.join(PROJECT_ROOT, 'dist', 'assets', 'guide.md');
-    
+    const defaultPath = path.join(this.getAssetsPath(), 'guide.md');
     return existsSync(defaultPath) ? defaultPath : path.join(PROJECT_ROOT, 'src', 'assets', 'guide.md');
   }
 

src/middleware.ts

@@ -4,6 +4,7 @@ import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/
 import { query, connectionInfo, listTables, getTable } from './tools/index.js';
 import * as ask from './prompts/ask.js';
 import * as context from './resources/context.js';
+import * as wrapUp from "./prompts/wrap-up.js";
 
 export const mcpMiddleware = async (req: Request, res: Response) => {
   const transport = new StreamableHTTPServerTransport({ sessionIdGenerator: undefined });
@@ -60,6 +61,14 @@ export const mcpMiddleware = async (req: Request, res: Response) => {
       }
     );
 
+    server.registerPrompt(
+      wrapUp.definition.name,
+      {
+        description: wrapUp.definition.description
+      },
+      wrapUp.handler
+    );
+
     server.registerResource(
       context.definition.name,
       context.definition.uri,

src/prompts/index.ts

@@ -1 +1,2 @@
-export * as ask from './ask.js';
+export * as ask from './ask.js';
+export * as wrapUp from './wrap-up.js';

src/prompts/wrap-up.ts

@@ -0,0 +1,26 @@
+import { Paths } from "@/config/paths";
+import { PromptDefinition } from "@/types/modelcontextprotocol";
+import { GetPromptResult } from "@modelcontextprotocol/sdk/types";
+
+const wrapUpContent = Paths.getAssetsTextFile('wrap-up.md');
+
+const definition: PromptDefinition = {
+  name: 'wrap-up',
+  description: 'Wrap up the conversation and generate a schema document'
+};
+
+const handler: () => Promise<GetPromptResult> = async () => {
+  return {
+    messages: [
+      {
+        role: 'user',
+        content: {
+          type: 'text',
+          text: wrapUpContent
+        }
+      }
+    ]
+  };
+};
+
+export { definition, handler };