Skip to main content
Glama
IQAIcom
by IQAIcom

GET_WIKI

Retrieve detailed information about a specific wiki from IQ.wiki by providing its unique ID.

Instructions

Get details about a specific wiki from IQ.wiki by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe ID of the wiki to retrieve

Implementation Reference

  • The tool handler that defines the GET_WIKI tool with name, description, Zod schema, and execute function. It creates a GetWikiService, calls execute with the wiki ID, and formats the result.
    export const getWikiTool = {
    	name: "GET_WIKI",
    	description: "Get details about a specific wiki from IQ.wiki by ID",
    	parameters: getWikiParams,
    	execute: async (params: GetWikiParams) => {
    		try {
    			const service = new GetWikiService();
    			const wiki = await service.execute(params.id);
    
    			return service.format(wiki);
    		} catch (error) {
    			if (error instanceof Error) {
    				console.log(`Error in GET_WIKI tool: ${error.message}`);
    				return `Error retrieving wiki: ${error.message}`;
    			}
    			return "An unknown error occurred while fetching wiki data";
    		}
    	},
    } as const;
  • Zod schema defining the input parameter for the GET_WIKI tool: a required non-empty string 'id'.
    const getWikiParams = z.object({
    	id: z.string().min(1).describe("The ID of the wiki to retrieve"),
    });
  • src/index.ts:17-17 (registration)
    Registration of the GET_WIKI tool with the FastMCP server instance.
    server.addTool(getWikiTool);
  • Service class that executes the GraphQL query to fetch wiki data by ID and formats the response with title, summary, source URL, and transaction link.
    export class GetWikiService {
    	async execute(id: string) {
    		try {
    			const response = await client.request(WIKI_QUERY, {
    				id,
    			});
    
    			if (!response.wiki) {
    				throw new Error("Wiki Not found");
    			}
    			return response.wiki;
    		} catch (error: any) {
    			throw new Error(error.message);
    		}
    	}
    	format(wiki: any) {
    		const formattedWiki = dedent`
    			📜 Wiki Details
    			- Title: ${wiki.title}
    			- Summary: ${wiki.summary}
    
    			🔗 Source: ${IQ_BASE_URL}/${wiki.id}
    			🔗 Transaction: https://polygonscan.com/tx/${wiki.transactionHash}
    		`;
    
    		return formattedWiki;
    	}
    }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description bears full responsibility for behavioral disclosure. It only states 'get details' without explaining what details are returned, error conditions, or access requirements. This is minimal and insufficient for a transparent description.

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, clear sentence that immediately conveys the tool's purpose. It is front-loaded and contains no unnecessary words or information.

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 single parameter and absence of output schema, the description is basic but adequate. However, it does not explain what 'details' the response contains or how to interpret the output, leaving some ambiguity.

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 schema provides 100% coverage with a description for the 'id' parameter. The tool description reinforces that the ID is used for retrieval but adds no extra semantic value (e.g., format, source). Baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Get details about a specific wiki from IQ.wiki by ID,' specifying the verb, resource, scope, and source. It effectively distinguishes itself from sibling tools focused on user-specific wikis (e.g., GET_USER_CREATED_WIKIS) by indicating direct retrieval by ID.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies use when a specific wiki ID is known, but it lacks explicit guidance on when to use this tool versus alternatives like SEARCH_WIKI. No 'when not to use' or prerequisites are mentioned, making it acceptable but not proactive.

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/IQAIcom/mcp-iqwiki'

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