Skip to main content
Glama

delete_credential

Remove a specific credential for a consumer in the APISIX-MCP server by providing the username and credential ID to manage access securely.

Instructions

Delete a credential for a consumer

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYescredential id
usernameYesconsumer username

Implementation Reference

  • Inline handler implementation for the 'delete_credential' tool. It makes a DELETE request to the admin API to remove the specified credential for a consumer.
    server.tool("delete_credential", "Delete a credential for a consumer", DeleteCredentialSchema.shape, async (args) => {
      return await makeAdminAPIRequest(`/consumers/${args.username}/credentials/${args.id}`, "DELETE");
    });
  • Zod input schema for the 'delete_credential' tool, requiring 'username' and 'id'.
    export const DeleteCredentialSchema = z.object({
      username: ConsumerSchema.shape.username,
      id: z.string().describe("credential id"),
    });
  • Registration of the 'delete_credential' tool on the MCP server using server.tool().
    server.tool("delete_credential", "Delete a credential for a consumer", DeleteCredentialSchema.shape, async (args) => {
      return await makeAdminAPIRequest(`/consumers/${args.username}/credentials/${args.id}`, "DELETE");
    });
  • Supporting utility function that performs HTTP requests to the APISIX admin API, used by the delete_credential handler.
    export async function makeAdminAPIRequest(
      path: string,
      method: string = "GET",
      data?: object
    ): Promise<CallToolResult> {
      const baseUrl = `${APISIX_SERVER_HOST}:${APISIX_ADMIN_API_PORT}${APISIX_ADMIN_API_PREFIX}`;
      const url = `${baseUrl}${path}`;
    
      try {
        const response = await axios({
          method,
          url,
          data,
          headers: {
            "X-API-KEY": APISIX_ADMIN_KEY,
            "Content-Type": "application/json",
          },
        });
    
        return {
          content: [
            {
              type: "text",
              text: JSON.stringify(response.data, null, 2),
            },
          ],
        };
      } catch (error) {
        if (axios.isAxiosError(error)) {
          console.error(`Request failed: ${method} ${url}`);
          console.error(
            `Status: ${error.response?.status}, Error: ${error.message}`
          );
    
          if (error.response?.data) {
            try {
              const stringifiedData = JSON.stringify(error.response.data);
              console.error(`Response data: ${stringifiedData}`);
            } catch {
              console.error(`Response data: [Cannot parse as JSON]`);
            }
          }
    
          return {
            isError: true,
            content: [
              {
                type: "text",
                text: JSON.stringify(
                  `Status: ${error.response?.status}\nMessage: ${error.message}
    Data:\n${JSON.stringify(error.response?.data || {}, null, 2)}`,
                  null,
                  2
                ),
              },
            ],
          };
        } else {
          return {
            isError: true,
            content: [
              {
                type: "text",
                text: JSON.stringify(error, null, 2),
              },
            ],
          };
        }
      }
    }

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/api7/apisix-mcp'

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