Skip to content

Commit 3a9e574

Browse files
committed
docs: update README with MCP instructions and ignore .gemini
1 parent b3cc4f1 commit 3a9e574

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111
# production
1212
/build
1313

14+
# ai
15+
.gemini
16+
GEMINI.md
17+
1418
# misc
1519
.DS_Store
1620
.env.local

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,25 @@ Imagine you have a giant digital toy box. Inside, you keep the cool things you'v
2323
- **Content**: Markdown and **PIML** (Plain Old Markup Language) for structured content.
2424
- **Build Tools**: Craco (CRA Configuration Override) for custom build pipelines.
2525
- **Persistence**: Local Storage for settings, achievements, and persistent state.
26+
- **AI Tooling**: **Model Context Protocol (MCP)** server for automated content management.
2627

2728
---
2829

30+
## Model Context Protocol (MCP)
31+
Fezcodex includes a custom MCP server to assist AI agents (like Gemini) in managing content.
32+
33+
### Tools Provided:
34+
- `create_blog_post`: Automates the creation of blog posts, including file generation, metadata registry updates, and RSS/Sitemap regeneration.
35+
36+
### Integration with Gemini CLI:
37+
To use this server with your Gemini CLI, run:
38+
```bash
39+
gemini mcp add fezcodex-blog-writer --command "node scripts/mcp-server/index.mjs"
40+
# or
41+
gemini mcp add --scope project fezcodex npm run mcp
42+
```
43+
Once added, the AI can create blog posts directly through its toolset.
44+
2945
## Project Structure
3046
- `src/app/`: Domain logic, core features, and views (Achievements, OS, Command Palette, etc.).
3147
- `src/components/`: Reusable UI components (Buttons, Modals, Cards).
@@ -109,6 +125,11 @@ Every core component should be **Theme-Aware**:
109125
- Use `VisualSettingsContext.jsx` for any UI state that needs to survive a page refresh (Invert mode, Theme selection, etc.).
110126
- Use `usePersistentState` hook to automatically sync your context variables with `localStorage`.
111127

128+
### 5. AI-Assisted Content Creation (MCP)
129+
If you are using an AI agent with MCP support:
130+
- **Blog Posts:** Use the `create_blog_post` tool provided by the local MCP server. It handles file creation, metadata indexing, and build script execution in one step.
131+
- **Verification:** Always run `npm run lint` after AI-generated changes to ensure style compliance.
132+
112133
---
113134

114135
## Github Pages Configuration

0 commit comments

Comments
 (0)