Skip to content

Commit 77af58d

Browse files
committed
style: Modernize README with centered layout and badges
- Add flat-style badges for Node.js, TypeScript, MCP SDK, and dependencies - Restructure installation section into clean table format - Apply centered alignment throughout document - Match styling from meteor-client-webgui reference repo - Use actual version numbers from package.json
1 parent f8286f2 commit 77af58d

1 file changed

Lines changed: 48 additions & 17 deletions

File tree

README.md

Lines changed: 48 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,54 @@
33
# Baritone Docs MCP
44

55
A Model Context Protocol server for Baritone documentation.
6-
<br>
76

7+
</div>
8+
9+
<div align="center">
10+
11+
![Node.js](https://img.shields.io/badge/Node.js-18+-339933?style=flat&logo=node.js&logoColor=white)
12+
![TypeScript](https://img.shields.io/badge/TypeScript-5.9.3-3178C6?style=flat&logo=typescript&logoColor=white)
13+
![MCP SDK](https://img.shields.io/badge/MCP%20SDK-1.24.3-blue?style=flat)
14+
![Axios](https://img.shields.io/badge/Axios-1.13.2-5A29E4?style=flat)
15+
![Zod](https://img.shields.io/badge/Zod-4.1.13-3E67B1?style=flat)
16+
![Vitest](https://img.shields.io/badge/Vitest-4.0.15-6E9F18?style=flat&logo=vitest&logoColor=white)
17+
![License](https://img.shields.io/badge/License-ISC-blue?style=flat)
18+
19+
</div>
20+
21+
<div align="center">
822

23+
**Fuzzy search, read, and refresh Baritone documentation through the Model Context Protocol**
924

10-
<br>
25+
</div>
26+
27+
<div align="center">
1128

1229
## Features
1330

31+
</div>
32+
33+
<div align="center">
34+
1435
| Feature | Description |
15-
| :---: | :---: |
36+
| :---: | :--- |
1637
| **Refresh Docs** | Downloads and updates the local documentation cache directly from GitHub. |
1738
| **Search Docs** | Performs fuzzy search across documentation files to find relevant topics. |
1839
| **Read Doc** | Retrieves the full text content of specific documentation files. |
1940
| **Resource Access** | Exposes documentation via the `docs://` URI scheme for direct reference. |
2041

21-
<br>
42+
</div>
43+
44+
<div align="center">
2245

2346
## Project Structure
2447

48+
</div>
49+
50+
<div align="center">
51+
2552
| File / Directory | Description |
26-
| :---: | :---: |
53+
| :---: | :--- |
2754
| `src/index.ts` | Main entry point initializing the MCP server and tools. |
2855
| `src/tools/` | Contains logic for search and read functionalities. |
2956
| `src/resources/` | Handles `docs://` resource requests. |
@@ -35,32 +62,36 @@ A Model Context Protocol server for Baritone documentation.
3562

3663
<div align="center">
3764

38-
**Install the MCP Server**
65+
## Installation
3966

4067
</div>
4168

42-
```bash
43-
# Clone the repository
44-
git clone https://github.com/MCDxAI/baritone-docs-mcp.git
45-
cd code-search-mcp
69+
<div align="center">
4670

47-
# Install dependencies
48-
npm install
71+
| Step | Instructions |
72+
| :---: | :--- |
73+
| **1. Clone the repository** | `git clone https://github.com/MCDxAI/baritone-docs-mcp.git`<br>`cd baritone-docs-mcp` |
74+
| **2. Install dependencies** | `npm install` |
75+
| **3. Build the project** | `npm run build` |
4976

50-
# Build the project
51-
npm run build
52-
```
77+
</div>
5378

5479
<div align="center">
55-
<h2>Configuration</h2>
80+
81+
## Configuration
82+
5683
</div>
5784

85+
<div align="center">
86+
5887
Add to your MCP settings file (e.g., `claude_desktop_config.json`):
5988

89+
</div>
90+
6091
```json
6192
{
6293
"mcpServers": {
63-
"code-search": {
94+
"baritone-docs": {
6495
"command": "node",
6596
"args": [
6697
"/path/to/baritone-docs-mcp/dist/index.js"

0 commit comments

Comments
 (0)