Skip to content

Commit 66b978e

Browse files
xplusplusaiclaude
andcommitted
Update README: Add Golden Path workflow, remove version-specific content
- Add Golden Path Workflow and Custom Code Awareness to features - Replace scenarios with 6-step Golden Path example - Remove version-specific sections (v1.2.0, v1.2.1, compatibility notes) - Remove launcher references (fo-semantic-mcp-win.cmd) - Remove Search Features section (AI gets from instructions) - Remove Exact Artifact Matching examples (AI-only feature) - Simplify Download & Setup section Result: Concise, user-focused README highlighting Golden Path value 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 8e9e96f commit 66b978e

File tree

1 file changed

+20
-97
lines changed

1 file changed

+20
-97
lines changed

README.md

Lines changed: 20 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ Transform your F&O development workflow with AI-powered semantic search over 50,
1414

1515
## 📋 What You Get
1616

17+
**Golden Path Workflow** - AI follows proven 6-step methodology for context-aware F&O development
18+
**Custom Code Awareness** - AI searches YOUR workspace for existing extensions before generating code
1719
**Semantic Search** - Find F&O artifacts using natural language
1820
**50,000+ Artifacts** - Tables, Forms, Classes, EDT, Enums, Data Entities, Views, Queries
1921
**AI Summaries** - Understand artifact purpose without reading XML
2022
**Local File Access** - Read actual F&O XML files for complete analysis
21-
**Adaptive Thresholds** - Automatically retry searches with lower relevance scores
2223
**Multi-Platform** - Works on Windows, macOS, Linux with Node.js
2324
**MCP Compatible** - Works with Cursor IDE, Claude Desktop, VS Code
2425

@@ -29,49 +30,34 @@ Transform your F&O development workflow with AI-powered semantic search over 50,
2930
- **Architects** understanding system patterns
3031
- **Teams** accelerating development cycles
3132

32-
## 🔧 v1.2.1 - Critical Threshold Fix
3333

34-
**Resolved**: Fixed threshold settings that were filtering out exact matches. Updated all examples to use 0.5 threshold for reliable foName filter functionality.
34+
## 🔥 How AI Uses This - The Golden Path
3535

36-
## 🆕 New in v1.2.0
36+
AI follows a proven 6-step workflow ensuring code that integrates with YOUR existing F&O extensions:
3737

38-
**Exact Artifact Matching**: Added `foName` filter for precise artifact lookup when you know the exact F&O artifact name.
38+
**Example: "Add custom field to SalesTable form"**
3939

40-
**Key Features:**
41-
- **foName Filter**: Find specific artifacts by exact name (e.g., "CustTable", "SalesTable")
42-
- **AI Assistant Integration**: Enhanced MCP server instructions for exact matching
43-
- **Improved Precision**: Perfect for when you know exact artifact names from requirements
44-
45-
## ⚠️ Compatibility Note
40+
```
41+
Step 1: 🔍 Search Standard D365
42+
→ Finds SalesTable form in Microsoft's implementation
4643
47-
**Cursor IDE Compatibility**: This version maintains dual-format response support to ensure compatibility across all Cursor IDE versions:
44+
Step 2: 📖 Read Standard Implementation
45+
→ Understands Microsoft's XML structure and patterns
4846
49-
1. **Structured Content** - For older clients with structured content display and MCP protocol compliance
50-
2. **Embedded JSON in Text** - For newer clients with structured content display issues
47+
Step 3: 🔧 Search YOUR Custom Code
48+
→ Searches YOUR workspace for existing SalesTable extensions
5149
52-
---
50+
Step 4: 📖 Read YOUR Customizations
51+
→ Learns your coding style and current implementation
5352
54-
## 🔥 Real-World AI Assistant Scenarios
53+
Step 5: ✨ Generate Context-Aware Code
54+
→ Creates extension that works with YOUR existing code
5555
56-
**Extension Development:**
57-
```
58-
You: "I need to create a custom validation for sales orders"
59-
AI: *automatically searches F&O artifacts* "I found SalesTable validation patterns. Let me read the XML files and show you 3 approaches..."
56+
Step 6: 💡 Present with Full Context
57+
→ Shows: Standard + Your extensions + Generated code
6058
```
6159

62-
**Learning Existing Code:**
63-
```
64-
You: "How does inventory posting work?"
65-
AI: *queries relevant artifacts* "Based on InventPosting class and related forms, here's the flow..." *reads actual source files*
66-
```
67-
68-
**Best Practices:**
69-
```
70-
You: "What's the right way to extend purchase workflows?"
71-
AI: *finds workflow examples* "Looking at PurchReqWorkflow implementations..." *analyzes local XML*
72-
```
73-
74-
**🚀 True AI pair programming for F&O** - your AI partner has instant access to the entire F&O codebase and becomes your expert development companion!
60+
**Result:** Code that integrates seamlessly with your existing customizations on first try - no conflicts, no rework.
7561

7662
## ⚡ Quick Start
7763

@@ -84,15 +70,7 @@ Ensure you have **Node.js** installed:
8470
### 2. Download & Setup
8571

8672
1. Download the latest release and extract it anywhere on your system
87-
2. The package includes:
88-
- `fo-semantic-mcp-win.cmd` - Windows launcher script
89-
- `dist/` - Compiled server files
90-
- `node_modules/` - Dependencies (pre-installed)
91-
- `package.json` - Project configuration
92-
93-
**Windows:** Use the provided `fo-semantic-mcp-win.cmd` launcher
94-
95-
**macOS/Linux:** Run directly with: `node dist/server.js`
73+
2. The package includes pre-compiled server files and dependencies
9674

9775
### 3. Get API Key
9876

@@ -137,20 +115,6 @@ Update your MCP client configuration (replace `C:\\Downloads\\` with your extrac
137115
}
138116
```
139117

