bc-code-intelligence-mcp 1.5.7 → 1.5.9
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.
- package/LICENSE +20 -20
- package/README.md +165 -165
- package/dist/layers/embedded-layer.js +29 -29
- package/dist/layers/git-layer.d.ts +9 -0
- package/dist/layers/git-layer.d.ts.map +1 -1
- package/dist/layers/git-layer.js +18 -8
- package/dist/layers/git-layer.js.map +1 -1
- package/dist/layers/project-layer.js +33 -33
- package/dist/services/code-analysis-service.d.ts +22 -0
- package/dist/services/code-analysis-service.d.ts.map +1 -1
- package/dist/services/code-analysis-service.js +139 -3
- package/dist/services/code-analysis-service.js.map +1 -1
- package/dist/services/knowledge-service.d.ts +1 -1
- package/dist/services/knowledge-service.d.ts.map +1 -1
- package/dist/services/knowledge-service.js +71 -3
- package/dist/services/knowledge-service.js.map +1 -1
- package/dist/services/methodology-service.js +14 -14
- package/dist/services/multi-content-layer-service.d.ts +15 -0
- package/dist/services/multi-content-layer-service.d.ts.map +1 -1
- package/dist/services/multi-content-layer-service.js +62 -0
- package/dist/services/multi-content-layer-service.js.map +1 -1
- package/dist/streamlined-handlers.d.ts +0 -7
- package/dist/streamlined-handlers.d.ts.map +1 -1
- package/dist/streamlined-handlers.js +80 -60
- package/dist/streamlined-handlers.js.map +1 -1
- package/dist/tools/core-tools.d.ts.map +1 -1
- package/dist/tools/core-tools.js +5 -1
- package/dist/tools/core-tools.js.map +1 -1
- package/dist/tools/onboarding-tools.d.ts +8 -0
- package/dist/tools/onboarding-tools.d.ts.map +1 -1
- package/dist/tools/onboarding-tools.js +111 -1
- package/dist/tools/onboarding-tools.js.map +1 -1
- package/dist/tools/specialist-discovery-tools.d.ts.map +1 -1
- package/dist/tools/specialist-discovery-tools.js +6 -0
- package/dist/tools/specialist-discovery-tools.js.map +1 -1
- package/dist/tools/specialist-tools.d.ts.map +1 -1
- package/dist/tools/specialist-tools.js +6 -0
- package/dist/tools/specialist-tools.js.map +1 -1
- package/embedded-knowledge/.github/ISSUE_TEMPLATE/bug-report.md +23 -23
- package/embedded-knowledge/.github/ISSUE_TEMPLATE/content-improvement.md +23 -23
- package/embedded-knowledge/.github/ISSUE_TEMPLATE/knowledge-request.md +29 -29
- package/embedded-knowledge/AGENTS.md +177 -177
- package/embedded-knowledge/CONTRIBUTING.md +57 -57
- package/embedded-knowledge/LICENSE +20 -20
- package/embedded-knowledge/README.md +31 -31
- package/embedded-knowledge/domains/shared/al-file-naming-conventions.md +145 -145
- package/embedded-knowledge/methodologies/index.json +80 -80
- package/embedded-knowledge/methodologies/phases/analysis-full.md +207 -207
- package/embedded-knowledge/methodologies/phases/analysis-quick.md +43 -43
- package/embedded-knowledge/methodologies/phases/analysis.md +181 -181
- package/embedded-knowledge/methodologies/phases/execution-validation-full.md +173 -173
- package/embedded-knowledge/methodologies/phases/execution-validation-quick.md +30 -30
- package/embedded-knowledge/methodologies/phases/execution-validation.md +173 -173
- package/embedded-knowledge/methodologies/phases/performance-full.md +210 -210
- package/embedded-knowledge/methodologies/phases/performance-quick.md +31 -31
- package/embedded-knowledge/methodologies/phases/performance.md +210 -210
- package/embedded-knowledge/methodologies/phases/verification-full.md +161 -161
- package/embedded-knowledge/methodologies/phases/verification-quick.md +47 -47
- package/embedded-knowledge/methodologies/phases/verification.md +145 -145
- package/embedded-knowledge/methodologies/workflow-enforcement.md +141 -141
- package/embedded-knowledge/methodologies/workflows/code-review-workflow.md +98 -98
- package/package.json +81 -81
|
@@ -1,178 +1,178 @@
|
|
|
1
|
-
# AGENTS.md - Repository Context for AI Assistants
|
|
2
|
-
|
|
3
|
-
## Repository Purpose
|
|
4
|
-
This is the **knowledge content repository** for the BC Code Intelligence (bc-code-intel) system.
|
|
5
|
-
|
|
6
|
-
## What This Repo Contains
|
|
7
|
-
- **BC Domain Knowledge**: 87+ atomic topics across 24 domains (performance, API design, security, etc.)
|
|
8
|
-
- **Methodology Frameworks**: Step-by-step AI workflow guidance for systematic optimization
|
|
9
|
-
- **Specialists Definitions**: 14 AI persona configurations with domain expertise and behavioral constraints
|
|
10
|
-
- **Strategic Prompts**: High-level prompts for common BC development scenarios
|
|
11
|
-
- **Pure Markdown Content**: No code whatsoever - only knowledge content with YAML frontmatter
|
|
12
|
-
|
|
13
|
-
## What This Repo Does NOT Contain
|
|
14
|
-
- TypeScript/JavaScript code (that's in bc-code-intelligence-mcp repository)
|
|
15
|
-
- MCP server implementation or protocol handling
|
|
16
|
-
- Build processes, dependencies, or package.json files
|
|
17
|
-
- Compiled or generated content
|
|
18
|
-
|
|
19
|
-
## Repository Structure
|
|
20
|
-
```
|
|
21
|
-
domains/ # BC knowledge organized by domain
|
|
22
|
-
├── performance/ # Performance optimization patterns
|
|
23
|
-
├── api-design/ # REST/OData API best practices
|
|
24
|
-
├── data-architecture/ # Table design and relationships
|
|
25
|
-
├── security/ # Authentication and authorization
|
|
26
|
-
└── [20 other domains]/
|
|
27
|
-
|
|
28
|
-
methodologies/ # AI workflow frameworks
|
|
29
|
-
├── phases/ # Systematic analysis phases
|
|
30
|
-
└── workflows/ # Complete optimization workflows
|
|
31
|
-
|
|
32
|
-
specialists/ # AI persona definitions
|
|
33
|
-
├── alex-architect.md # Strategic Planning & Architecture
|
|
34
|
-
├── casey-copilot.md # AI-Enhanced Development Coach
|
|
35
|
-
├── dean-debug.md # Performance & Troubleshooting
|
|
36
|
-
├── eva-errors.md # Error Handling & Exception Management
|
|
37
|
-
├── jordan-bridge.md # Systems Connection & Event-Driven Design
|
|
38
|
-
├── logan-legacy.md # Legacy Code & Version Migration
|
|
39
|
-
├── maya-mentor.md # Learning & Skill Development
|
|
40
|
-
├── morgan-market.md # AppSource & ISV Business Expert
|
|
41
|
-
├── quinn-tester.md # Quality Validation & Test Design
|
|
42
|
-
├── roger-reviewer.md # Code Quality & Review Standards
|
|
43
|
-
├── sam-coder.md # Efficient Implementation Expert
|
|
44
|
-
├── seth-security.md # Security & Permission Management
|
|
45
|
-
├── taylor-docs.md # Documentation & Knowledge Management
|
|
46
|
-
└── uma-ux.md # User Experience & Interface Design
|
|
47
|
-
|
|
48
|
-
prompts/ # Strategic prompts
|
|
49
|
-
├── analyze-performance.md
|
|
50
|
-
├── review-architecture.md
|
|
51
|
-
└── [other prompts]/
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
## Content Standards
|
|
55
|
-
- **Atomic Topics**: One focused concept per markdown file
|
|
56
|
-
- **YAML Frontmatter**: Rich metadata for AI consumption including:
|
|
57
|
-
- BC version compatibility (`bc_versions: "14+"`)
|
|
58
|
-
- Difficulty level, tags, domain classification
|
|
59
|
-
- Cross-references to related topics
|
|
60
|
-
- **Version Awareness**: All content specifies BC version compatibility
|
|
61
|
-
- **Consistent Structure**: Follow established patterns for headings, examples, cross-references
|
|
62
|
-
|
|
63
|
-
## AI Assistant Guidelines When Working With This Repo
|
|
64
|
-
1. **Content Focus**: Maintain accuracy of BC technical information
|
|
65
|
-
2. **Structure Integrity**: Preserve YAML frontmatter completeness and consistency
|
|
66
|
-
3. **Version Compatibility**: Always specify BC version ranges for patterns/features
|
|
67
|
-
4. **Cross-References**: Maintain accurate links between related topics
|
|
68
|
-
5. **Atomic Principle**: Keep each file focused on one specific concept
|
|
69
|
-
6. **NO CODE**: This repository contains NO executable code - knowledge only
|
|
70
|
-
7. **Link Integrity**: Ensure internal topic references remain valid
|
|
71
|
-
|
|
72
|
-
## GitHub Copilot Coding Agent Guidelines
|
|
73
|
-
|
|
74
|
-
### Content Creation Patterns
|
|
75
|
-
When creating new knowledge topics, ALWAYS use this YAML frontmatter template:
|
|
76
|
-
```yaml
|
|
77
|
-
---
|
|
78
|
-
title: "Descriptive Topic Title"
|
|
79
|
-
domain: "performance|api-design|security|etc"
|
|
80
|
-
bc_versions: "14+|18+|19+|specific-range"
|
|
81
|
-
difficulty: "beginner|intermediate|advanced"
|
|
82
|
-
tags: ["tag1", "tag2", "tag3"]
|
|
83
|
-
related_topics:
|
|
84
|
-
- "path/to/related/topic.md"
|
|
85
|
-
- "another/related/topic.md"
|
|
86
|
-
applies_to:
|
|
87
|
-
- "AL Language"
|
|
88
|
-
- "Business Central Server"
|
|
89
|
-
- "Web Client"
|
|
90
|
-
last_updated: "2025-01-01"
|
|
91
|
-
---
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
### File Naming Conventions
|
|
95
|
-
- Use kebab-case for all filenames: `api-pagination-patterns.md`
|
|
96
|
-
- Include domain prefix when needed: `performance-caching-strategies.md`
|
|
97
|
-
- Keep names descriptive but concise (max 50 characters)
|
|
98
|
-
- Avoid abbreviations unless universally understood
|
|
99
|
-
|
|
100
|
-
### Content Structure Requirements
|
|
101
|
-
1. **H1 Title**: Must match YAML frontmatter title exactly
|
|
102
|
-
2. **Overview Section**: 2-3 sentence summary of the concept
|
|
103
|
-
3. **Implementation Details**: Step-by-step guidance with BC code examples
|
|
104
|
-
4. **Best Practices**: Bulleted list of key recommendations
|
|
105
|
-
5. **Common Pitfalls**: What to avoid with explanations
|
|
106
|
-
6. **Version Notes**: BC version-specific considerations
|
|
107
|
-
7. **See Also**: Cross-references to related topics
|
|
108
|
-
|
|
109
|
-
### Cross-Reference Validation
|
|
110
|
-
- Use relative paths: `../performance/caching-strategies.md`
|
|
111
|
-
- Verify target files exist before creating references
|
|
112
|
-
- Update both directions when creating new relationships
|
|
113
|
-
- Use descriptive link text: `[API Pagination Patterns](../api-design/pagination-patterns.md)`
|
|
114
|
-
|
|
115
|
-
### Domain Organization Rules
|
|
116
|
-
```
|
|
117
|
-
domains/
|
|
118
|
-
├── performance/ # Speed, memory, resource optimization
|
|
119
|
-
├── api-design/ # REST, OData, integration patterns
|
|
120
|
-
├── security/ # Authentication, authorization, data protection
|
|
121
|
-
├── data-architecture/ # Table design, relationships, normalization
|
|
122
|
-
├── error-handling/ # Exception management, validation
|
|
123
|
-
├── testing/ # Unit, integration, performance testing
|
|
124
|
-
└── [other domains]/ # Maintain alphabetical order
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
### Validation Checklist
|
|
128
|
-
Before committing new content, verify:
|
|
129
|
-
- [ ] YAML frontmatter is complete and valid
|
|
130
|
-
- [ ] BC version compatibility is specified
|
|
131
|
-
- [ ] Cross-references use relative paths and exist
|
|
132
|
-
- [ ] Content is atomic (one focused concept)
|
|
133
|
-
- [ ] No executable code is included
|
|
134
|
-
- [ ] Examples use realistic BC scenarios
|
|
135
|
-
- [ ] Tags are consistent with existing taxonomy
|
|
136
|
-
|
|
137
|
-
### Common Anti-Patterns to Avoid
|
|
138
|
-
- ❌ **Code Repositories**: Never include .cs, .al, .js, or executable files
|
|
139
|
-
- ❌ **Generic Examples**: Avoid "MyTable" - use realistic BC entities
|
|
140
|
-
- ❌ **Version Ambiguity**: Never omit BC version compatibility
|
|
141
|
-
- ❌ **Broken Cross-References**: Always validate links before committing
|
|
142
|
-
- ❌ **Topic Drift**: Keep each file focused on ONE concept
|
|
143
|
-
- ❌ **Outdated Information**: Update last_updated when making changes
|
|
144
|
-
|
|
145
|
-
## Common Tasks
|
|
146
|
-
- Adding new BC knowledge topics with proper frontmatter and validation
|
|
147
|
-
- Updating existing topics for new BC versions with migration notes
|
|
148
|
-
- Creating bidirectional cross-references between related topics
|
|
149
|
-
- Validating YAML frontmatter structure and consistency
|
|
150
|
-
- Organizing content within domain hierarchies and maintaining taxonomy
|
|
151
|
-
- Performing content audits for accuracy and BC version compatibility
|
|
152
|
-
|
|
153
|
-
## GitHub Copilot Integration Workflows
|
|
154
|
-
|
|
155
|
-
### New Topic Creation Workflow
|
|
156
|
-
1. **Domain Classification**: Determine primary domain from existing taxonomy
|
|
157
|
-
2. **Version Research**: Identify minimum BC version and any version-specific notes
|
|
158
|
-
3. **Template Application**: Use YAML frontmatter template with all required fields
|
|
159
|
-
4. **Content Development**: Follow structure requirements for consistency
|
|
160
|
-
5. **Cross-Reference Integration**: Add to related topics and update existing references
|
|
161
|
-
6. **Validation**: Run through validation checklist before committing
|
|
162
|
-
|
|
163
|
-
### Content Update Workflow
|
|
164
|
-
1. **Impact Assessment**: Identify which BC versions are affected
|
|
165
|
-
2. **Cross-Reference Review**: Check if related topics need updates
|
|
166
|
-
3. **Version Compatibility**: Update bc_versions field if needed
|
|
167
|
-
4. **Last Updated**: Always update timestamp when making changes
|
|
168
|
-
5. **Validation**: Ensure all links and references remain valid
|
|
169
|
-
|
|
170
|
-
### Quality Assurance Patterns
|
|
171
|
-
- **Atomic Content Principle**: Each file covers exactly one BC concept
|
|
172
|
-
- **Consistent Terminology**: Use official Microsoft BC terminology
|
|
173
|
-
- **Practical Examples**: Include realistic Business Central scenarios
|
|
174
|
-
- **Version Awareness**: Every pattern specifies BC version compatibility
|
|
175
|
-
- **Link Validation**: Cross-references must be bidirectional and accurate
|
|
176
|
-
|
|
177
|
-
## Integration
|
|
1
|
+
# AGENTS.md - Repository Context for AI Assistants
|
|
2
|
+
|
|
3
|
+
## Repository Purpose
|
|
4
|
+
This is the **knowledge content repository** for the BC Code Intelligence (bc-code-intel) system.
|
|
5
|
+
|
|
6
|
+
## What This Repo Contains
|
|
7
|
+
- **BC Domain Knowledge**: 87+ atomic topics across 24 domains (performance, API design, security, etc.)
|
|
8
|
+
- **Methodology Frameworks**: Step-by-step AI workflow guidance for systematic optimization
|
|
9
|
+
- **Specialists Definitions**: 14 AI persona configurations with domain expertise and behavioral constraints
|
|
10
|
+
- **Strategic Prompts**: High-level prompts for common BC development scenarios
|
|
11
|
+
- **Pure Markdown Content**: No code whatsoever - only knowledge content with YAML frontmatter
|
|
12
|
+
|
|
13
|
+
## What This Repo Does NOT Contain
|
|
14
|
+
- TypeScript/JavaScript code (that's in bc-code-intelligence-mcp repository)
|
|
15
|
+
- MCP server implementation or protocol handling
|
|
16
|
+
- Build processes, dependencies, or package.json files
|
|
17
|
+
- Compiled or generated content
|
|
18
|
+
|
|
19
|
+
## Repository Structure
|
|
20
|
+
```
|
|
21
|
+
domains/ # BC knowledge organized by domain
|
|
22
|
+
├── performance/ # Performance optimization patterns
|
|
23
|
+
├── api-design/ # REST/OData API best practices
|
|
24
|
+
├── data-architecture/ # Table design and relationships
|
|
25
|
+
├── security/ # Authentication and authorization
|
|
26
|
+
└── [20 other domains]/
|
|
27
|
+
|
|
28
|
+
methodologies/ # AI workflow frameworks
|
|
29
|
+
├── phases/ # Systematic analysis phases
|
|
30
|
+
└── workflows/ # Complete optimization workflows
|
|
31
|
+
|
|
32
|
+
specialists/ # AI persona definitions
|
|
33
|
+
├── alex-architect.md # Strategic Planning & Architecture
|
|
34
|
+
├── casey-copilot.md # AI-Enhanced Development Coach
|
|
35
|
+
├── dean-debug.md # Performance & Troubleshooting
|
|
36
|
+
├── eva-errors.md # Error Handling & Exception Management
|
|
37
|
+
├── jordan-bridge.md # Systems Connection & Event-Driven Design
|
|
38
|
+
├── logan-legacy.md # Legacy Code & Version Migration
|
|
39
|
+
├── maya-mentor.md # Learning & Skill Development
|
|
40
|
+
├── morgan-market.md # AppSource & ISV Business Expert
|
|
41
|
+
├── quinn-tester.md # Quality Validation & Test Design
|
|
42
|
+
├── roger-reviewer.md # Code Quality & Review Standards
|
|
43
|
+
├── sam-coder.md # Efficient Implementation Expert
|
|
44
|
+
├── seth-security.md # Security & Permission Management
|
|
45
|
+
├── taylor-docs.md # Documentation & Knowledge Management
|
|
46
|
+
└── uma-ux.md # User Experience & Interface Design
|
|
47
|
+
|
|
48
|
+
prompts/ # Strategic prompts
|
|
49
|
+
├── analyze-performance.md
|
|
50
|
+
├── review-architecture.md
|
|
51
|
+
└── [other prompts]/
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Content Standards
|
|
55
|
+
- **Atomic Topics**: One focused concept per markdown file
|
|
56
|
+
- **YAML Frontmatter**: Rich metadata for AI consumption including:
|
|
57
|
+
- BC version compatibility (`bc_versions: "14+"`)
|
|
58
|
+
- Difficulty level, tags, domain classification
|
|
59
|
+
- Cross-references to related topics
|
|
60
|
+
- **Version Awareness**: All content specifies BC version compatibility
|
|
61
|
+
- **Consistent Structure**: Follow established patterns for headings, examples, cross-references
|
|
62
|
+
|
|
63
|
+
## AI Assistant Guidelines When Working With This Repo
|
|
64
|
+
1. **Content Focus**: Maintain accuracy of BC technical information
|
|
65
|
+
2. **Structure Integrity**: Preserve YAML frontmatter completeness and consistency
|
|
66
|
+
3. **Version Compatibility**: Always specify BC version ranges for patterns/features
|
|
67
|
+
4. **Cross-References**: Maintain accurate links between related topics
|
|
68
|
+
5. **Atomic Principle**: Keep each file focused on one specific concept
|
|
69
|
+
6. **NO CODE**: This repository contains NO executable code - knowledge only
|
|
70
|
+
7. **Link Integrity**: Ensure internal topic references remain valid
|
|
71
|
+
|
|
72
|
+
## GitHub Copilot Coding Agent Guidelines
|
|
73
|
+
|
|
74
|
+
### Content Creation Patterns
|
|
75
|
+
When creating new knowledge topics, ALWAYS use this YAML frontmatter template:
|
|
76
|
+
```yaml
|
|
77
|
+
---
|
|
78
|
+
title: "Descriptive Topic Title"
|
|
79
|
+
domain: "performance|api-design|security|etc"
|
|
80
|
+
bc_versions: "14+|18+|19+|specific-range"
|
|
81
|
+
difficulty: "beginner|intermediate|advanced"
|
|
82
|
+
tags: ["tag1", "tag2", "tag3"]
|
|
83
|
+
related_topics:
|
|
84
|
+
- "path/to/related/topic.md"
|
|
85
|
+
- "another/related/topic.md"
|
|
86
|
+
applies_to:
|
|
87
|
+
- "AL Language"
|
|
88
|
+
- "Business Central Server"
|
|
89
|
+
- "Web Client"
|
|
90
|
+
last_updated: "2025-01-01"
|
|
91
|
+
---
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### File Naming Conventions
|
|
95
|
+
- Use kebab-case for all filenames: `api-pagination-patterns.md`
|
|
96
|
+
- Include domain prefix when needed: `performance-caching-strategies.md`
|
|
97
|
+
- Keep names descriptive but concise (max 50 characters)
|
|
98
|
+
- Avoid abbreviations unless universally understood
|
|
99
|
+
|
|
100
|
+
### Content Structure Requirements
|
|
101
|
+
1. **H1 Title**: Must match YAML frontmatter title exactly
|
|
102
|
+
2. **Overview Section**: 2-3 sentence summary of the concept
|
|
103
|
+
3. **Implementation Details**: Step-by-step guidance with BC code examples
|
|
104
|
+
4. **Best Practices**: Bulleted list of key recommendations
|
|
105
|
+
5. **Common Pitfalls**: What to avoid with explanations
|
|
106
|
+
6. **Version Notes**: BC version-specific considerations
|
|
107
|
+
7. **See Also**: Cross-references to related topics
|
|
108
|
+
|
|
109
|
+
### Cross-Reference Validation
|
|
110
|
+
- Use relative paths: `../performance/caching-strategies.md`
|
|
111
|
+
- Verify target files exist before creating references
|
|
112
|
+
- Update both directions when creating new relationships
|
|
113
|
+
- Use descriptive link text: `[API Pagination Patterns](../api-design/pagination-patterns.md)`
|
|
114
|
+
|
|
115
|
+
### Domain Organization Rules
|
|
116
|
+
```
|
|
117
|
+
domains/
|
|
118
|
+
├── performance/ # Speed, memory, resource optimization
|
|
119
|
+
├── api-design/ # REST, OData, integration patterns
|
|
120
|
+
├── security/ # Authentication, authorization, data protection
|
|
121
|
+
├── data-architecture/ # Table design, relationships, normalization
|
|
122
|
+
├── error-handling/ # Exception management, validation
|
|
123
|
+
├── testing/ # Unit, integration, performance testing
|
|
124
|
+
└── [other domains]/ # Maintain alphabetical order
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Validation Checklist
|
|
128
|
+
Before committing new content, verify:
|
|
129
|
+
- [ ] YAML frontmatter is complete and valid
|
|
130
|
+
- [ ] BC version compatibility is specified
|
|
131
|
+
- [ ] Cross-references use relative paths and exist
|
|
132
|
+
- [ ] Content is atomic (one focused concept)
|
|
133
|
+
- [ ] No executable code is included
|
|
134
|
+
- [ ] Examples use realistic BC scenarios
|
|
135
|
+
- [ ] Tags are consistent with existing taxonomy
|
|
136
|
+
|
|
137
|
+
### Common Anti-Patterns to Avoid
|
|
138
|
+
- ❌ **Code Repositories**: Never include .cs, .al, .js, or executable files
|
|
139
|
+
- ❌ **Generic Examples**: Avoid "MyTable" - use realistic BC entities
|
|
140
|
+
- ❌ **Version Ambiguity**: Never omit BC version compatibility
|
|
141
|
+
- ❌ **Broken Cross-References**: Always validate links before committing
|
|
142
|
+
- ❌ **Topic Drift**: Keep each file focused on ONE concept
|
|
143
|
+
- ❌ **Outdated Information**: Update last_updated when making changes
|
|
144
|
+
|
|
145
|
+
## Common Tasks
|
|
146
|
+
- Adding new BC knowledge topics with proper frontmatter and validation
|
|
147
|
+
- Updating existing topics for new BC versions with migration notes
|
|
148
|
+
- Creating bidirectional cross-references between related topics
|
|
149
|
+
- Validating YAML frontmatter structure and consistency
|
|
150
|
+
- Organizing content within domain hierarchies and maintaining taxonomy
|
|
151
|
+
- Performing content audits for accuracy and BC version compatibility
|
|
152
|
+
|
|
153
|
+
## GitHub Copilot Integration Workflows
|
|
154
|
+
|
|
155
|
+
### New Topic Creation Workflow
|
|
156
|
+
1. **Domain Classification**: Determine primary domain from existing taxonomy
|
|
157
|
+
2. **Version Research**: Identify minimum BC version and any version-specific notes
|
|
158
|
+
3. **Template Application**: Use YAML frontmatter template with all required fields
|
|
159
|
+
4. **Content Development**: Follow structure requirements for consistency
|
|
160
|
+
5. **Cross-Reference Integration**: Add to related topics and update existing references
|
|
161
|
+
6. **Validation**: Run through validation checklist before committing
|
|
162
|
+
|
|
163
|
+
### Content Update Workflow
|
|
164
|
+
1. **Impact Assessment**: Identify which BC versions are affected
|
|
165
|
+
2. **Cross-Reference Review**: Check if related topics need updates
|
|
166
|
+
3. **Version Compatibility**: Update bc_versions field if needed
|
|
167
|
+
4. **Last Updated**: Always update timestamp when making changes
|
|
168
|
+
5. **Validation**: Ensure all links and references remain valid
|
|
169
|
+
|
|
170
|
+
### Quality Assurance Patterns
|
|
171
|
+
- **Atomic Content Principle**: Each file covers exactly one BC concept
|
|
172
|
+
- **Consistent Terminology**: Use official Microsoft BC terminology
|
|
173
|
+
- **Practical Examples**: Include realistic Business Central scenarios
|
|
174
|
+
- **Version Awareness**: Every pattern specifies BC version compatibility
|
|
175
|
+
- **Link Validation**: Cross-references must be bidirectional and accurate
|
|
176
|
+
|
|
177
|
+
## Integration
|
|
178
178
|
This repository is consumed by the MCP server via git submodule as the embedded knowledge layer (Layer 0).
|
|
@@ -1,58 +1,58 @@
|
|
|
1
|
-
# Contributing to Business Central Knowledge Base
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
This repository contains pure knowledge content for Business Central best practices. All content is markdown with YAML frontmatter.
|
|
5
|
-
|
|
6
|
-
## Content Standards
|
|
7
|
-
|
|
8
|
-
### File Structure
|
|
9
|
-
Each knowledge topic follows this structure:
|
|
10
|
-
```markdown
|
|
11
|
-
---
|
|
12
|
-
title: "Topic Title"
|
|
13
|
-
domain: "performance"
|
|
14
|
-
difficulty: "intermediate"
|
|
15
|
-
bc_versions: "14+"
|
|
16
|
-
tags: ["sift", "optimization", "database"]
|
|
17
|
-
related_topics: ["topic-id-1", "topic-id-2"]
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
# Topic Title
|
|
21
|
-
|
|
22
|
-
Content here following established patterns...
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
### Quality Requirements
|
|
26
|
-
- **Atomic Focus**: One concept per file
|
|
27
|
-
- **BC Version Compatibility**: Always specify version ranges
|
|
28
|
-
- **Complete Frontmatter**: All required YAML fields present
|
|
29
|
-
- **Cross-References**: Link to related topics where appropriate
|
|
30
|
-
- **Consistent Formatting**: Follow existing markdown patterns
|
|
31
|
-
|
|
32
|
-
## Submission Process
|
|
33
|
-
1. Fork the repository
|
|
34
|
-
2. Create content following established patterns in appropriate domain directory
|
|
35
|
-
3. Ensure YAML frontmatter is complete and valid
|
|
36
|
-
4. Test that internal links work correctly
|
|
37
|
-
5. Submit pull request with clear description of the knowledge added/updated
|
|
38
|
-
|
|
39
|
-
## Content Validation
|
|
40
|
-
Pull requests are automatically validated for:
|
|
41
|
-
- YAML frontmatter completeness
|
|
42
|
-
- BC version compatibility format
|
|
43
|
-
- Internal link integrity
|
|
44
|
-
- Proper domain/directory placement
|
|
45
|
-
- Markdown formatting consistency
|
|
46
|
-
|
|
47
|
-
## Domain Organization
|
|
48
|
-
Place content in appropriate domain directories:
|
|
49
|
-
- `domains/performance/` - Performance optimization
|
|
50
|
-
- `domains/api-design/` - REST/OData patterns
|
|
51
|
-
- `domains/security/` - Authentication/authorization
|
|
52
|
-
- `domains/data-architecture/` - Table design
|
|
53
|
-
- [See full domain list in repository structure]
|
|
54
|
-
|
|
55
|
-
## Getting Help
|
|
56
|
-
- Review existing topics for patterns
|
|
57
|
-
- Check AGENTS.md for AI assistant guidance
|
|
1
|
+
# Contributing to Business Central Knowledge Base
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
This repository contains pure knowledge content for Business Central best practices. All content is markdown with YAML frontmatter.
|
|
5
|
+
|
|
6
|
+
## Content Standards
|
|
7
|
+
|
|
8
|
+
### File Structure
|
|
9
|
+
Each knowledge topic follows this structure:
|
|
10
|
+
```markdown
|
|
11
|
+
---
|
|
12
|
+
title: "Topic Title"
|
|
13
|
+
domain: "performance"
|
|
14
|
+
difficulty: "intermediate"
|
|
15
|
+
bc_versions: "14+"
|
|
16
|
+
tags: ["sift", "optimization", "database"]
|
|
17
|
+
related_topics: ["topic-id-1", "topic-id-2"]
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# Topic Title
|
|
21
|
+
|
|
22
|
+
Content here following established patterns...
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Quality Requirements
|
|
26
|
+
- **Atomic Focus**: One concept per file
|
|
27
|
+
- **BC Version Compatibility**: Always specify version ranges
|
|
28
|
+
- **Complete Frontmatter**: All required YAML fields present
|
|
29
|
+
- **Cross-References**: Link to related topics where appropriate
|
|
30
|
+
- **Consistent Formatting**: Follow existing markdown patterns
|
|
31
|
+
|
|
32
|
+
## Submission Process
|
|
33
|
+
1. Fork the repository
|
|
34
|
+
2. Create content following established patterns in appropriate domain directory
|
|
35
|
+
3. Ensure YAML frontmatter is complete and valid
|
|
36
|
+
4. Test that internal links work correctly
|
|
37
|
+
5. Submit pull request with clear description of the knowledge added/updated
|
|
38
|
+
|
|
39
|
+
## Content Validation
|
|
40
|
+
Pull requests are automatically validated for:
|
|
41
|
+
- YAML frontmatter completeness
|
|
42
|
+
- BC version compatibility format
|
|
43
|
+
- Internal link integrity
|
|
44
|
+
- Proper domain/directory placement
|
|
45
|
+
- Markdown formatting consistency
|
|
46
|
+
|
|
47
|
+
## Domain Organization
|
|
48
|
+
Place content in appropriate domain directories:
|
|
49
|
+
- `domains/performance/` - Performance optimization
|
|
50
|
+
- `domains/api-design/` - REST/OData patterns
|
|
51
|
+
- `domains/security/` - Authentication/authorization
|
|
52
|
+
- `domains/data-architecture/` - Table design
|
|
53
|
+
- [See full domain list in repository structure]
|
|
54
|
+
|
|
55
|
+
## Getting Help
|
|
56
|
+
- Review existing topics for patterns
|
|
57
|
+
- Check AGENTS.md for AI assistant guidance
|
|
58
58
|
- Open issues for questions about content organization
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2024 Business Central Knowledge Base
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Business Central Knowledge Base
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
21
|
SOFTWARE.
|
|
@@ -1,32 +1,32 @@
|
|
|
1
|
-
# BC Code Intelligence Knowledge Base
|
|
2
|
-
|
|
3
|
-
Pure knowledge content repository for Business Central best practices, methodologies, and domain expertise.
|
|
4
|
-
|
|
5
|
-
## Structure
|
|
6
|
-
- `/domains/` - 24 BC domains with 87+ atomic knowledge topics
|
|
7
|
-
- `/methodologies/` - AI workflow frameworks for systematic optimization
|
|
8
|
-
- `/specialists/` - 14 AI persona definitions for focused expertise
|
|
9
|
-
- `/prompts/` - Strategic prompts for common BC scenarios
|
|
10
|
-
|
|
11
|
-
## Specialists
|
|
12
|
-
Complete roster of 14 BC development specialists:
|
|
13
|
-
- **Alex Architect** - Strategic Planning & Architecture
|
|
14
|
-
- **Casey Copilot** - AI-Enhanced Development Coach
|
|
15
|
-
- **Dean Debug** - Performance & Troubleshooting
|
|
16
|
-
- **Eva Errors** - Error Handling & Exception Management
|
|
17
|
-
- **Jordan Bridge** - Systems Connection & Event-Driven Design
|
|
18
|
-
- **Logan Legacy** - Legacy Code & Version Migration
|
|
19
|
-
- **Maya Mentor** - Learning & Skill Development
|
|
20
|
-
- **Morgan Market** - AppSource & ISV Business Expert
|
|
21
|
-
- **Quinn Tester** - Quality Validation & Test Design
|
|
22
|
-
- **Roger Reviewer** - Code Quality & Review Standards
|
|
23
|
-
- **Sam Coder** - Efficient Implementation Expert
|
|
24
|
-
- **Seth Security** - Security & Permission Management
|
|
25
|
-
- **Taylor Docs** - Documentation & Knowledge Management
|
|
26
|
-
- **Uma UX** - User Experience & Interface Design
|
|
27
|
-
|
|
28
|
-
## Usage
|
|
29
|
-
This repository is consumed by the BC Code Intelligence MCP server via git submodule. Content is pure markdown with YAML frontmatter.
|
|
30
|
-
|
|
31
|
-
## Contributing
|
|
1
|
+
# BC Code Intelligence Knowledge Base
|
|
2
|
+
|
|
3
|
+
Pure knowledge content repository for Business Central best practices, methodologies, and domain expertise.
|
|
4
|
+
|
|
5
|
+
## Structure
|
|
6
|
+
- `/domains/` - 24 BC domains with 87+ atomic knowledge topics
|
|
7
|
+
- `/methodologies/` - AI workflow frameworks for systematic optimization
|
|
8
|
+
- `/specialists/` - 14 AI persona definitions for focused expertise
|
|
9
|
+
- `/prompts/` - Strategic prompts for common BC scenarios
|
|
10
|
+
|
|
11
|
+
## Specialists
|
|
12
|
+
Complete roster of 14 BC development specialists:
|
|
13
|
+
- **Alex Architect** - Strategic Planning & Architecture
|
|
14
|
+
- **Casey Copilot** - AI-Enhanced Development Coach
|
|
15
|
+
- **Dean Debug** - Performance & Troubleshooting
|
|
16
|
+
- **Eva Errors** - Error Handling & Exception Management
|
|
17
|
+
- **Jordan Bridge** - Systems Connection & Event-Driven Design
|
|
18
|
+
- **Logan Legacy** - Legacy Code & Version Migration
|
|
19
|
+
- **Maya Mentor** - Learning & Skill Development
|
|
20
|
+
- **Morgan Market** - AppSource & ISV Business Expert
|
|
21
|
+
- **Quinn Tester** - Quality Validation & Test Design
|
|
22
|
+
- **Roger Reviewer** - Code Quality & Review Standards
|
|
23
|
+
- **Sam Coder** - Efficient Implementation Expert
|
|
24
|
+
- **Seth Security** - Security & Permission Management
|
|
25
|
+
- **Taylor Docs** - Documentation & Knowledge Management
|
|
26
|
+
- **Uma UX** - User Experience & Interface Design
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
This repository is consumed by the BC Code Intelligence MCP server via git submodule. Content is pure markdown with YAML frontmatter.
|
|
30
|
+
|
|
31
|
+
## Contributing
|
|
32
32
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for content standards and submission process.
|