{"id":36985589,"url":"https://github.com/projanvil/knot","last_synced_at":"2026-03-02T09:10:24.226Z","repository":{"id":329620098,"uuid":"1118130352","full_name":"ProjAnvil/Knot","owner":"ProjAnvil","description":"AI-powered API documentation hub with MCP integration. Built by AI, designed for AI - enabling Claude and other AI assistants to seamlessly discover, understand, and interact with your APIs through the Model Context Protocol.","archived":false,"fork":false,"pushed_at":"2025-12-17T10:09:40.000Z","size":244,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-13T19:45:18.901Z","etag":null,"topics":["api","bun","claude","claude-code","golang","mcp","model-context-protocol","svelte","typescript"],"latest_commit_sha":null,"homepage":"","language":"Svelte","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ProjAnvil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-17T09:58:09.000Z","updated_at":"2025-12-17T10:09:28.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ProjAnvil/Knot","commit_stats":null,"previous_names":["projanvil/knot"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ProjAnvil/Knot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjAnvil%2FKnot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjAnvil%2FKnot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjAnvil%2FKnot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjAnvil%2FKnot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ProjAnvil","download_url":"https://codeload.github.com/ProjAnvil/Knot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProjAnvil%2FKnot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28405148,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-13T21:51:37.118Z","status":"ssl_error","status_checked_at":"2026-01-13T21:45:14.585Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bun","claude","claude-code","golang","mcp","model-context-protocol","svelte","typescript"],"created_at":"2026-01-13T23:02:40.204Z","updated_at":"2026-01-13T23:02:40.663Z","avatar_url":"https://github.com/ProjAnvil.png","language":"Svelte","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Knot\n\n\u003cdiv align=\"center\"\u003e\n\nA modern, lightweight API documentation management system with AI assistant integration.\n\n[Features](#features) • [Quick Start](#quick-start) • [Documentation](#documentation) • [Development](#development) • [Contributing](#contributing)\n\n**[中文文档](./doc/README_zh.md)** | English\n\n\u003c/div\u003e\n\n---\n\n## Overview\n\nKnot is a comprehensive API documentation platform that helps teams organize, document, and share their API specifications. Built with Go and Svelte 5, it offers a fast, intuitive interface with native AI assistant support through Model Context Protocol (MCP).\n\n### Key Features\n\n- 📚 **Organized API Management** - Group and categorize API endpoints with hierarchical structure\n- 🔍 **Fuzzy Search** - Quickly find APIs across all groups with intelligent search\n- 📝 **Rich Documentation** - Document APIs with markdown, request/response schemas, and examples\n- 🎨 **Syntax Highlighting** - Beautiful JSON syntax highlighting with dark mode support\n- 🔄 **Drag \u0026 Drop Interface** - Intuitive API reordering and organization\n- 🌐 **Multilingual** - Built-in support for English and Chinese\n- 🗄️ **Flexible Database** - Choose between SQLite, PostgreSQL, or MySQL\n- 🤖 **AI Integration** - Native MCP server for Claude and other AI assistants\n- ⚡ **High Performance** - Go-powered backend with minimal resource usage\n- 🚀 **Zero Dependencies** - Single binary deployment with embedded frontend\n\n## Quick Start\n\n### Installation\n\nDownload the latest release for your platform:\n\n```bash\n# macOS (Apple Silicon)\ncurl -LO https://github.com/ProjAnvil/knot/releases/latest/download/knot-macos-arm64\nchmod +x knot-macos-arm64\nsudo mv knot-macos-arm64 /usr/local/bin/knot\n\n# macOS (Intel)\ncurl -LO https://github.com/ProjAnvil/knot/releases/latest/download/knot-macos-amd64\nchmod +x knot-macos-amd64\nsudo mv knot-macos-amd64 /usr/local/bin/knot\n\n# Linux (AMD64)\ncurl -LO https://github.com/ProjAnvil/knot/releases/latest/download/knot-linux\nchmod +x knot-linux\nsudo mv knot-linux /usr/local/bin/knot\n\n# Windows (AMD64)\n# Download knot-windows.exe from releases page\n```\n\n### Usage\n\n```bash\n# Initialize configuration\nknot setup\n\n# Start the server (runs in background)\nknot start\n\n# Check server status\nknot status\n\n# Stop the server\nknot stop\n\n# View configuration\nknot config\n\n# Get help\nknot help\n```\n\nThe web interface will be available at [http://localhost:3000](http://localhost:3000)\n\n## Documentation\n\n- [English Documentation](./README.md) (This file)\n- [中文文档](./doc/README_zh.md)\n- [MCP Server Setup](./mcp-server/README.md)\n- [MCP Usage Guide](./doc/MCP_USAGE_GUIDE.md)\n- [Development Guide](./CLAUDE.md)\n\n## Configuration\n\nKnot stores its configuration at:\n- **Linux/macOS**: `~/.knot/config.json`\n- **Windows**: `%LOCALAPPDATA%\\knot\\config.json`\n\nExample configuration:\n\n```json\n{\n  \"databaseType\": \"sqlite\",\n  \"sqlitePath\": \"/Users/username/.knot/knot.db\",\n  \"port\": 3000,\n  \"host\": \"localhost\",\n  \"enableLogging\": false\n}\n```\n\n### Database Options\n\n| Database | Use Case | Configuration |\n|----------|----------|---------------|\n| **SQLite** (default) | Personal use, development | `sqlitePath: \"/path/to/knot.db\"` |\n| **PostgreSQL** | Production, teams | `postgresUrl: \"postgresql://...\"` |\n| **MySQL** | Enterprise | `mysqlUrl: \"user:pass@tcp(...)/\"` |\n\n## Development\n\nKnot consists of three independent components:\n\n### Prerequisites\n\n- **Go** 1.21 or later\n- **Bun** or npm (for frontend)\n- **Make** (optional, for build commands)\n\n### Project Structure\n\n```\nknot/\n├── frontend/          # Svelte 5 web application\n│   ├── src/\n│   │   ├── lib/      # Reusable components\n│   │   └── messages/ # i18n translations\n│   └── package.json\n├── backend/           # Go API server\n│   ├── cmd/          # Entry points (CLI \u0026 server)\n│   ├── internal/     # Core logic\n│   └── Makefile\n├── mcp-server/        # MCP server for AI integration\n│   ├── main.go\n│   └── Makefile\n└── doc/              # Documentation\n```\n\n### Frontend Development\n\n```bash\ncd frontend\n\n# Install dependencies\nbun install\n\n# Start dev server with hot reload (port 5173)\nbun dev\n\n# Build for production\nbun run build\n```\n\nThe frontend runs independently and proxies API requests to the backend during development.\n\n### Backend Development\n\n```bash\ncd backend\n\n# Install Go dependencies\ngo mod download\n\n# Run in development mode\nmake run\n\n# Build CLI binary\nmake build\n\n# Build for all platforms\nmake build-all\n\n# Package with embedded frontend\nmake package\n```\n\nAvailable commands:\n- `make run` - Run server in development mode\n- `make build` - Build CLI binary for current platform\n- `make build-all` - Build for all platforms (Linux, macOS, Windows)\n- `make package` - Build complete package with embedded frontend\n- `make clean` - Clean build artifacts\n\n### MCP Server Development\n\n```bash\ncd mcp-server\n\n# Install dependencies\ngo mod download\n\n# Build MCP server\nmake build\n\n# Build for all platforms\nmake build-all\n```\n\n### Running Tests\n\n```bash\n# Backend tests\ncd backend\ngo test ./...\n\n# Frontend tests (if available)\ncd frontend\nbun test\n```\n\n## MCP Integration\n\nKnot includes a Model Context Protocol server that enables AI assistants like Claude to query your API documentation naturally.\n\n### Features\n\n- List all API groups\n- Search APIs by name or endpoint\n- Get detailed API documentation\n- Generate JSON request/response examples\n- Fuzzy matching on group and API names\n\n### Setup\n\n1. Build the MCP server:\n```bash\ncd mcp-server\nmake build\n```\n\n2. Configure Claude Desktop to use Knot MCP server. See [MCP Usage Guide](./doc/MCP_USAGE_GUIDE.md) for detailed instructions.\n\n3. Start querying your APIs:\n```\n\"Show me all APIs in the user-service group\"\n\"Find APIs related to authentication\"\n\"Generate an example request for the login API\"\n```\n\n## Architecture\n\n### Technology Stack\n\n**Frontend:**\n- Svelte 5 (Latest reactivity model)\n- TypeScript\n- Vite (Build tool)\n- Tailwind CSS\n- shadcn-svelte (UI components)\n- svelte-i18n (Internationalization)\n\n**Backend:**\n- Go 1.21+\n- Chi (HTTP router)\n- GORM (ORM with multi-database support)\n- Cobra (CLI framework)\n- Viper (Configuration management)\n\n**MCP Server:**\n- Go with MCP SDK\n- Stdio transport\n- RESTful API integration\n\n### Database Schema\n\n```\ngroups\n  ├── id (primary key)\n  ├── name\n  └── apis (has many)\n\napis\n  ├── id (primary key)\n  ├── group_id (foreign key)\n  ├── name\n  ├── endpoint\n  ├── method (GET/POST/etc)\n  ├── type (HTTP/RPC)\n  ├── note (markdown)\n  └── parameters (has many)\n\nparameters\n  ├── id (primary key)\n  ├── api_id (foreign key)\n  ├── parent_id (self-referencing for nested)\n  ├── name\n  ├── type (string/number/boolean/array/object)\n  ├── param_type (request/response)\n  ├── required\n  └── description\n```\n\n## Building from Source\n\n### Build Complete Package\n\n```bash\n# Clone the repository\ngit clone https://github.com/ProjAnvil/knot.git\ncd knot\n\n# Build frontend\ncd frontend\nbun install\nbun run build\ncd ..\n\n# Build backend with embedded frontend\ncd backend\nmake package\n\n# Build MCP server\ncd ../mcp-server\nmake build\n```\n\nBinaries will be in:\n- Backend CLI: `backend/bin/knot`\n- Backend server: `backend/bin/knot-server`\n- MCP server: `mcp-server/bin/knot-mcp`\n\n### Cross-Platform Builds\n\n```bash\n# Build for all platforms\ncd backend\nmake package-all\n\ncd ../mcp-server\nmake build-all\n```\n\nThis creates binaries for:\n- Linux (AMD64)\n- macOS (AMD64 and ARM64)\n- Windows (AMD64)\n\n## Contributing\n\nWe welcome contributions! Here's how you can help:\n\n### Reporting Issues\n\n- Use the [issue tracker](https://github.com/ProjAnvil/knot/issues)\n- Include detailed steps to reproduce\n- Provide system information (OS, Go version, etc.)\n\n### Pull Requests\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Make your changes\n4. Run tests and ensure code quality\n5. Commit your changes (`git commit -m 'Add amazing feature'`)\n6. Push to your fork (`git push origin feature/amazing-feature`)\n7. Open a Pull Request\n\n### Development Guidelines\n\n- Follow Go best practices and conventions\n- Write tests for new features\n- Update documentation for user-facing changes\n- Keep commits atomic and well-described\n- Ensure all tests pass before submitting PR\n\n## Roadmap\n\n- [ ] OpenAPI/Swagger import/export\n- [ ] API versioning support\n- [ ] Team collaboration features\n- [ ] API testing interface\n- [ ] GraphQL support\n- [ ] Docker deployment\n- [ ] Cloud hosting option\n- [ ] Plugin system\n\n## License\n\nMIT License - see [LICENSE](./LICENSE) for details.\n\n## Author\n\n**Howe Chen**\n- Email: yuhao.howe.chen@gmail.com\n- GitHub: [@ProjAnvil](https://github.com/ProjAnvil)\n\n## Links\n\n- **Repository**: https://github.com/ProjAnvil/knot\n- **Issues**: https://github.com/ProjAnvil/knot/issues\n- **Releases**: https://github.com/ProjAnvil/knot/releases\n- **NPM Package**: https://www.npmjs.com/package/@ProjAnvil/knot\n\n## Acknowledgments\n\n- [Model Context Protocol](https://modelcontextprotocol.io) for AI integration standard\n- [Svelte](https://svelte.dev/) for the amazing frontend framework\n- [GORM](https://gorm.io/) for the powerful ORM\n- [shadcn-svelte](https://www.shadcn-svelte.com/) for beautiful UI components\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\nMade with ❤️ by the Knot team\n\n**[⬆ Back to Top](#knot)**\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojanvil%2Fknot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprojanvil%2Fknot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojanvil%2Fknot/lists"}