Skip to main content
Glama

vk_put_subscrip_4a35be590f51

Subscribe the current user to a Vikunja entity (project or task) by specifying the entity type and numeric ID. Sends a PUT request to create the subscription for the authenticated user.

Instructions

Subscribes the current user to an entity.. Raw Vikunja REST proxy for PUT /subscriptions/{entity}/{entityID}. Subscribes the current user to an entity. 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.
entityNoThe entity the user subscribes to. Can be either `project` or `task`. Required.
entityIDNoThe numeric id of the entity to subscribe to. Required.
entityIdNoThe numeric id of the entity to subscribe to. Required.
entity_idNoThe numeric id of the entity to subscribe to. Required.
Behavior3/5

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

With no annotations, the description carries the full transparency burden. It discloses the action (subscribes), the authentication requirement, and the parameter style (top-level fields, aliases). However, it does not mention side effects, idempotency, response format, or permissions beyond authentication. The effect is stated, but key behavioral aspects are missing.

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

Conciseness3/5

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

The description is not overly long, but it contains a duplicate sentence ('Subscribes the current user to an entity') and a typo ('entity..'). The key information is front-loaded, but the redundancy and awkward formatting reduce efficiency.

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?

For a mutation tool with no annotations and no output schema, the description is incomplete. It does not explain the response, error conditions, idempotency, or permission requirements beyond authentication. The required parameter ambiguity is unresolved, and the description does not offer enough context for an agent to safely invoke the tool in all scenarios.

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

Parameters3/5

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

The schema already covers all parameters, so the baseline is 3. The description adds the alias conventions (camelCase and snake_case) and clarifies the optional body usage, which goes beyond the schema. However, the schema has an inconsistency: the required array is empty but property descriptions mark entity/entityID as required, and the description does not resolve this. Redundant phrasing about the body adds little.

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 clearly states the tool subscribes the current user to an entity, and provides the underlying REST endpoint (PUT /subscriptions/{entity}/{entityID}). This distinguishes it from the sibling delete-subscription tool in meaning, though it does not explicitly name alternatives. The repetition of the same sentence slightly detracts from clarity.

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 intended use is implied through the verb 'Subscribes' and the REST path. It mentions authentication is required and describes parameter handling, but does not explicitly say when to use this tool versus other subscription-related tools, nor provide exclusions or alternative tool names. The guidance is clear enough but implicit.

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