Skip to content

Commit ba90d0f

Browse files
authored
docs: improve readme
1 parent d949c74 commit ba90d0f

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
1-
# @codelytv/mcp-client
1+
<p align="center">
2+
<a href="https://codely.com">
3+
<img alt="Codely logo" src="https://codely.com/logo/codely_logo.svg">
4+
</a>
5+
</p>
6+
7+
<h1 align="center">
8+
🔌 MCP Client
9+
</h1>
10+
11+
<p align="center">
12+
<a href="https://github.com/CodelyTV"><img src="https://img.shields.io/badge/CodelyTV-OS-green.svg?style=flat-square" alt="Codely Open Source"/></a>
13+
<a href="https://pro.codely.com"><img src="https://img.shields.io/badge/CodelyTV-PRO-black.svg?style=flat-square" alt="CodelyTV Courses"/></a>
14+
</p>
15+
16+
<p align="center">
17+
A TypeScript test client for Model Context Protocol (MCP) servers that provides a convenient way to test MCP functionality in your test suites.
18+
<br />
19+
<br />
20+
Take a look, play and have fun with this.
21+
<a href="https://github.com/CodelyTV/typescript-mcp-client/stargazers">Stars are welcome 😊</a>
22+
</p>
223

3-
A TypeScript test client for Model Context Protocol (MCP) servers that provides a convenient way to test MCP functionality in your test suites.
424

525
## Installation
626

@@ -69,6 +89,17 @@ The main client class for interacting with MCP servers.
6989
- `listPrompts()` - List available prompts
7090
- `getPrompt(name: string, args?: Record<string, unknown>)` - Get a prompt
7191

92+
## Codely Code Quality Standards
93+
94+
Publishing this package we are committing ourselves to the following code quality standards:
95+
96+
- 🤝 Respect **Semantic Versioning**: No breaking changes in patch or minor versions
97+
- 🤏 No surprises in transitive dependencies: Use the **bare minimum dependencies** needed to meet the purpose
98+
- 🎯 **One specific purpose** to meet without having to carry a bunch of unnecessary other utilities
99+
- ✅ **Tests** as documentation and usage examples
100+
- 📖 **Well documented ReadMe** showing how to install and use
101+
- ⚖️ **License favoring Open Source** and collaboration
102+
72103
## License
73104

74105
See [LICENSE](LICENSE)

0 commit comments

Comments
 (0)