HelpAddToClient
Integrate Astra DB client into your MCP client to enable database interactions through natural language commands, streamlining collection and record management.
Instructions
Help the user add the Astra DB client to their MCP client
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- tools/HelpAddToClient.ts:1-10 (handler)The main handler function for the HelpAddToClient tool. It fetches the contents of the project's README.md from GitHub and returns it wrapped in a success object with an 'instructions' field.
export async function HelpAddToClient() { const instructions = await fetch( "https://raw.githubusercontent.com/datastax/astra-db-mcp/refs/heads/main/README.md" ).then((res) => res.text()); return { success: true, instructions, }; } - tools.ts:453-461 (registration)The registration of the HelpAddToClient tool in the exported 'tools' array, including its name, description, and empty input schema (no parameters required).
{ name: "HelpAddToClient", description: "Help the user add the Astra DB client to their MCP client", inputSchema: { type: "object", properties: {}, required: [], }, }, - tools.ts:17-36 (schema)TypeScript type definition for ToolName union that includes "HelpAddToClient" among other tool names, used for type safety in tool handling.
export type ToolName = | "GetCollections" | "CreateCollection" | "UpdateCollection" | "DeleteCollection" | "ListRecords" | "GetRecord" | "CreateRecord" | "UpdateRecord" | "DeleteRecord" | "FindRecord" | "FindDistinctValues" | "BulkCreateRecords" | "BulkUpdateRecords" | "BulkDeleteRecords" | "OpenBrowser" | "HelpAddToClient" | "EstimateDocumentCount" | "VectorSearch" | "HybridSearch";