Skip to content

Commit a07be40

Browse files
authored
Merge pull request #2 from MCDxAI/claude/modernize-readme-styling-013dBhaJz7h9bG15xGf8mYEc
docs: Modernize README with centered layout and badges
2 parents f8286f2 + 768d8fe commit a07be40

1 file changed

Lines changed: 47 additions & 17 deletions

File tree

README.md

Lines changed: 47 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,53 @@
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+
18+
</div>
19+
20+
<div align="center">
821

22+
**Fuzzy search, read, and refresh Baritone documentation through the Model Context Protocol**
923

10-
<br>
24+
</div>
25+
26+
<div align="center">
1127

1228
## Features
1329

30+
</div>
31+
32+
<div align="center">
33+
1434
| Feature | Description |
15-
| :---: | :---: |
35+
| :---: | :--- |
1636
| **Refresh Docs** | Downloads and updates the local documentation cache directly from GitHub. |
1737
| **Search Docs** | Performs fuzzy search across documentation files to find relevant topics. |
1838
| **Read Doc** | Retrieves the full text content of specific documentation files. |
1939
| **Resource Access** | Exposes documentation via the `docs://` URI scheme for direct reference. |
2040

21-
<br>
41+
</div>
42+
43+
<div align="center">
2244

2345
## Project Structure
2446

47+
</div>
48+
49+
<div align="center">
50+
2551
| File / Directory | Description |
26-
| :---: | :---: |
52+
| :---: | :--- |
2753
| `src/index.ts` | Main entry point initializing the MCP server and tools. |
2854
| `src/tools/` | Contains logic for search and read functionalities. |
2955
| `src/resources/` | Handles `docs://` resource requests. |
@@ -35,32 +61,36 @@ A Model Context Protocol server for Baritone documentation.
3561

3662
<div align="center">
3763

38-
**Install the MCP Server**
64+
## Installation
3965

4066
</div>
4167

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

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

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

5478
<div align="center">
55-
<h2>Configuration</h2>
79+
80+
## Configuration
81+
5682
</div>
5783

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

88+
</div>
89+
6090
```json
6191
{
6292
"mcpServers": {
63-
"code-search": {
93+
"baritone-docs": {
6494
"command": "node",
6595
"args": [
6696
"/path/to/baritone-docs-mcp/dist/index.js"

0 commit comments

Comments
 (0)