MCP Resources Reference
The Cyborg MCP server exposes resources that allow AI assistants to read documentation files and check sync status.
Available Resources
| Resource URI | Description |
|---|---|
docs://files | List all documentation files |
docs://files/{path} | Read content of a specific file |
docs://status | Get sync status of all files |
docs://files
Lists all documentation files in the configured directory.
Usage
Read the docs://files resource to see all documentation filesResponse
json
{
"files": [
{
"path": "getting-started.md",
"size": 2048,
"modifiedAt": "2025-01-15T10:30:00Z"
},
{
"path": "api/useChat.md",
"size": 4096,
"modifiedAt": "2025-01-14T15:20:00Z"
},
{
"path": "api/useCyborg.md",
"size": 3584,
"modifiedAt": "2025-01-14T15:20:00Z"
}
],
"totalFiles": 3,
"totalSize": 9728
}Properties
| Property | Type | Description |
|---|---|---|
files | array | Array of file objects |
files[].path | string | Relative path to the file |
files[].size | number | File size in bytes |
files[].modifiedAt | string | ISO 8601 timestamp of last modification |
totalFiles | number | Total number of files |
totalSize | number | Total size of all files in bytes |
docs://files/
Reads the content of a specific documentation file.
Usage
Read the docs://files/getting-started.md resourceOr for nested paths:
Read the docs://files/api/useChat.md resourceResponse
json
{
"path": "getting-started.md",
"content": "# Getting Started\n\nWelcome to Cyborg SDK...",
"size": 2048,
"modifiedAt": "2025-01-15T10:30:00Z",
"documentId": "doc_abc123",
"syncStatus": "synced"
}Properties
| Property | Type | Description |
|---|---|---|
path | string | Relative path to the file |
content | string | Full content of the file |
size | number | File size in bytes |
modifiedAt | string | ISO 8601 timestamp of last modification |
documentId | string | null | Backend document ID (null if not uploaded) |
syncStatus | string | One of: synced, modified, new, deleted |
Sync Status Values
| Status | Description |
|---|---|
synced | File content matches backend |
modified | Local file has changes not yet uploaded |
new | File exists locally but not on backend |
deleted | File in state but missing locally |
docs://status
Returns the sync status of all documentation files.
Usage
Read the docs://status resource to check sync statusResponse
json
{
"lastSyncedAt": "2025-01-15T10:30:00Z",
"summary": {
"synced": 5,
"modified": 2,
"new": 1,
"deleted": 0
},
"files": {
"getting-started.md": {
"status": "synced",
"documentId": "doc_abc123",
"localHash": "sha256:e3b0c44...",
"backendHash": "sha256:e3b0c44...",
"syncedAt": "2025-01-15T10:30:00Z"
},
"api/useChat.md": {
"status": "modified",
"documentId": "doc_def456",
"localHash": "sha256:7f83b16...",
"backendHash": "sha256:a1b2c3d...",
"syncedAt": "2025-01-14T15:20:00Z"
},
"new-guide.md": {
"status": "new",
"documentId": null,
"localHash": "sha256:9e107d9...",
"backendHash": null,
"syncedAt": null
}
}
}Properties
| Property | Type | Description |
|---|---|---|
lastSyncedAt | string | null | ISO 8601 timestamp of last sync operation |
summary | object | Count of files by status |
summary.synced | number | Files in sync with backend |
summary.modified | number | Files with local changes |
summary.new | number | New files not yet uploaded |
summary.deleted | number | Files missing locally but in state |
files | object | Status details keyed by file path |
File Status Object
| Property | Type | Description |
|---|---|---|
status | string | Sync status (synced, modified, new, deleted) |
documentId | string | null | Backend document ID |
localHash | string | null | SHA-256 hash of local content |
backendHash | string | null | SHA-256 hash of backend content |
syncedAt | string | null | ISO 8601 timestamp of last sync |
Using Resources in Claude Code
In Claude Code, you can access these resources naturally:
Show me all my documentation filesWhat's the content of the getting-started guide?Check which files need to be syncedThe AI will automatically use the appropriate resource to answer your question.
Using Resources in Cursor
In Cursor, resources are available through the MCP integration:
- Use
@cyborgto invoke the MCP server - Ask about documentation files or status
- The AI will read the appropriate resource
Next Steps
- Tools Reference - Available MCP tools
- Sync Docs - Keeping docs in sync
- Overview - MCP server overview