ClickHelp Published Docs MCP Server

Search Portal

search_portal

Read-onlyIdempotent

Performs a full-text search across the portal to find topics containing the specified keywords

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "search_portal"
  }
}

Input Schema

Name	Required	Description
`count`	No	Maximum number of results to return (default: 10)
`query`	Yes	The search query string. Supports phrase search (use double quotes, e.g. "exact match"), wildcard search (e.g. 'app*'), Boolean operators (AND, OR, the default is AND), handles inflection (e.g. 'run' will match 'running'). Possible synonyms should be mentioned explicitly in the query
`language`	No	Optional language code to filter results (e.g., 'en-US', 'de-DE')
`projectIds`	No	Optional comma-separated list of project IDs to search in

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 11, 2026

TDQS

A3.6/5.0

Behavior3/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds that this is a full-text search over portal topics, but it does not explain relevance ordering, result truncation behavior, or whether results are paginated.

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 definition is a single, front-loaded sentence with no redundant wording. It conveys the core action and scope efficiently without burying the main point.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only search tool with rich schema descriptions and clear annotations, the definition provides enough context to call the tool correctly. It could be strengthened with explicit guidance on when to choose search versus listing or browsing, but the essential behavior is covered.

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?

Schema description coverage is 100%, and the schema itself explains query syntax, count, language, and projectIds in detail. The description adds no parameter-level meaning beyond what the schema already provides, so the baseline of 3 is appropriate.

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

Purpose4/5

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

The description states a specific verb and resource: performs a full-text search across the portal to find topics containing keywords. It is clear enough for an agent to understand the operation, though it does not explicitly distinguish itself from sibling tools such as list_topics or get_topic.

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?

Usage is implied by the mention of keywords and full-text search, suggesting it is appropriate when the agent has search terms rather than a known topic or project identifier. However, there is no explicit when-to-use guidance or named alternative such as list_topics when browsing is more appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All ClickHelp Published Docs MCP Server tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?