Skip to main content
Glama
umzcio
by umzcio

tdx-kb-get

Retrieve knowledge base articles from TeamDynamix using article IDs to access IT service management documentation and solutions.

Instructions

Get a TDX knowledge base article by ID

Input Schema

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

Implementation Reference

  • The tdx-kb-get tool implementation handler and registration in src/tools/kb.ts. It takes an optional appId and a required id, then calls the client's get method.
    server.tool(
      "tdx-kb-get",
      "Get a TDX knowledge base article by ID",
      {
        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 {
          const result = await client.get(`/${app}/knowledgebase/${params.id}`);
          return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
        } 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?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states this is a 'Get' operation, implying it's likely read-only, but doesn't confirm if it's safe, requires authentication, has rate limits, or what happens on errors (e.g., if the ID doesn't exist). For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior.

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, efficient sentence that directly states the tool's purpose without unnecessary words. It's front-loaded with the core action and resource, making it easy to parse quickly. Every word earns its place, and there's no redundancy or fluff.

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 tool's low complexity (simple retrieval by ID), 100% schema coverage, and no output schema, the description is minimally adequate. However, without annotations or output details, it lacks context on authentication needs, error handling, or return format. For a basic read operation, it's passable but could be more informative to fully guide an agent.

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 description mentions 'by ID', which aligns with the 'id' parameter in the schema, but doesn't add meaning beyond what the schema already provides (100% coverage with clear descriptions for both 'appId' and 'id'). It doesn't explain the relationship between parameters or provide usage examples. With high schema coverage, the baseline is 3, and the description doesn't significantly enhance parameter understanding.

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 ('Get') and resource ('TDX knowledge base article by ID'), making the purpose immediately understandable. It distinguishes itself from sibling tools like 'tdx-kb-search' by focusing on retrieval by specific ID rather than searching. However, it doesn't explicitly contrast with 'tdx-kb-create/delete/update' for full sibling differentiation.

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. It doesn't mention when to choose 'tdx-kb-get' over 'tdx-kb-search' (e.g., when you have a specific article ID vs. need to find articles by criteria) or other sibling tools like 'tdx-kb-create' for different operations. Usage is implied but not explicitly stated.

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