Skip to content

Commit 01cbbcc

Browse files
feat: updating docs
1 parent 5337147 commit 01cbbcc

2 files changed

Lines changed: 98 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Feature suggestions are welcome! Please:
2929

3030
### Pull Requests
3131

32-
1. Fork the repo and create your branch from `main`
32+
1. Fork the repo and create your branch from `develop`
3333
2. If you've added code that should be tested, add tests
3434
3. Ensure the test suite passes
3535
4. Make sure your code follows the existing style

README.md

Lines changed: 97 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@
1212
[![Bundle Size React](https://img.shields.io/bundlephobia/minzip/@computekit/react?label=react%20size)](https://bundlephobia.com/package/@computekit/react)
1313
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
1414
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue)](https://www.typescriptlang.org/)
15+
[![MCP Server](https://img.shields.io/badge/MCP-Server-blueviolet)](https://gitmcp.io/tapava/compute-kit)
1516
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/edit/compute-kit?file=README.md)
1617

17-
[📚 Documentation](https://tapava.github.io/compute-kit)[Live Demo](https://computekit-demo.vercel.app/)[Getting Started](#-getting-started)[Examples](#-examples)[API](#-api)[React Hooks](#-react-hooks)[WASM](#-webassembly-support)
18+
[📚 Documentation](https://tapava.github.io/compute-kit)[Live Demo](https://computekit-demo.vercel.app/)[Getting Started](#-getting-started)[Examples](#-examples)[API](#-api)[React Hooks](#-react-hooks)[WASM](#-webassembly-support)[🤖 MCP Server](#-mcp-server)
1819

1920
</div>
2021

@@ -584,7 +585,101 @@ computekit/
584585
585586
---
586587
587-
## 🤝 Contributing
588+
## � MCP Server
589+
590+
This repository has an [MCP (Model Context Protocol)](https://modelcontextprotocol.io/) server that lets AI assistants access the ComputeKit documentation and codebase directly. Use it as context in tools like **VS Code Copilot**, **Cursor**, **Windsurf**, **Claude Desktop**, and others.
591+
592+
**MCP Server URL:**
593+
594+
```
595+
https://gitmcp.io/tapava/compute-kit
596+
```
597+
598+
### VS Code (GitHub Copilot)
599+
600+
Add the following to your `.vscode/mcp.json` (create the file if it doesn't exist):
601+
602+
```json
603+
{
604+
"servers": {
605+
"computekit": {
606+
"type": "sse",
607+
"url": "https://gitmcp.io/tapava/compute-kit"
608+
}
609+
}
610+
}
611+
```
612+
613+
Alternatively, you can add it to your **User Settings** (`settings.json`):
614+
615+
```json
616+
{
617+
"mcp": {
618+
"servers": {
619+
"computekit": {
620+
"type": "sse",
621+
"url": "https://gitmcp.io/tapava/compute-kit"
622+
}
623+
}
624+
}
625+
}
626+
```
627+
628+
### Cursor
629+
630+
Go to **Cursor Settings → MCP** and add a new server:
631+
632+
```json
633+
{
634+
"mcpServers": {
635+
"computekit": {
636+
"url": "https://gitmcp.io/tapava/compute-kit"
637+
}
638+
}
639+
}
640+
```
641+
642+
### Windsurf
643+
644+
Add to your `~/.codeium/windsurf/mcp_config.json`:
645+
646+
```json
647+
{
648+
"mcpServers": {
649+
"computekit": {
650+
"serverUrl": "https://gitmcp.io/tapava/compute-kit"
651+
}
652+
}
653+
}
654+
```
655+
656+
### Claude Desktop
657+
658+
Add to your Claude Desktop config (`claude_desktop_config.json`):
659+
660+
```json
661+
{
662+
"mcpServers": {
663+
"computekit": {
664+
"command": "npx",
665+
"args": [
666+
"-y",
667+
"@anthropic-ai/mcp-proxy@latest",
668+
"https://gitmcp.io/tapava/compute-kit"
669+
]
670+
}
671+
}
672+
}
673+
```
674+
675+
> **Config file location:**
676+
>
677+
> - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
678+
> - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
679+
680+
---
681+
682+
## �🤝 Contributing
588683
589684
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) first.
590685

0 commit comments

Comments
 (0)