Skip to content

Commit 13ca274

Browse files
Royal-lobsterclaude
andcommitted
docs: add progress.txt with changelog for README standardization
Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent fdcd559 commit 13ca274

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

progress.txt

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Progress Log - mcp-telegram
2+
3+
## 2026-01-28: Standardize README and Add MCP Tool Auto-Sync Workflow
4+
5+
### Task
6+
Update mcp-telegram: cd into mcp-telegram, create branch feat/standardize-readme, update README structure, copy workflows from mcp-opinion, commit, push, create PR, merge
7+
8+
### Changes Made
9+
10+
1. **README Structure Standardization**
11+
- Restructured README.md to match standardized format from mcp-opinion
12+
- Added npm version badge and MIT license badge
13+
- Added "Overview" section with project description
14+
- Reorganized "Features" section with Core Tools and AI Sampling subsections
15+
- Added "Installation" section with npx and build-from-source options
16+
- Added "Running with an MCP Client" section with minimal and advanced config examples
17+
- Added "Configuration (Environment Variables)" section organized into tables:
18+
- Required variables
19+
- Sampling configuration
20+
- Access control
21+
- Rate limiting
22+
- Message type support
23+
- Content filtering
24+
- Added "Usage Examples" section
25+
- Added "MCP Tools" section with AUTO-GENERATED markers for tool documentation
26+
- Added "Development" section with build, watch, lint/format commands
27+
- Added "Project Structure" section
28+
- Added "Resources" and "Disclaimer" sections
29+
30+
2. **Workflow Updates**
31+
- Updated `.github/workflows/push.yml` to manual trigger template (workflow_dispatch)
32+
- Updated `.github/workflows/release.yml` to manual trigger template (workflow_dispatch)
33+
- Added `.github/workflows/sync-tools.yml` to auto-sync MCP tool documentation on push to main
34+
35+
3. **GitHub Action for Tool Documentation**
36+
- Created `.github/actions/generate-mcp-tools/generate-tools.mjs`
37+
- Generates markdown table documentation from tool Zod schemas
38+
- Updates README.md between AUTO-GENERATED markers
39+
40+
4. **Testing**
41+
- Added vitest for testing
42+
- Created `tests/tools.test.ts` with 25 comprehensive tests
43+
- Tests validate all 5 MCP tools' parameter schemas:
44+
- SEND_MESSAGE
45+
- GET_CHANNEL_INFO
46+
- FORWARD_MESSAGE
47+
- PIN_MESSAGE
48+
- GET_CHANNEL_MEMBERS
49+
- Added `vitest.config.ts` configuration
50+
51+
5. **Dependencies**
52+
- Added `vitest: ^4.0.18` to devDependencies
53+
- Added `zod-to-json-schema: ^3.25.1` to devDependencies
54+
- Added `test` and `test:watch` scripts to package.json
55+
56+
### Verification
57+
- Build passes: `pnpm run build`
58+
- All tests pass: `pnpm run test` (25 tests)
59+
- Linting passes: `pnpm run lint`
60+
61+
### PR
62+
- PR #14: https://github.com/IQAIcom/mcp-telegram/pull/14
63+
- Status: Merged

0 commit comments

Comments
 (0)