Skip to content

Commit ec21775

Browse files
authored
Merge pull request #19 from tapava/develop
doc: updating docs
2 parents 3fe17aa + 7d9df2d commit ec21775

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

@@ -604,7 +605,101 @@ computekit/
604605
605606
---
606607
607-
## 🤝 Contributing
608+
## � MCP Server
609+
610+
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.
611+
612+
**MCP Server URL:**
613+
614+
```
615+
https://gitmcp.io/tapava/compute-kit
616+
```
617+
618+
### VS Code (GitHub Copilot)
619+
620+
Add the following to your `.vscode/mcp.json` (create the file if it doesn't exist):
621+
622+
```json
623+
{
624+
"servers": {
625+
"computekit": {
626+
"type": "sse",
627+
"url": "https://gitmcp.io/tapava/compute-kit"
628+
}
629+
}
630+
}
631+
```
632+
633+
Alternatively, you can add it to your **User Settings** (`settings.json`):
634+
635+
```json
636+
{
637+
"mcp": {
638+
"servers": {
639+
"computekit": {
640+
"type": "sse",
641+
"url": "https://gitmcp.io/tapava/compute-kit"
642+
}
643+
}
644+
}
645+
}
646+
```
647+
648+
### Cursor
649+
650+
Go to **Cursor Settings → MCP** and add a new server:
651+
652+
```json
653+
{
654+
"mcpServers": {
655+
"computekit": {
656+
"url": "https://gitmcp.io/tapava/compute-kit"
657+
}
658+
}
659+
}
660+
```
661+
662+
### Windsurf
663+
664+
Add to your `~/.codeium/windsurf/mcp_config.json`:
665+
666+
```json
667+
{
668+
"mcpServers": {
669+
"computekit": {
670+
"serverUrl": "https://gitmcp.io/tapava/compute-kit"
671+
}
672+
}
673+
}
674+
```
675+
676+
### Claude Desktop
677+
678+
Add to your Claude Desktop config (`claude_desktop_config.json`):
679+
680+
```json
681+
{
682+
"mcpServers": {
683+
"computekit": {
684+
"command": "npx",
685+
"args": [
686+
"-y",
687+
"@anthropic-ai/mcp-proxy@latest",
688+
"https://gitmcp.io/tapava/compute-kit"
689+
]
690+
}
691+
}
692+
}
693+
```
694+
695+
> **Config file location:**
696+
>
697+
> - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
698+
> - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
699+
700+
---
701+
702+
## �🤝 Contributing
608703
609704
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) first.
610705

0 commit comments

Comments
 (0)