Skip to main content
Glama
umzcio
by umzcio

tdx-kb-delete

Remove a knowledge base article from TeamDynamix by specifying its ID to delete outdated or incorrect documentation.

Instructions

Delete a TDX knowledge base article

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appIdNoTDX app ID (defaults to env TDX_APP_ID)
idYesKB article ID

Implementation Reference

  • src/tools/kb.ts:91-107 (registration)
    The 'tdx-kb-delete' tool registration and handler implementation.
    server.tool(
      "tdx-kb-delete",
      "Delete a TDX knowledge base article",
      {
        appId: z.number().optional().describe("TDX app ID (defaults to env TDX_APP_ID)"),
        id: z.number().describe("KB article ID"),
      },
      async (params) => {
        const app = params.appId ?? defaultAppId;
        try {
          await client.delete(`/${app}/knowledgebase/${params.id}`);
          return { content: [{ type: "text", text: "KB article deleted successfully" }] };
        } catch (e: unknown) {
          return { content: [{ type: "text", text: String(e) }], isError: true };
        }
      }
    );
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool deletes an article, implying a destructive mutation, but fails to mention critical details like whether deletion is permanent, requires specific permissions, or has side effects. This is inadequate for a mutation tool with zero annotation coverage.

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?

The description is a single, direct sentence with zero wasted words, making it highly efficient and front-loaded. It immediately conveys the core action without unnecessary elaboration.

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 destructive mutation tool with no annotations and no output schema, the description is incomplete. It lacks essential context like behavioral traits (e.g., permanence, permissions), usage guidelines, and output expectations, leaving significant gaps for an AI agent to operate safely.

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 input schema has 100% description coverage, fully documenting both parameters (appId and id). The description adds no additional meaning beyond the schema, such as explaining the relationship between appId and id or providing examples. Baseline 3 is appropriate when the schema does the heavy lifting.

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 action ('Delete') and the resource ('a TDX knowledge base article'), making the purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'tdx-cmdb-delete' or 'tdx-asset-delete' by specifying what type of entity is being deleted, though 'kb' in the name helps.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'tdx-kb-update' or other deletion tools. It lacks context about prerequisites, such as needing the article ID, or warnings about irreversible deletion, which are critical for a destructive operation.

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/umzcio/TeamDynamix-MCP-Connector'

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