Skip to content
This repository was archived by the owner on Dec 17, 2025. It is now read-only.

Commit ce40d52

Browse files
committed
doc: update my own context
1 parent bcde836 commit ce40d52

File tree

2 files changed

+41
-25
lines changed

2 files changed

+41
-25
lines changed

.context/docs.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
contextdocs:
3+
- name: Model Context Protocol (MCP)
4+
relationship: Core protocol implemented by this project
5+
resources:
6+
- Official Documentation: https://modelcontextprotocol.io/docs/concepts/architecture
7+
- TypeScript SDK: https://github.com/modelcontextprotocol/typescript-sdk
8+
9+
- name: TypeScript
10+
relationship: Main language for linter implementation
11+
resources:
12+
- Official Documentation: https://www.typescriptlang.org/docs/
13+
- TypeScript Handbook: https://www.typescriptlang.org/docs/handbook/intro.html
14+
- TypeScript Deep Dive: https://basarat.gitbook.io/typescript/
15+
16+
- name: Node.js
17+
relationship: Runtime environment for TypeScript linter
18+
resources:
19+
- Official Documentation: https://nodejs.org/en/docs/
20+
- Getting Started Guide: https://nodejs.org/en/docs/guides/getting-started-guide/
21+
- Node.js Best Practices: https://github.com/goldbergyoni/nodebestpractices
22+
23+
- name: Jest
24+
relationship: Testing framework for TypeScript linter
25+
resources:
26+
- Official Documentation: https://jestjs.io/docs/getting-started
27+
- Testing TypeScript with Jest: https://basarat.gitbook.io/typescript/intro-1/jest
28+
- Jest with TypeScript in Node.js: https://stackoverflow.com/questions/54822273/how-to-use-jest-with-typescript-in-node-js
29+
30+
---

.context/index.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
module-name: Codebase Context CLI
33
version: 0.1.0
4-
description: A CLI tool for managing and validating codebase context specifications, helping developers implement the CCS standard effectively.
4+
description: MCP Server and a CLI tool for managing and validating dotcontext (.context) directories.
55
technologies:
6+
- MCP Server
67
- Node.js
78
- TypeScript
89
- Commander.js
@@ -12,10 +13,11 @@ conventions:
1213
- Implement semantic versioning
1314
- Write unit tests for all features
1415
architecture:
15-
style: CLI Application
16+
style: IDE Utilities via npx/npm
1617
components:
18+
- Content Collector - helps build a prompt from unstructured data in main module and submodules (core prompt generation functionality)
19+
- Context Generator - supports the init commands and generates a starter template (analagous to git init)
1720
- Context Validator
18-
- Context Generator
1921
- Context Linter
2022
development:
2123
setup-steps:
@@ -37,9 +39,9 @@ permissions:
3739
allow-ai-modifications: true
3840
---
3941

40-
# Codebase Context CLI
42+
# Codebase Context MCP & CLI
4143

42-
A command-line interface tool for managing and validating codebase context specifications. This tool helps developers implement the Codebase Context Specification (CCS) effectively by providing utilities for creation, validation, and maintenance of `.context` directories.
44+
A command-line interface tool for managing and validating codebase context specifications. This tool helps developers implement the Codebase Context Specification (CCS) effectively by providing utilities for creation, validation, and maintenance of `.context` directories. It also provides your tools with an MCP server that lets them pull in the .context into your context window. T
4345

4446
## Key Features
4547

@@ -50,29 +52,13 @@ A command-line interface tool for managing and validating codebase context speci
5052

5153
## Project Goals
5254

53-
1. Replace and enhance the functionality of the existing `codebase-context-lint` package
54-
2. Provide a more user-friendly CLI interface for managing context files
55-
3. Help standardize the implementation of the CCS across projects
56-
4. Facilitate better documentation practices in development teams
55+
1. Help save / use summaries and descriptions for your coding agent relevant to your repositories
56+
2. Help standardize the implementation of the CCS across projects letting AI understand across repositories
57+
3. Facilitate better documentation practices in development teams
5758

5859
## Architecture
5960

60-
The tool is built as a Node.js CLI application using TypeScript and Commander.js. It follows a modular architecture with distinct components for different functionalities:
61-
62-
- **Context Validator**: Ensures `.context` directories comply with the CCS
63-
- **Context Generator**: Creates new context files and directories
64-
- **Context Linter**: Checks for best practices and potential improvements
61+
Supports basic functions through CLI and MCP interfaces.
6562

6663
See the [architecture diagram](diagrams/architecture.mmd) for a visual representation of how the MCP server exposes tools that interact with the core components. The Context Manager acts as a central coordinator, leveraging the Validator and Linter as needed.
6764

68-
## Development Roadmap
69-
70-
1. Initial CLI setup with basic commands
71-
2. Implementation of context validation
72-
3. Context generation utilities
73-
4. Advanced linting features
74-
5. Integration with popular IDEs and tools
75-
76-
## Contributing
77-
78-
Contributions are welcome! Please ensure you follow our contribution guidelines and maintain test coverage for new features.

0 commit comments

Comments
 (0)