Skip to content

MCP Resources Reference

The Cyborg MCP server exposes resources that allow AI assistants to read documentation files and check sync status.

Available Resources

Resource URIDescription
docs://filesList all documentation files
docs://files/{path}Read content of a specific file
docs://statusGet 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 files

Response

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

PropertyTypeDescription
filesarrayArray of file objects
files[].pathstringRelative path to the file
files[].sizenumberFile size in bytes
files[].modifiedAtstringISO 8601 timestamp of last modification
totalFilesnumberTotal number of files
totalSizenumberTotal size of all files in bytes

docs://files/

Reads the content of a specific documentation file.

Usage

Read the docs://files/getting-started.md resource

Or for nested paths:

Read the docs://files/api/useChat.md resource

Response

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

PropertyTypeDescription
pathstringRelative path to the file
contentstringFull content of the file
sizenumberFile size in bytes
modifiedAtstringISO 8601 timestamp of last modification
documentIdstring | nullBackend document ID (null if not uploaded)
syncStatusstringOne of: synced, modified, new, deleted

Sync Status Values

StatusDescription
syncedFile content matches backend
modifiedLocal file has changes not yet uploaded
newFile exists locally but not on backend
deletedFile in state but missing locally

docs://status

Returns the sync status of all documentation files.

Usage

Read the docs://status resource to check sync status

Response

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

PropertyTypeDescription
lastSyncedAtstring | nullISO 8601 timestamp of last sync operation
summaryobjectCount of files by status
summary.syncednumberFiles in sync with backend
summary.modifiednumberFiles with local changes
summary.newnumberNew files not yet uploaded
summary.deletednumberFiles missing locally but in state
filesobjectStatus details keyed by file path

File Status Object

PropertyTypeDescription
statusstringSync status (synced, modified, new, deleted)
documentIdstring | nullBackend document ID
localHashstring | nullSHA-256 hash of local content
backendHashstring | nullSHA-256 hash of backend content
syncedAtstring | nullISO 8601 timestamp of last sync

Using Resources in Claude Code

In Claude Code, you can access these resources naturally:

Show me all my documentation files
What's the content of the getting-started guide?
Check which files need to be synced

The AI will automatically use the appropriate resource to answer your question.

Using Resources in Cursor

In Cursor, resources are available through the MCP integration:

  1. Use @cyborg to invoke the MCP server
  2. Ask about documentation files or status
  3. The AI will read the appropriate resource

Next Steps

Built with VitePress