Skip to main content
Glama

delete_okr_progress_record

Delete an OKR progress record by providing its progress ID, enabling removal of outdated or incorrect progress entries from OKR tracking.

Instructions

[Official API + UAT, v1.3.7] Delete an OKR progress record by its progress_id (from list_okr_progress_records).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
progress_idYesProgress record ID

Implementation Reference

  • Handler function for delete_okr_progress_record. Calls the official client's deleteOkrProgressRecord with the progress_id from args, then returns a text response indicating success (and whether it was done as user or app).
    async delete_okr_progress_record(args, ctx) {
      const r = await ctx.getOfficialClient().deleteOkrProgressRecord(args.progress_id);
      return text(`Progress record ${args.progress_id} deleted${r.viaUser ? '' : ' (as app)'}`);
    },
  • Input schema definition for delete_okr_progress_record tool. Declares a single required 'progress_id' (string) parameter and provides the tool description.
    {
      name: 'delete_okr_progress_record',
      description: '[Official API + UAT, v1.3.7] Delete an OKR progress record by its progress_id (from list_okr_progress_records).',
      inputSchema: {
        type: 'object',
        properties: {
          progress_id: { type: 'string', description: 'Progress record ID' },
        },
        required: ['progress_id'],
      },
    },
  • src/server.js:49-57 (registration)
    Registration of the okr tool module (src/tools/okr.js) in the server, which exports schemas and handlers merged into the MCP tool list.
      require('./tools/okr'),
      require('./tools/profile'),
      require('./tools/tasks'),
      require('./tools/uploads'),
      require('./tools/wiki'),
    ];
    
    const TOOLS = TOOL_MODULES.flatMap((m) => m.schemas);
    const HANDLERS = Object.fromEntries(TOOL_MODULES.flatMap((m) => Object.entries(m.handlers)));
  • Official API client method deleteOkrProgressRecord. Sends a DELETE request to /open-apis/okr/v1/progress_records/{progressId} via the UAT-first path or SDK fallback, returning { deleted: true, viaUser }.
    async deleteOkrProgressRecord(progressId) {
      if (!progressId) throw new Error('deleteOkrProgressRecord: progress_id is required');
      const res = await this._asUserOrApp({
        uatPath: `/open-apis/okr/v1/progress_records/${encodeURIComponent(progressId)}`,
        method: 'DELETE',
        sdkFn: () => this.client.okr.progressRecord.delete({ path: { progress_id: progressId } }),
        label: 'deleteOkrProgressRecord',
      });
      return { deleted: true, viaUser: !!res._viaUser };
    },
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It only states 'Delete' without elaborating on whether the deletion is permanent, any authorization requirements, or effects on related data. For a mutation tool, this is insufficient.

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 a single sentence that conveys the core purpose. The inclusion of '[Official API + UAT, v1.3.7]' is slightly extraneous but does not detract significantly from conciseness.

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

Completeness3/5

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

Given the lack of an output schema, the description does not mention the return value or confirm success/failure. However, for a simple delete operation, the action is clear, but additional details about outcome would improve completeness.

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?

Schema coverage is 100%; the description adds practical guidance ('from list_okr_progress_records') but does not significantly enhance understanding beyond the schema's parameter description.

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 specifies the action (delete), the resource (OKR progress record), and the method (by progress_id), explicitly referencing the source of the ID from list_okr_progress_records. This distinguishes it from sibling tools like create_okr_progress_record and list_okr_progress_records.

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 implies that the tool should be used after retrieving a progress_id from list_okr_progress_records, providing clear context. However, it does not explicitly state when not to use it or mention alternatives.

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/EthanQC/feishu-user-plugin'

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