@mondaydotcomorg/agent-toolkit 0.1.1 → 0.1.4

package/README.md

@@ -8,14 +8,6 @@ A powerful toolkit for building AI agents that interact with the Monday.com API.
 npm install @mondaydotcomorg/agent-toolkit
 ```
 
-## Features
-
-- OpenAI integration support
-- Model Context Protocol (MCP) support
-- Pre-built Monday.com API tools
-- TypeScript support with full type definitions
-- Modular architecture with subpath exports
-
 ## Subpath Exports
 
 The package provides several modular components that can be imported separately:
@@ -27,144 +19,28 @@ The package provides several modular components that can be imported separately:
 
 ## Available Tools
 
-The toolkit includes several pre-built tools for common Monday.com operations:
-
-- Delete Item Tool
-- Get Board Items Tool
-- Create Item Tool
-- Create Update Tool
-- Get Board Schema Tool
-
-## Usage
-
-### OpenAI Integration
-
-```typescript
-import { MondayAgentToolkit } from '@mondaydotcomorg/agent-toolkit/openai';
-import OpenAI from 'openai';
-
-// Initialize the Monday.com Agent Toolkit
-const mondayToolkit = new MondayAgentToolkit({
-  mondayApiToken: 'your-monday-api-token',
-  mondayApiVersion: '2025-01',
-  mondayApiRequestConfig: {},
-  toolsConfiguration: {
-    // Optional: Configure available tools
-    include: ['deleteItem', 'getBoardItems'],
-    // OR exclude specific tools
-    // exclude: ['createItem'],
-    // Disable all mutation operations
-    // disableMutations: true,
-  }
-});
-
-
-### MCP Integration
-
-```typescript
-import { MondayAgentToolkit } from '@mondaydotcomorg/agent-toolkit/mcp';
-
-// Initialize with all tools
-const toolkit = new MondayAgentToolkit({
-  mondayApiToken: 'your-monday-api-token',
-  mondayApiVersion: 'your-api-version',
-  mondayApiRequestConfig: {} // Optional request config
-});
-
-// Or initialize with specific tools / disable mutations
-const toolkitWithSpecificTools = new MondayAgentToolkit({
-  mondayApiToken: 'your-monday-api-token',
-  mondayApiVersion: 'your-api-version',
-  mondayApiRequestConfig: {},
-  tools: {
-    include: ['mcp_monday_api_mcp_delete_item', 'create monday item'], // Only include these tools
-    readOnlyMode: true, // Disable all mutation tools (create, update, delete operations)
-    // OR
-    // exclude: ['tool_name_to_exclude'] // Include all tools except these
-  }
-});
-
-// The toolkit extends McpServer and automatically registers all available tools
-```
-
-### Types
-
-The toolkit categorizes tools into two types:
-
-- **Query Tools**: Read-only operations that fetch data (e.g., get board items, get board schema)
-- **Mutation Tools**: Write operations that modify data (e.g., create item, delete item, create update)
-
-You can disable all mutation tools using the `readOnlyMode` option in the configuration. This is useful when you want to ensure that your agent can only read data and cannot make any modifications.
-
-### Using Individual Tools
-
-```typescript
-import { CreateItemTool } from '@mondaydotcomorg/agent-toolkit/tools';
-import { ApiClient } from '@mondaydotcomorg/api';
+The toolkit includes several pre-built tools for common Monday.com operations, organized by functionality:
 
-const apiClient = new ApiClient({
-  token: 'your-monday-api-token',
-  apiVersion: 'your-api-version'
-});
+### Item Operations
+- `CreateItemTool` - Create a new item in a monday.com board
+- `DeleteItemTool` - Delete an item from a board
+- `GetBoardItemsTool` - Get items by board id and term
+- `CreateUpdateTool` - Create a new update on a specific item
+- `ChangeItemColumnValuesTool` - Change the column values of an item in a monday.com board
+- `MoveItemToGroupTool` - Move an item to a group in a monday.com board
 
-const createItemTool = new CreateItemTool(apiClient);
-await createItemTool.execute(/* tool input */);
-```
-
-## Requirements
-
-- Node.js >= 16.20.0
-- Monday.com API token
-- OpenAI API key (if using OpenAI integration)
-
-## Development
-
-```bash
-# Install dependencies
-npm install
-
-# Build the package
-npm run build
-
-# Run tests
-npm test
-
-# Format code
-npm run prettier
-
-# Lint code
-npm run lint
-
-# Watch mode during development
-npm run watch
+### Board Operations
+- `CreateBoardTool` - Create a monday.com board
+- `GetBoardSchemaTool` - Get board schema (columns and groups) by board id
+- `CreateColumnTool` - Create a new column in a monday.com board
+- `DeleteColumnTool` - Delete a column from a monday.com board
 
-# Update Monday.com GraphQL schema
-npm run fetch:schema
+### Account Operations
+- `GetUsersTool` - Get users, can be filtered by name or partial name
 
-# Generate types from schema
-npm run codegen
+### Dynamic API Tools
+- `AllMondayApiTool` - Execute any Monday.com API operation by generating GraphQL queries and mutations dynamically
+- `GetGraphQLSchemaTool` - Fetch the Monday.com GraphQL schema structure including query and mutation definitions
+- `GetTypeDetailsTool` - Get detailed information about a specific GraphQL type from the Monday.com API schema
 
-# Fetch schema and generate types
-npm run fetch:generate
-```
-
-## License
-
-MIT
-
-## Author
-
-monday.com API Team
-
-## Repository
-
-[GitHub Repository](https://github.com/mondaycom/monday-graphql-api/tree/main/packages/agent-toolkit)
-
-## Keywords
-
-- monday
-- api
-- agent-toolkit
-- openai
-- mcp
-- ai-agents
+## Usage

package/dist/cjs/core/index.d.ts

@@ -0,0 +1,39 @@
+import { ZodRawShape, z, ZodTypeAny } from 'zod';
+import { ApiClient } from '@mondaydotcomorg/api';
+
+interface Executable<Input, Output> {
+    execute: (input?: Input) => Promise<Output>;
+}
+
+type ToolInputType<Input extends ZodRawShape | undefined> = Input extends ZodRawShape ? z.objectOutputType<Input, ZodTypeAny> : undefined;
+type ToolOutputType<T extends Record<string, unknown>> = {
+    content: string;
+    metadata?: T;
+};
+declare enum ToolType {
+    QUERY = "query",
+    MUTATION = "mutation",
+    ALL_API = "all_api"
+}
+interface Tool<Input extends ZodRawShape | undefined, Output extends Record<string, unknown> = never> extends Executable<ToolInputType<Input>, ToolOutputType<Output>> {
+    name: string;
+    type: ToolType;
+    getDescription(): string;
+    getInputSchema(): Input;
+}
+
+type MondayApiToolContext = {
+    boardId?: number;
+};
+declare abstract class BaseMondayApiTool<Input extends ZodRawShape | undefined, Output extends Record<string, unknown> = never> implements Tool<Input, Output> {
+    protected readonly mondayApi: ApiClient;
+    protected readonly context?: MondayApiToolContext | undefined;
+    abstract name: string;
+    abstract type: ToolType;
+    constructor(mondayApi: ApiClient, context?: MondayApiToolContext | undefined);
+    abstract getDescription(): string;
+    abstract getInputSchema(): Input;
+    abstract execute(input?: ToolInputType<Input>): Promise<ToolOutputType<Output>>;
+}
+
+export { BaseMondayApiTool, Executable, MondayApiToolContext, Tool, ToolInputType, ToolOutputType, ToolType };

package/dist/cjs/core/index.js

@@ -0,0 +1,2 @@
+"use strict";var o;Object.defineProperty(exports,"__esModule",{value:!0}),exports.ToolType=void 0,(o=exports.ToolType||(exports.ToolType={})).QUERY="query",o.MUTATION="mutation",o.ALL_API="all_api";exports.BaseMondayApiTool=class{constructor(o,e){this.mondayApi=o,this.context=e}};
+//# sourceMappingURL=index.js.map

package/dist/cjs/core/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../lib/core/tool.ts","../../../lib/core/base-monday-api-tool.ts"],"sourcesContent":[null,null],"names":["ToolType","constructor","mondayApi","context","this"],"mappings":"aAYA,IAAYA,yDAAAA,QAIXA,cAAA,GAJWA,EAAAA,QAAQA,WAARA,iBAIX,CAAA,IAHC,MAAA,QACAA,EAAA,SAAA,WACAA,EAAA,QAAA,0CCCA,WAAAC,CACqBC,EACAC,GADAC,KAASF,UAATA,EACAE,KAAOD,QAAPA,CACjB"}

package/dist/cjs/mcp/index.d.ts

@@ -0,0 +1,22 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { ApiClientConfig } from '@mondaydotcomorg/api';
+
+type ToolsConfiguration = {
+    include?: string[];
+    exclude?: string[];
+    readOnlyMode?: boolean;
+    enableDynamicApiTools?: boolean;
+};
+
+type MondayAgentToolkitConfig = {
+    mondayApiToken: ApiClientConfig['token'];
+    mondayApiVersion: ApiClientConfig['apiVersion'];
+    mondayApiRequestConfig: ApiClientConfig['requestConfig'];
+    toolsConfiguration?: ToolsConfiguration;
+};
+declare class MondayAgentToolkit extends McpServer {
+    private readonly mondayApiClient;
+    constructor(config: MondayAgentToolkitConfig);
+}
+
+export { MondayAgentToolkit, MondayAgentToolkitConfig };