Skip to main content
Glama

vk_patch_test_48973863d43c

Reset a database table to a defined state by sending test content via PATCH to the /test endpoint.

Instructions

Reset the db to a defined state. Raw Vikunja REST proxy for PATCH /test/{table}. Fills the specified table with the content provided in the payload. You need to enable the testing endpoint before doing this and provide the Authorization: <token> secret when making requests to this endpoint. See docs for more details. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoOptional JSON request body. Some Vikunja endpoints accept payloads even when the Swagger snapshot omits the schema.
tableNoThe table to reset Required.
Behavior3/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It mentions prerequisites, authentication, and parameter aliases, which is useful. However, it does not explicitly state that existing data in the table will be overwritten or destroyed, and it omits details about error behavior or response format. The phrase 'Reset the db' implies destructiveness but stays vague.

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?

The description is moderately sized but every sentence contributes: purpose, endpoint mapping, prerequisites, auth, payload instructions, and aliases. It is front-loaded with the core action and ends with 'Authentication is required,' which is slightly redundant but not wasteful. No fluff or filler beyond the 'See docs' note.

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

Completeness4/5

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

For a proxy tool with 2 parameters and no output schema, the description covers the essential behavioral aspects: what it does, prerequisites, auth, and parameter passing. It doesn't explain return values (no output schema) or what happens to existing data, but 'Reset the db' partially covers that. Given the low complexity and sibling context, it is sufficiently complete.

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

Parameters4/5

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

Schema coverage is 100%, and the schema already describes both parameters. The description adds practical meaning by explaining how to pass the body (optional JSON payload), that path/query parameters are top-level fields, and that camelCase/snake_case aliases are accepted. This aids correct invocation beyond the schema.

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

Purpose5/5

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

The description clearly states the tool's purpose: 'Reset the db to a defined state. Fills the specified table with the content provided in the payload.' It also identifies the exact endpoint (PATCH /test/{table}) and differentiates it from sibling tools like vk_delete_test_bfe51f44bd2a (which likely performs DELETE). The verb+resource+scope is specific and unambiguous.

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

Usage Guidelines4/5

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

The description provides clear context for use: it explains the prerequisite of enabling the testing endpoint, the need for an Authorization token, and how to pass the payload. It does not explicitly contrast with alternatives, but the endpoint identification and the unique 'PATCH /test' target make the usage scenario clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/shichao402/vikunja-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server