@cyborg-sdk/mcp
v0.0.10
Published
MCP server for Cyborg platform - documentation generation and more
Maintainers
Readme
@cyborg-sdk/mcp
MCP server for the Cyborg platform - documentation generation and sync.
Overview
This MCP server enables AI tool users to generate, upload, and sync documentation with the Cyborg backend. The AI writes readable markdown docs, users can review/edit, and the backend handles chunking and vectorization.
Installation
Claude Code
Add to your ~/.claude/mcp.json:
{
"mcpServers": {
"cyborg": {
"command": "npx",
"args": ["@cyborg-sdk/mcp"],
"env": {
"CYBORG_API_KEY": "sk-xxx",
"CYBORG_API_URL": "https://api.cyborg.dev"
}
}
}
}Note:
CYBORG_API_URLis optional - defaults tohttps://api.cyborg.dev
Cursor
Add to your Cursor MCP settings:
{
"mcpServers": {
"cyborg": {
"command": "npx",
"args": ["@cyborg-sdk/mcp"],
"env": {
"CYBORG_API_KEY": "sk-xxx",
"CYBORG_API_URL": "https://api.cyborg.dev"
}
}
}
}Note:
CYBORG_API_URLis optional - defaults tohttps://api.cyborg.dev
Configuration
Environment Variables
| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| CYBORG_API_KEY | Yes* | - | Cyborg API key for authentication |
| CYBORG_API_URL | No | https://api.cyborg.dev | Backend API URL |
*API key can also be passed as a tool parameter instead of environment variable.
API Key Resolution
API key is resolved in this order:
- Tool parameter - Pass
apiKeydirectly to any tool - Environment variable - Set
CYBORG_API_KEYin MCP config
Tools
upload_docs
Initial upload of documentation files to the Cyborg backend.
Parameters:
apiKey(optional) - Cyborg API keydocsDir(default:./cyborg-docs) - Documentation directorydocumentType(default:markdown) - Document type (markdownortext)metadata(optional) - Project metadata (name,version)
Example:
Upload my docs from ./cyborg-docssync_docs
Detect changes and sync with the backend.
Parameters:
apiKey(optional) - Cyborg API keydocsDir(default:./cyborg-docs) - Documentation directorydryRun(default:false) - Preview changes without uploading
Example:
Sync my documentation changesupdate_doc
Update a single document in the backend.
Parameters:
apiKey(optional) - Cyborg API keypath- Relative file path (e.g.,api/useChat.md)docsDir(default:./cyborg-docs) - Documentation directory
Example:
Update the api/useChat.md file in the backenddelete_doc
Delete a document from the backend.
Parameters:
apiKey(optional) - Cyborg API keypath- Relative file path to deletedocsDir(default:./cyborg-docs) - Documentation directorydeleteLocalFile(default:false) - Also delete the local file
Example:
Delete api/deprecated.md from the backendResources
docs://files
List all documentation files in the output directory.
docs://files/{path}
Read a specific documentation file.
docs://status
Show sync status of documentation files:
synced- Files up to date with backendmodified- Files changed locallyuntracked- New files not uploadeddeleted- Files deleted locally but still in backend
Prompts
generate_documentation
Interactive prompt that guides you through generating documentation tailored to your audience. It will ask about:
- Product description
- Target audience
- Technical level
- Main features
- Common tasks
- Documentation style
- Existing docs
Then analyze your codebase and generate appropriate documentation.
Output Structure
Generated documentation follows this structure:
cyborg-docs/
├── getting-started.md
├── api/
│ ├── useChat.md
│ └── sendMessage.md
├── components/
│ └── ChatProvider.md
├── types/
│ └── Message.md
└── guides/
└── customization.mdState Tracking
After upload, state is saved to .cyborg-docs/.cyborg-state.json:
{
"apiUrl": "https://api.cyborg.dev",
"projectId": "proj_abc123",
"lastSyncedAt": "2025-11-30T12:00:00Z",
"files": {
"getting-started.md": {
"documentId": "doc_xyz789",
"contentHash": "sha256:abc123...",
"syncedAt": "2025-11-30T12:00:00Z"
}
}
}Workflow
First Time Setup
Generate documentation:
Generate documentation for this projectReview and edit the generated files in
./cyborg-docs/Upload to Cyborg:
Upload my docs with API key sk-xxx
Updating Documentation
Make changes to your code
Regenerate affected docs:
Update the useChat hook documentationSync changes:
Sync my documentation
Checking Status
What's the status of my docs?Development
# Install dependencies
npm install
# Build
npm run build
# Watch mode
npm run dev
# Type check
npm run type-checkLicense
MIT
