GET_USER_WIKI_ACTIVITIES
Get wiki activities (creations or edits) for any IQ.wiki user by Ethereum address, with optional filters for activity type and time frame.
Instructions
Get wiki activities (creations or edits) for a specific user on IQ.wiki
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The Ethereum address of the user | |
| activityType | No | Type of activity: CREATED or UPDATED | |
| timeFrameSeconds | No | Optional time frame in seconds to filter results |
Implementation Reference
- src/tools/get-user-wiki-activities.ts:20-53 (registration)Tool registration and handler for GET_USER_WIKI_ACTIVITIES. Defines the tool name, description, Zod schema for parameters, and the execute function that delegates to GetUserWikiActivitiesService.
export const getWikiActivitiesTool = { name: "GET_USER_WIKI_ACTIVITIES", description: "Get wiki activities (creations or edits) for a specific user on IQ.wiki", parameters: getUserWikiActivitiesParams, execute: async (params: GetUserWikiActivitiesParams) => { try { const service = new GetUserWikiActivitiesService(); const activities = await service.execute( params.id, params.activityType as ActivityType | undefined, params.timeFrameSeconds, ); // Use appropriate formatting based on activity type if (params.activityType === activityTypeEnum.enum.CREATED) { return service.formatCreated(activities); } if (params.activityType === activityTypeEnum.enum.UPDATED) { return service.formatEdited(activities); } // Default format for mixed or unspecified activities return service.format(activities); } catch (error) { if (error instanceof Error) { console.log(`Error in GET_USER_WIKI_ACTIVITIES tool: ${error.message}`); return `Error retrieving user wiki activities: ${error.message}`; } return "An unknown error occurred while fetching user wiki activities"; } }, } as const; - Zod schema definitions for GET_USER_WIKI_ACTIVITIES parameters: id (Ethereum address), activityType (CREATED/UPDATED enum, optional), and timeFrameSeconds (number, optional).
import { z } from "zod"; import { GetUserWikiActivitiesService } from "../services/get-user-wiki-activities.js"; import type { ActivityType } from "../services/get-user-wiki-activities.js"; const activityTypeEnum = z.enum(["CREATED", "UPDATED"]); const getUserWikiActivitiesParams = z.object({ id: z.string().min(1).describe("The Ethereum address of the user"), activityType: activityTypeEnum .optional() .describe("Type of activity: CREATED or UPDATED"), timeFrameSeconds: z .number() .optional() .describe("Optional time frame in seconds to filter results"), }); type GetUserWikiActivitiesParams = z.infer<typeof getUserWikiActivitiesParams>; - Full service implementation: execute() fetches activities via GraphQL (USER_ACTIVITIES_QUERY), filters by type and time frame, enriches edited wikis with metadata (WIKI_QUERY). Format methods: formatCreated, formatEdited, format for outputting formatted strings.
import dedent from "dedent"; import { IQ_BASE_URL, IQ_REVISION_URL } from "../constants.js"; import { client } from "../lib/graphql.js"; import { USER_ACTIVITIES_QUERY, WIKI_QUERY } from "../lib/queries.js"; export type ActivityType = "CREATED" | "UPDATED"; export class GetUserWikiActivitiesService { async execute( id: string, activityType?: ActivityType, timeFrameSeconds?: number, ) { try { const response: any = await client.request(USER_ACTIVITIES_QUERY, { id, limit: 50, // Increase limit to get more activities }); if ( !response.activitiesByUser || response.activitiesByUser.length === 0 ) { throw new Error( `User has no wiki activities${activityType ? ` of type ${activityType}` : ""}`, ); } let activities = response.activitiesByUser; // Filter by activity type if specified if (activityType) { activities = activities.filter( (activity: any) => activity.type === activityType, ); if (activities.length === 0) { throw new Error( `User has no ${activityType.toLowerCase()} wiki activities`, ); } } // Filter by time if timeFrameSeconds is provided if (timeFrameSeconds) { const now = new Date(); const timeLimit = new Date(now.getTime() - timeFrameSeconds * 1000); // Filter activities by datetime activities = activities.filter((activity: any) => { if (!activity.datetime) return false; const activityDate = new Date(activity.datetime); return activityDate >= timeLimit; }); if (activities.length === 0) { // Convert seconds to a human-readable format for the error message const timeFrameText = timeFrameSeconds >= 86400 ? `${Math.floor(timeFrameSeconds / 86400)} day(s)` : timeFrameSeconds >= 3600 ? `${Math.floor(timeFrameSeconds / 3600)} hour(s)` : `${Math.floor(timeFrameSeconds / 60)} minute(s)`; throw new Error( `No wiki ${activityType ? `${activityType.toLowerCase()} ` : ""}activities found in the last ${timeFrameText}`, ); } } // Fetch additional metadata for edited wikis if needed if ( activityType === "UPDATED" || (!activityType && activities.some((a: any) => a.type === "UPDATED")) ) { await this.enrichWithWikiMetadata( activities.filter((a: any) => a.type === "UPDATED"), ); } return activities; } catch (error: any) { throw new Error(error.message); } } // Fetch additional metadata for edited wikis private async enrichWithWikiMetadata(activities: any) { for (const activity of activities) { if (!activity.content?.[0]) continue; try { // Get the full wiki details to access metadata const wikiId = activity.content[0].id; const wikiResponse: any = await client.request(WIKI_QUERY, { id: wikiId, }); activity.enrichedMetadata = { wordsChanged: "Unknown", percentChanged: "Unknown", blocksChanged: "Unknown", }; // Look for specific metadata if available const metadata = wikiResponse?.wiki?.metadata; if (metadata && Array.isArray(metadata)) { const wordsChanged = metadata.find((m) => m.id === "words-changed"); const percentChanged = metadata.find( (m) => m.id === "percent-changed", ); const blocksChanged = metadata.find((m) => m.id === "blocks-changed"); if (wordsChanged?.value) activity.enrichedMetadata.wordsChanged = wordsChanged.value; if (percentChanged?.value) activity.enrichedMetadata.percentChanged = percentChanged.value; if (blocksChanged?.value) activity.enrichedMetadata.blocksChanged = blocksChanged.value; } } catch (error) { // Continue even if we can't get metadata for one wiki console.error( `Error fetching metadata for wiki ${activity.content[0].id}:`, error, ); } } } formatCreated(activities: any) { return activities .map((activity: any) => { const wiki = activity.content[0]; const date = new Date(activity.datetime); const formattedDate = date.toLocaleString(); return dedent` 📜 Created Wiki Details - Title: ${wiki.title} - Summary: ${wiki.summary} - Created: ${formattedDate} 🔗 Source: ${IQ_BASE_URL}/${wiki.id} 🔗 Transaction: https://polygonscan.com/tx/${wiki.transactionHash} `; }) .join("\n\n"); } formatEdited(activities: any) { return activities .map((activity: any) => { const wiki = activity.content[0]; const date = new Date(activity.datetime); const formattedDate = date.toLocaleString(); // Check if we have enriched metadata let editDetails = ""; if (activity.enrichedMetadata) { if ( activity.enrichedMetadata.wordsChanged !== "Unknown" && activity.enrichedMetadata.percentChanged !== "Unknown" ) { editDetails += `- Changes: ${activity.enrichedMetadata.wordsChanged} words (${activity.enrichedMetadata.percentChanged}%)\n`; } if (activity.enrichedMetadata.blocksChanged !== "Unknown") { editDetails += `- Modified sections: ${activity.enrichedMetadata.blocksChanged}\n`; } } // If we couldn't get metadata, use a simpler format if (!editDetails) { editDetails = "- Edit details not available\n"; } return dedent` 📜 Edited Wiki Details - Title: ${wiki.title} - Summary: ${wiki.summary} - Edited: ${formattedDate} ${editDetails} 🔗 Source: ${IQ_REVISION_URL}/${activity.id} 🔗 Transaction: https://polygonscan.com/tx/${wiki.transactionHash} `; }) .join("\n\n"); } format(activities: any) { return activities .map((activity: any) => { const wiki = activity.content[0]; const date = new Date(activity.datetime); const formattedDate = date.toLocaleString(); const actionType = activity.type === "CREATED" ? "Created" : "Edited"; // Add edit details for edited wikis let editDetails = ""; if (activity.type === "UPDATED" && activity.enrichedMetadata) { if ( activity.enrichedMetadata.wordsChanged !== "Unknown" && activity.enrichedMetadata.percentChanged !== "Unknown" ) { editDetails += `- Changes: ${activity.enrichedMetadata.wordsChanged} words (${activity.enrichedMetadata.percentChanged}%)\n`; } if (activity.enrichedMetadata.blocksChanged !== "Unknown") { editDetails += `- Modified sections: ${activity.enrichedMetadata.blocksChanged}\n`; } } // Determine source URL based on activity type const sourceUrl = activity.type === "UPDATED" ? `${IQ_REVISION_URL}/${activity.id}` : `${IQ_BASE_URL}/${wiki.id}`; return dedent` 📜 Wiki ${actionType} - Title: ${wiki.title} - Summary: ${wiki.summary} - ${actionType}: ${formattedDate} ${editDetails} 🔗 Source: ${sourceUrl} 🔗 Transaction: https://polygonscan.com/tx/${wiki.transactionHash} `; }) .join("\n\n"); } } - src/index.ts:5-5 (registration)Import of getWikiActivitiesTool from the tools module.
import { getWikiActivitiesTool } from "./tools/get-user-wiki-activities.js"; - src/index.ts:20-20 (registration)Server registration of the GET_USER_WIKI_ACTIVITIES tool via server.addTool(getWikiActivitiesTool).
server.addTool(getWikiActivitiesTool); - src/lib/queries.ts:91-116 (helper)GraphQL query USER_ACTIVITIES_QUERY used by the service to fetch user activities.
export const USER_ACTIVITIES_QUERY = graphql(` query userActivities($id: String!, $offset: Int = 0, $limit: Int = 30) { activitiesByUser(userId: $id, offset: $offset, limit: $limit) { id type datetime block ipfs wikiId user { id profile { username avatar } } content { id title summary transactionHash ipfs } } } `); - src/lib/queries.ts:118-150 (helper)GraphQL query WIKI_QUERY used by enrichWithWikiMetadata to fetch metadata for edited wikis.
export const WIKI_QUERY = graphql(` query wiki($id: String!) { wiki(id: $id) { id ipfs transactionHash title summary metadata { id value } images { id type } tags { id } categories { id title } user { id profile { username avatar } } } } `);