Skip to content

Commit a899cf4

Browse files
Enhance documentation by adding clarifications and improving structure in Copilot instructions, memory tools reference, and memory usage guide; streamline content for better usability
1 parent 83f95ac commit a899cf4

5 files changed

Lines changed: 20 additions & 1 deletion

File tree

copilot-instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Quick Reference
44

5+
You may inspect files beneath the `.github` directory. Don't neglect to check here if you cant find a specific file you're looking for.
6+
57
Use these core memory tools to effectively manage project knowledge:
68

79
```text

copilot/docs/main-instructions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
This guide provides essential information for working efficiently with GitHub Copilot and project memory.
66

77
## Contents
8+
89
- [Quick Start](#quick-start)
910
- [Core Information Sources](#core-information-sources)
1011
- [Key Best Practices](#key-best-practices)
@@ -44,6 +45,7 @@ This guide provides essential information for working efficiently with GitHub Co
4445
## Core Information Sources
4546

4647
### Memory Management
48+
4749
| When you need... | Use this document |
4850
|------------------|-------------------|
4951
| Tool reference & examples | [Memory Tools Reference](memory-tools-reference.md) |
@@ -52,12 +54,14 @@ This guide provides essential information for working efficiently with GitHub Co
5254
| Entity structure guidance | [Project Memory Organization](project-memory-organization.md) |
5355

5456
### Knowledge Management
57+
5558
| When you need... | Use this document |
5659
|------------------|-------------------|
5760
| Discovery process | [Unknown Information Management](unknown-info-management.md) |
5861
| Knowledge tracking | [Project Knowledge Management](project-knowledge-management.md) |
5962

6063
### Development Guidelines
64+
6165
| When you need... | Use this document |
6266
|------------------|-------------------|
6367
| Process guidelines | [Workflow Guidelines](workflow-guidelines.md) |
@@ -84,6 +88,7 @@ cd .github/copilot
8488
```
8589

8690
This script:
91+
8792
- Creates timestamped backups
8893
- Sorts entities by logical groups
8994
- Standardizes property ordering

copilot/docs/memory-tools-reference.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
Your memory is managed by the `mcp-knowledge-graph` server, which provides these tools:
66

