Skip to main content
Glama

vwork_api

Call allowlisted VWork platform APIs with existing authentication to read project, task, ticket, and notification data; write methods require opt-in for safe API groups.

Instructions

Gọi API VWork tuỳ ý (đã có sẵn auth). GET luôn được phép trong danh sách nhóm API; PATCH/POST/PUT/DELETE chỉ khi VWORK_ALLOW_WRITE=true và thuộc nhóm an toàn.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "vwork_api"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyNo
pathYesvd /tickets, /notification, /project-tracker/eoffice/docs
queryNo
methodNoGET

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations supplied, the description must carry the behavioral load, and it does disclose two useful traits: authentication is pre-configured and write methods are gated behind an environment flag plus a 'safe group' allowlist. However, 'safe group' is never defined, and nothing is said about failure modes, response format, or what happens when a write is rejected.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Roughly two compact clauses with no filler, and the most consequential constraint (write gating) is placed in the second position where it is easy to catch. Slightly dense for non-Vietnamese readers, but no sentence is redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a high-complexity generic passthrough with a free-form body, nested query object, and no output schema, so the description should explain response shape and error behavior. It covers methods and auth only, leaving an agent unable to predict what a call returns or how a blocked write manifests.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 25%, so the description needs to compensate, and it largely does not. It adds meaning about method semantics (which methods are permitted and under what condition), but the 'body' parameter is untyped and unexplained, and the 'query' object's accepted keys and value handling are never described.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: call an arbitrary VWork API endpoint, with auth already handled. It implicitly distinguishes itself from the specialized siblings (vwork_tickets, vwork_me, etc.) as the generic escape hatch, though it never says so explicitly. An agent can tell what it does, but the boundary with the dedicated tools must be inferred.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives a concrete usage rule for method selection: GET is always permitted, while PATCH/POST/PUT/DELETE require VWORK_ALLOW_WRITE=true and membership in the 'safe group'. It offers no guidance on when to reach for this generic caller instead of the many dedicated sibling tools such as vwork_tickets or vwork_update_task.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.