weavetab.json

{
  "$schema": "https://weavetab.dev/schema/plugin.json",
  "name": "@weavetab/plugin-github",
  "version": "1.0.0",
  "description": "Official Weavetab GitHub plugin. Analyze repository structure, read raw source files, search and inspect issues, and examine pull requests over the public GitHub REST API — fetched directly over HTTP, so no browser turns are consumed.",
  "entry": "dist/index.js",
  "engines": {
    "weavetab": "^2.5.1",
    "node": ">=18.0.0"
  },
  "environments": [
    "mcp"
  ],
  "authors": [
    {
      "name": "fy2ne",
      "role": "Author & Maintainer",
      "url": "https://github.com/fy2ne"
    }
  ],
  "license": "MIT",
  "tags": [
    "GitHub",
    "Developer Tools",
    "Repositories",
    "Issues",
    "Pull Requests"
  ],
  "links": {
    "github": "https://github.com/weavetab/plugin-github",
    "npm": "https://www.npmjs.com/package/@weavetab/plugin-github"
  },
  "defaultConfig": {
    "cacheTtlMs": 1800000,
    "maxReadLines": 200,
    "defaultIssueLimit": 5
  },
  "permissions": {
    "config": {
      "read": true,
      "write": true,
      "reason": "Reads and persists the isolated plugin configuration (cache TTL, read limits, default issue limit) at ~/.weavetab/plugins/@weavetab_plugin-github/config.json."
    },
    "cdp": {
      "evaluate": true,
      "reason": "Reads the active tab URL only, to infer the target repository when the optional 'repo' argument is omitted. Never navigates or mutates the page."
    },
    "network": {
      "domains": [
        "api.github.com",
        "raw.githubusercontent.com",
        "github.com"
      ],
      "reason": "Fetches repository metadata, file trees, raw source files, issues and pull requests from the public GitHub REST API and raw content CDN."
    },
    "tools": {
      "add": true,
      "reason": "Registers the single 'github' MCP tool."
    }
  },
  "tools": [
    {
      "name": "github",
      "description": "Interact with GitHub repositories without burning browser turns. Analyze a repo's file tree and README, read raw source files, list/search/inspect issues, and examine pull request details, changed files and comments — all fetched over the GitHub REST API.",
      "inputSchema": {
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "enum": ["analyze", "read", "issues", "pr"],
            "description": "The GitHub operation to perform. 'analyze' = repository metadata, recursive file tree and README snippet. 'read' = raw file contents (requires 'paths'). 'issues' = list, search or inspect issues. 'pr' = list or inspect pull requests."
          },
          "repo": {
            "type": "string",
            "description": "Target repository as an 'owner/repo' slug or a full https://github.com/owner/repo URL. Optional — when omitted, the repository is inferred from the active browser tab (which must be on a github.com repo page)."
          },
          "paths": {
            "type": "array",
            "items": { "type": "string" },
            "description": "READ ONLY. File paths relative to the repository root to fetch (e.g. ['src/index.ts', 'README.md'])."
          },
          "line_range": {
            "type": "array",
            "items": { "type": "number" },
            "description": "READ ONLY. Optional [start, end] 1-indexed line range to return from each file. When omitted, files longer than 'maxReadLines' are truncated from the top."
          },
          "number": {
            "type": "number",
            "description": "ISSUES / PR ONLY. Issue or pull request number to fetch the full detail and comments for. When omitted, a recent list is returned instead."
          },
          "search": {
            "type": "string",
            "description": "ISSUES ONLY. Free-text search query to find issues (uses the GitHub Search API, scoped to the target repo)."
          },
          "labels": {
            "type": "array",
            "items": { "type": "string" },
            "description": "ISSUES ONLY. Restrict results to issues carrying all of the given labels."
          },
          "state": {
            "type": "string",
            "enum": ["open", "closed", "all"],
            "description": "ISSUES ONLY. Filter by issue state."
          },
          "limit": {
            "type": "number",
            "description": "ISSUES ONLY. Maximum number of issues to return when listing or searching (default 5)."
          }
        },
        "required": ["action"]
      }
    }
  ]
}