-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathproject-context.json
More file actions
348 lines (348 loc) · 11.2 KB
/
project-context.json
File metadata and controls
348 lines (348 loc) · 11.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"version": "0.1.0-alpha",
"lastUpdated": "2025-12-30",
"project": {
"name": "DotNetDevMCP",
"description": "The Ultimate .NET Development MCP Server - One Tool to Rule Them All",
"type": "MCP Server",
"targetFramework": "net9.0",
"language": "C#",
"license": "MIT",
"repository": "https://github.com/YOUR_USERNAME/DotNetDevMCP"
},
"philosophy": {
"vision": "A comprehensive one-stop shop for .NET developers combining deep code intelligence with advanced orchestration capabilities",
"principles": [
"Performance optimization through concurrent operations",
"Context efficiency for AI consumption",
"Test-Driven Development (TDD)",
"Comprehensive documentation",
"Simplicity over complexity",
"Extensibility and modularity"
],
"targetUsers": [
"Solo developers",
"Development teams",
"AI-assisted development workflows"
],
"targetProjects": [
"Greenfield .NET projects",
"Legacy codebase modernization",
"All .NET stacks (ASP.NET Core, Blazor, MAUI, etc.)"
]
},
"architecture": {
"style": "Modular layered architecture",
"patterns": [
"Service-oriented",
"Plugin architecture",
"Concurrent operations with async/await",
"MCP protocol integration"
],
"layers": {
"core": {
"name": "DotNetDevMCP.Core",
"purpose": "Core abstractions, interfaces, and shared models",
"dependencies": []
},
"codeIntelligence": {
"name": "DotNetDevMCP.CodeIntelligence",
"purpose": "Roslyn-based analysis, integrated from SharpTools",
"dependencies": ["Core", "Roslyn", "Microsoft.CodeAnalysis"],
"keyCapabilities": [
"Symbol navigation",
"Type hierarchy",
"Reference finding",
"Code modifications"
]
},
"sourceControl": {
"name": "DotNetDevMCP.SourceControl",
"purpose": "Advanced Git integration (Level C: Deep)",
"dependencies": ["Core", "LibGit2Sharp"],
"keyCapabilities": [
"Merge analysis",
"Code review automation",
"Blame integration",
"Conflict resolution",
"Branch strategy",
"Commit history analysis"
]
},
"testing": {
"name": "DotNetDevMCP.Testing",
"purpose": "Test orchestration and parallel execution",
"dependencies": ["Core", "Build"],
"keyCapabilities": [
"Test discovery (xUnit, NUnit, MSTest)",
"Parallel execution",
"Coverage analysis",
"Test result aggregation"
]
},
"build": {
"name": "DotNetDevMCP.Build",
"purpose": "MSBuild integration and build intelligence",
"dependencies": ["Core", "Microsoft.Build"],
"keyCapabilities": [
"Build diagnostics",
"Pipeline analysis",
"Dependency graph",
"Build optimization"
]
},
"monitoring": {
"name": "DotNetDevMCP.Monitoring",
"purpose": "Log analysis and performance profiling",
"dependencies": ["Core"],
"keyCapabilities": [
"Log pattern detection",
"Performance profiling",
"Error aggregation",
"Metrics analysis"
]
},
"documentation": {
"name": "DotNetDevMCP.Documentation",
"purpose": "AI-friendly documentation generation",
"dependencies": ["Core", "CodeIntelligence"],
"keyCapabilities": [
"XML doc extraction",
"Markdown generation",
"Architecture diagrams (Mermaid)",
"Context file updates"
]
},
"orchestration": {
"name": "DotNetDevMCP.Orchestration",
"purpose": "Concurrent operations and workflow management",
"dependencies": ["Core", "All other layers"],
"keyCapabilities": [
"Parallel task execution",
"Multi-solution operations",
"Agent coordination",
"Resource optimization"
]
},
"server": {
"name": "DotNetDevMCP.Server",
"purpose": "MCP protocol server implementation",
"dependencies": ["All layers"],
"protocols": ["stdio", "SSE (HTTP)"],
"keyCapabilities": [
"MCP tool exposure",
"Request routing",
"Session management"
]
}
}
},
"keyTechnologies": {
"runtime": ".NET 9.0",
"analysisEngine": "Roslyn (Microsoft.CodeAnalysis)",
"buildSystem": "MSBuild",
"sourceControl": "LibGit2Sharp",
"testing": ["xUnit", "NUnit", "MSTest"],
"protocol": "Model Context Protocol (MCP)",
"serialization": "System.Text.Json",
"logging": "Microsoft.Extensions.Logging"
},
"designDecisions": [
{
"id": "ADR-001",
"title": "Fork SharpTools instead of pluggable integration",
"status": "Accepted",
"date": "2025-12-30",
"rationale": "Unified codebase allows optimization across features, simpler deployment, and complete control over the stack",
"consequences": [
"Single MCP server to maintain",
"Must credit SharpTools appropriately",
"Can contribute improvements upstream if desired"
]
},
{
"id": "ADR-002",
"title": "Prioritize concurrent operations",
"status": "Accepted",
"date": "2025-12-30",
"rationale": "User's primary pain point is performance; async/parallel operations across tests, builds, and analysis will significantly improve developer experience",
"consequences": [
"Need robust error handling for parallel operations",
"Resource management becomes critical",
"Complexity in orchestration layer"
]
},
{
"id": "ADR-003",
"title": "Deep Git integration (Level C)",
"status": "Accepted",
"date": "2025-12-30",
"rationale": "Full source control awareness enables advanced workflows like automated code review, merge conflict analysis, and branch strategy recommendations",
"consequences": [
"Dependency on LibGit2Sharp",
"Increased complexity",
"Rich feature set for Git-centric workflows"
]
},
{
"id": "ADR-004",
"title": "Test-Driven Development approach",
"status": "Accepted",
"date": "2025-12-30",
"rationale": "User requirement for TDD; ensures code quality and serves as living documentation",
"consequences": [
"Tests written before implementation",
"Higher initial development time",
"Better long-term maintainability"
]
},
{
"id": "ADR-005",
"title": "AI-friendly documentation as first-class citizen",
"status": "Accepted",
"date": "2025-12-30",
"rationale": "Machine-readable context files enable AI agents to understand the project holistically, improving AI-assisted development",
"consequences": [
"Documentation must be updated with every change",
"project-context.json becomes critical artifact",
"Enables better AI comprehension"
]
}
],
"developmentWorkflow": {
"methodology": "Test-Driven Development (TDD)",
"branchStrategy": "GitFlow (main, develop, feature/*, hotfix/*)",
"testingStrategy": {
"unitTests": "xUnit (preferred)",
"integrationTests": "Required for all MCP tools",
"coverage": "Minimum 80% target"
},
"documentationRequirements": [
"Update ADRs for architectural decisions",
"Update project-context.json with changes",
"Update architecture diagrams",
"XML doc comments for public APIs",
"Usage examples in samples/"
]
},
"integrationPoints": {
"mcpProtocol": {
"version": "1.0",
"transports": ["stdio", "SSE"],
"authentication": "None (local trust model)"
},
"externalTools": [
{
"name": "dotnet CLI",
"purpose": "Build, test, publish operations",
"required": true
},
{
"name": "git",
"purpose": "Source control operations",
"required": true
},
{
"name": "MSBuild",
"purpose": "Advanced build analysis",
"required": false
}
],
"suggestedMCPs": [
{
"name": "@modelcontextprotocol/server-filesystem",
"purpose": "Enhanced file operations",
"integration": "Complementary"
},
{
"name": "@modelcontextprotocol/server-git",
"purpose": "Basic Git operations (we extend this)",
"integration": "Optional fallback"
}
]
},
"currentState": {
"phase": "Initial Architecture",
"completedMilestones": [
"Project structure created",
"Documentation framework established",
"SharpTools source obtained"
],
"nextMilestones": [
"Integrate SharpTools codebase",
"Set up TDD framework",
"Implement concurrent operations architecture",
"Build advanced Git integration"
]
},
"performanceGoals": {
"codebaseSize": "Dynamic scaling (handle solutions from 10 to 10,000+ files)",
"analysisMode": "User-configurable (real-time or on-demand)",
"concurrency": "Maximize parallel operations where safe",
"tokenEfficiency": "Minimize context size for AI consumption",
"responseTime": "Sub-second for most operations, parallel execution for batch operations"
},
"conventions": {
"naming": {
"projects": "DotNetDevMCP.[Layer]",
"namespaces": "DotNetDevMCP.[Layer].[Feature]",
"interfaces": "I[Name]",
"abstractClasses": "[Name]Base",
"services": "[Name]Service"
},
"codeStyle": {
"guide": ".editorconfig in root",
"indentation": "4 spaces",
"lineLength": "120 characters max",
"nullability": "Enabled"
},
"testing": {
"naming": "[ClassUnderTest]Tests",
"organization": "Mirror src/ structure in tests/",
"testMethod": "[MethodName]_[Scenario]_[ExpectedBehavior]"
}
},
"knownLimitations": [
"Initial version focuses on C# (other .NET languages like F# may have limited support)",
"Git integration requires LibGit2Sharp compatibility",
"MSBuild integration may require Visual Studio Build Tools on some platforms"
],
"roadmap": {
"v0.1.0-alpha": {
"target": "2025-Q1",
"features": [
"Core architecture",
"SharpTools integration",
"Basic concurrent operations",
"Initial Git integration"
]
},
"v0.2.0-alpha": {
"target": "2025-Q2",
"features": [
"Testing orchestration",
"Build pipeline integration",
"Advanced Git features",
"Documentation generation"
]
},
"v1.0.0": {
"target": "2025-Q3",
"features": [
"Production-ready",
"Full feature set",
"Comprehensive documentation",
"Performance optimizations"
]
}
},
"metadata": {
"aiConsumption": {
"purpose": "This file provides comprehensive project context for AI agents",
"updateFrequency": "On every significant architectural change",
"readBy": "AI agents, developers, documentation tools",
"format": "JSON for machine readability, verbose for human understanding"
}
}
}