77
## Contents
8+
89
- [Reading Tools](#reading-tools)
910
- [Writing Tools](#writing-tools)
1011
- [Maintenance Tools](#maintenance-tools)
@@ -20,6 +21,7 @@ Your memory is managed by the `mcp-knowledge-graph` server, which provides these
2021
| `read_graph` | View entire memory graph | `9f1_read_graph()` |
2122

2223
**When to use each tool:**
24+
2325
- **search_nodes**: Use first for any information lookup (searches entity content)
2426
- **open_nodes**: Use when you know exact entity names
2527
- **read_graph**: Use only when other methods fail or you need full context
@@ -33,11 +35,13 @@ Your memory is managed by the `mcp-knowledge-graph` server, which provides these
3335
| `create_relations` | Link related entities | `9f1_create_relations(relations: [{"from": "AppDataStorage", "relationType": "implements", "to": "JSON Serialization"}])` |
3436

3537
**When to use each tool:**
38+
3639
- **add_observations**: Always try this first before creating new entities
3740
- **create_entities**: Create new entities only when they don't already exist
3841
- **create_relations**: Create meaningful connections between entities
3942

4043
**Important Note About create_entities**:
44+
4145
- The `create_entities` tool returns a list of successfully created entities
4246
- If an entity you intended to create is not included in the response, it means that entity already exists in memory
4347
- Existing entities are not updated by `create_entities` - use `add_observations` for those instead
@@ -61,6 +65,7 @@ cd .github/copilot
6165
```
6266

6367
This script automatically:
68+
6469
- Creates timestamped backups before changes
6570
- Sorts entities by logical type groups
6671
- Arranges properties in consistent order
@@ -71,28 +76,33 @@ This script automatically:
7176
### Information Lookup Workflow
7277

7378
1. **Start with targeted search**:
79+
7480
```text
7581
9f1_search_nodes(query: "AppDataStorage")
7682
```
7783

7884
2. **If targeted search doesn't find what you need**, try viewing specific entities:
85+
7986
```text
8087
9f1_open_nodes(names: ["AppDataStorage", "ImGuiWidgets"])
8188
```
8289

8390
3. **Only as a last resort**, view the entire graph:
91+
8492
```text
8593
9f1_read_graph()
8694
```
8795

8896
### Information Creation Workflow
8997

9098
1. **First check if entity exists**:
99+
91100
```text
92101
9f1_search_nodes(query: "EntityName")
93102
```
94103

95104
2. **Try adding observations first** (will fail if entity doesn't exist):
105+
96106
```text
97107
9f1_add_observations(observations: [{
98108
"entityName": "AppDataStorage",
@@ -101,6 +111,7 @@ This script automatically:
101111
```
102112

103113
3. **If add_observations fails, create the entity**:
114+
104115
```text
105116
9f1_create_entities(entities: [{
106117
"name": "AppDataStorage",
@@ -114,6 +125,7 @@ This script automatically:
114125
- If your entity is missing from the returned list → Entity already existed (use add_observations instead)
115126

116127
5. **Create relationships to connect entities**:
128+
117129
```text
118130
9f1_create_relations(relations: [{
119131
"from": "AppDataStorage",

copilot/docs/memory-usage-guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
> **TL;DR:** Search before retrieving the full graph, use consistent entity patterns, add observations incrementally, and update memory in real-time.
44
55
## Contents
6+
67
- [Core Principles](#core-principles)
78
- [Memory Retrieval Workflow](#memory-retrieval-workflow)
89
- [Memory Creation Best Practices](#memory-creation-best-practices)

profile/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,4 +136,3 @@ Visit our [GitHub repositories](https://github.com/ktsu-dev) to get started.
136136
|[SyncFileContents](https://github.com/ktsu-dev/SyncFileContents)|![GitHub Version](https://img.shields.io/github/v/release/ktsu-dev/SyncFileContents?label=&logo=github)| |![GitHub commit activity](https://img.shields.io/github/commit-activity/m/ktsu-dev/SyncFileContents?label=&logo=github)|![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ktsu-dev/SyncFileContents/dotnet.yml?label=&logo=github)|![README](https://img.shields.io/badge/passing-brightgreen?label=&logo=mdbook)|
137137
|[TextFilter](https://github.com/ktsu-dev/TextFilter)|![NuGet Version](https://img.shields.io/nuget/v/ktsu.TextFilter?label=&logo=nuget)|![NuGet Downloads](https://img.shields.io/nuget/dt/ktsu.TextFilter?label=&logo=nuget)|![GitHub commit activity](https://img.shields.io/github/commit-activity/m/ktsu-dev/TextFilter?label=&logo=github)|![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ktsu-dev/TextFilter/dotnet.yml?label=&logo=github)|![README](https://img.shields.io/badge/passing-brightgreen?label=&logo=mdbook)|
138138
|[ToStringJsonConverter](https://github.com/ktsu-dev/ToStringJsonConverter)|![NuGet Version](https://img.shields.io/nuget/v/ktsu.ToStringJsonConverter?label=&logo=nuget)|![NuGet Downloads](https://img.shields.io/nuget/dt/ktsu.ToStringJsonConverter?label=&logo=nuget)|![GitHub commit activity](https://img.shields.io/github/commit-activity/m/ktsu-dev/ToStringJsonConverter?label=&logo=github)|![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ktsu-dev/ToStringJsonConverter/dotnet.yml?label=&logo=github)|![README](https://img.shields.io/badge/passing-brightgreen?label=&logo=mdbook)|
139-

0 commit comments

Comments
 (0)