140-
**Alternative for Windows** - Use the launcher script:
141-
```json
142-
{
143-
"mcpServers": {
144-
"fo-semantic-mcp": {
145-
"command": "C:\\Downloads\\fo-semantic-mcp\\fo-semantic-mcp-win.cmd",
146-
"env": {
147-
"FOINDEX_API_KEY": "your_api_key_here",
148-
"FO_LOCAL_ASSETS_PATH": "C:\\Users\\[firstname.lastname]\\AppData\\Local\\Microsoft\\Dynamics365\\10.0.2263.74\\PackagesLocalDirectory"
149-
}
150-
}
151-
}
152-
}
153-
```
154118

155119
## 🔧 Configuration Options
156120

@@ -164,7 +128,6 @@ Update your MCP client configuration (replace `C:\\Downloads\\` with your extrac
164128

165129
## 💡 Example Queries
166130

167-
### Natural Language Search
168131
```
169132
"Find customer payment processing examples"
170133
"Show me sales order validation patterns"
@@ -173,46 +136,6 @@ Update your MCP client configuration (replace `C:\\Downloads\\` with your extrac
173136
"Show purchase order approval workflows"
174137
```
175138

176-
### Exact Artifact Matching (New in v1.2.0)
177-
```javascript
178-
// When you know the exact artifact name
179-
search_fo_artifacts({
180-
query: "currency table",
181-
filters: { foName: "Currency" }
182-
})
183-
184-
// Find specific table by exact name
185-
search_fo_artifacts({
186-
query: "customer data",
187-
filters: { foName: "CustTable" }
188-
})
189-
190-
// Locate exact form
191-
search_fo_artifacts({
192-
query: "sales order form",
193-
filters: { foName: "SalesTable" }
194-
})
195-
```
196-
197-
## 🔍 Search Features
198-
199-
### Adaptive Threshold Strategy
200-
AI automatically retries searches with lower thresholds when no results found:
201-
1. **0.5** - High relevance only
202-
2. **0.6** - Medium-high relevance
203-
3. **0.4** - Medium relevance
204-
4. **No threshold** - All results
205-
206-
### Filter Options
207-
- **Artifact Types**: Table, Form, Class, EDT, Enum, DataEntity, View, Query
208-
- **foName Filter**: Exact match by specific F&O artifact name (e.g., "CustTable", "SalesTable")
209-
- **Result Limits**: 1-50 results per search
210-
- **Relevance Scoring**: 0-1 semantic similarity scores
211-
212-
### When to Use foName Filter
213-
- **Known Artifact Names**: When you have exact F&O artifact names from requirements or documentation
214-
- **Precise Lookup**: Skip semantic matching and get the exact artifact you need
215-
- **Development Workflow**: Faster artifact discovery when exact names are specified
216139

217140
## 📖 Documentation
218141

0 commit comments

Comments
 (0)