Add CodingBuddy Configuration Schema#24
Merged
Merged
Conversation
- Add TypeScript types and Zod validation schema - Add comprehensive test coverage - Add configuration documentation close #23
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add CodingBuddy Configuration Schema
📋 Summary
Introduces a standardized configuration schema for CodingBuddy that allows users to provide project-specific context (tech stack, architecture, conventions, test strategy) to AI assistants. All fields are optional to lower the barrier to entry.
Closes #19
🎯 Problem
Context Gap
AI coding assistants don't know your project context. When developers start using AI assistants, they must repeatedly explain:
This creates a "repetition tax" where developers re-explain project context in every conversation.
Current Limitations
✨ Solution
Configuration Schema
A comprehensive, optional configuration schema that provides project context:
Basic Settings
language: Response language (ko, en, ja, etc.)projectName: Project namedescription: Project descriptionrepository: Repository URLTech Stack (
techStack)Architecture (
architecture)Conventions (
conventions)Test Strategy (
testStrategy)Additional Context
keyFiles: Important files AI should know aboutavoid: Topics or areas to avoidcustom: Freeform custom contextKey Design Principles
.ai-rulesremain unchanged📊 Files Changed
docs/config-schema.md(266 lines) - Comprehensive documentationmcp-server/src/config/config.types.ts(43 lines) - TypeScript typesmcp-server/src/config/config.schema.ts(202 lines) - Zod validation schemamcp-server/src/config/config.schema.spec.ts(273 lines) - Test suitemcp-server/src/config/index.ts(34 lines) - Public API exportsTotal: 5 files changed, +818 insertions
🔑 Key Features
Type Safety
Validation
Test Coverage
Documentation
✅ Benefits
📝 Usage Example
🧪 Testing