Skip to main content
Glama
Sign In

Onplana

by io.github.Onplana
OverviewDiscussionsAdmin

list_custom_field_defs

Read-onlyIdempotent

List custom-field definitions for an entity type (TASK / PROJECT / PROPOSAL). When projectId is set the return is the union of org-wide definitions and the project's own scoped fields, unless scope='project-only' which trims to just the project-scoped subset. Requires the PRO+ customFields plan feature.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_custom_field_defs"
  }
}

Input Schema

NameRequiredDescriptionDefault
scopeNoWhen projectId is set: project-only for just this project, union (default) for both
projectIdNoWhen set, also include this project's scoped fields
entityTypeNoEntity type to filter to. Omit for every type.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds real context beyond that: the union-of-org-and-project return semantics when projectId is set, the trimming effect of scope='project-only', and the plan-feature prerequisite.

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

Conciseness5/5

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

Three dense sentences with the core purpose front-loaded and no filler. Every clause (entity-type scoping, union/scope behavior, plan requirement) contributes actionable information.

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 zero-required, read-only list tool whose annotations carry the safety profile and with no output schema to explain, the description covers purpose, parameter interaction, and the gating plan feature. Missing only an explicit pointer to sibling tools for the neighboring definition/value operations.

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 description coverage is 100%, so the baseline is 3, but the description adds value by explaining how projectId and scope interact (union of org-wide and project-scoped fields unless scope='project-only'), which the schema only conveys per-parameter in isolation.

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 ('List custom-field definitions') and scopes it by entity type (TASK/PROJECT/PROPOSAL), so an agent knows exactly what is returned. It does not explicitly distinguish itself from the sibling set (create_custom_field_def, update_custom_field_def, get_custom_field_values), though the 'definitions' vs 'values' contrast is implied by the name.

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?

It explains the conditional behavior when projectId is set and notes the PRO+ customFields plan requirement, which is useful precondition context. However, it never states when to reach for this tool versus alternatives like get_custom_field_values or the create/update definition siblings, leaving routing to inference.

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

All Onplana toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources