Skip to content

Commit 79ed124

Browse files
committed
docs: update readme and docs
1 parent e0cd598 commit 79ed124

9 files changed

Lines changed: 11 additions & 16 deletions

File tree

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@
1010
</p>
1111

1212
<p align="center">
13-
<a href="#-what's-`mcp-ui`?">What's mcp-ui?</a> •
13+
<a href="#-whats-mcp-ui">What's mcp-ui?</a> •
1414
<a href="#-core-concepts">Core Concepts</a> •
1515
<a href="#-installation">Installation</a> •
1616
<a href="#-quickstart">Quickstart</a> •
17-
<a href="#-core-concepts">Core Concepts</a> •
1817
<a href="#-examples">Examples</a> •
1918
<a href="#-security">Security</a> •
2019
<a href="#-roadmap">Roadmap</a> •

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ docs/
7474
- Clean, organized sidebar with collapsible sections
7575
- Breadcrumb navigation
7676
- "Edit on GitHub" links
77-
- Social media links (GitHub, npm, Discord)
77+
- Social media links (GitHub, npm)
7878

7979
### Content
8080
- Professional typography with proper hierarchy

docs/src/.vitepress/config.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,7 @@ export default defineConfig({
129129

130130
socialLinks: [
131131
{ icon: 'github', link: 'https://github.com/idosal/mcp-ui' },
132-
{ icon: 'npm', link: 'https://www.npmjs.com/package/@mcp-ui/client' },
133-
{ icon: 'discord', link: 'https://discord.gg/mcp-ui' }, // Update with actual Discord link
132+
{ icon: 'npm', link: 'https://www.npmjs.com/package/@mcp-ui/server' }
134133
],
135134

136135
footer: {

docs/src/guide/client/usage-examples.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Here's how to use the `<ResourceRenderer />` component from `@mcp-ui/client`.
44

55
## Installation
66

7-
Make sure you have `@mcp-ui/client` and its peer dependencies installed in your React project:
7+
Make sure you have `@mcp-ui/client` and its peer dependencies installed in your project:
88

99
```bash
10-
pnpm add @mcp-ui/client react @modelcontextprotocol/sdk
10+
npm i @mcp-ui/client
1111
```
1212

1313
## Rendering HTML Resources
@@ -96,7 +96,7 @@ const App: React.FC = () => {
9696

9797
return (
9898
<div>
99-
<h1>MCP UI Client Demo</h1>
99+
<h1>MCP-UI Client Demo</h1>
100100
<button onClick={() => loadResource('direct')}>
101101
Load Direct HTML (Text)
102102
</button>

docs/src/guide/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ For MCP servers, ensure you have `@mcp-ui/server` available in your Node.js proj
176176
For MCP clients, ensure `@mcp-ui/client` and its peer dependencies (`react` and potentially `@modelcontextprotocol/sdk`) are installed in your React project.
177177
178178
```bash
179-
pnpm add @mcp-ui/client react @modelcontextprotocol/sdk
179+
npm i @mcp-ui/client
180180
```
181181
182182
## Key Components

docs/src/guide/server/usage-examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ This page provides practical examples for using the `@mcp-ui/server` package.
44

55
## Basic Setup
66

7-
First, ensure you have `@mcp-ui/server` available in your project. If you're working outside this monorepo, you would typically install them:
7+
First, ensure you have `@mcp-ui/server` available in your project:
88

99
```bash
10-
pnpm add @mcp-ui/server
10+
npm i @mcp-ui/server
1111
```
1212

1313
## Basic Usage

examples/server/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
<a href="#-what-is-mcp-ui">What's mcp-ui?</a> •
1010
<a href="#-installation">Installation</a> •
1111
<a href="#-quickstart">Quickstart</a> •
12-
<a href="#-core-concepts">Core Concepts</a> •
1312
<a href="#-examples">Examples</a> •
1413
<a href="#-roadmap">Roadmap</a> •
1514
<a href="#-contributing">Contributing</a> •

packages/client/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@
1010
</p>
1111

1212
<p align="center">
13-
<a href="#-what's-`mcp-ui`?">What's mcp-ui?</a> •
13+
<a href="#-whats-mcp-ui">What's mcp-ui?</a> •
1414
<a href="#-core-concepts">Core Concepts</a> •
1515
<a href="#-installation">Installation</a> •
1616
<a href="#-quickstart">Quickstart</a> •
17-
<a href="#-core-concepts">Core Concepts</a> •
1817
<a href="#-examples">Examples</a> •
1918
<a href="#-security">Security</a> •
2019
<a href="#-roadmap">Roadmap</a> •

packages/server/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@
1010
</p>
1111

1212
<p align="center">
13-
<a href="#-what's-`mcp-ui`?">What's mcp-ui?</a> •
13+
<a href="#-whats-mcp-ui">What's mcp-ui?</a> •
1414
<a href="#-core-concepts">Core Concepts</a> •
1515
<a href="#-installation">Installation</a> •
1616
<a href="#-quickstart">Quickstart</a> •
17-
<a href="#-core-concepts">Core Concepts</a> •
1817
<a href="#-examples">Examples</a> •
1918
<a href="#-security">Security</a> •
2019
<a href="#-roadmap">Roadmap</a> •

0 commit comments

Comments
 (0)