Skip to content

API documentation not returned by search_docs tool #30

@clareliguori

Description

@clareliguori

I find that often my coding assistant (Kiro) wants to look up a method/constructor definition for Strands, but cannot get it from the MCP server. Either the API documentation is not being indexed, or perhaps the API reference documentation doesn't rank highly enough to be returned very often from the search_docs tool. We might need a separate search_api_reference_docs tool if we can't get API documentation to be reliably returned from search_docs.

For example, I asked Kiro "What are the inputs for the Strands "Agent" class". It called search_docs with the query "Agent class constructor parameters inputs". I would have expected this page to be in the search results, but it was not: https://strandsagents.com/latest/documentation/docs/api-reference/python/agent/agent/index.md

However, the results from search_docs were:

{
  "url": "https://strandsagents.com/latest/documentation/docs/user-guide/concepts/multi-agent/agent-to-agent/index.md",
  "title": "Agent2Agent (A2A)",
  "score": 650.642,
  "snippet": "Strands Agents supports the [Agent-to-Agent (A2A) protocol](https://a2aproject.github.io/A2A/latest/), enabling seamless communication between AI agents across different platforms and implementations."
}
{
  "url": "https://strandsagents.com/latest/documentation/docs/user-guide/concepts/multi-agent/multi-agent-patterns/index.md",
  "title": "Multi-agent Patterns",
  "score": 108.44,
  "snippet": "In Strands, building a system with multiple agents or complex tool chains can be approached in several ways. The three primary patterns you'll encounter are Graph, Swarm, and Workflow. While they all aim to solve complex problems, they have differences in their structures, execution workflows, and…"
}
{
  "url": "https://strandsagents.com/latest/documentation/docs/examples/python/cli-reference-agent/index.md",
  "title": "CLI Reference Agent Implementation",
  "score": 108.44,
  "snippet": "The Strands CLI is a reference implementation built on top of the Strands SDK. It provides a terminal-based interface for interacting with Strands agents, demonstrating how to make a fully interactive streaming application with the Strands SDK."
}
{
  "url": "https://strandsagents.com/latest/documentation/docs/examples/python/multi_agent_example/index.md",
  "title": "Multi-Agent Example",
  "score": 108.44,
  "snippet": "This directory contains the implementation files for the Multi-Agent Example architecture, where specialized agents work together under the coordination of a central orchestrator."
}
{
  "url": "https://strandsagents.com/latest/documentation/docs/examples/typescript/deploy_to_bedrock_agentcore/index.md",
  "title": "TypeScript Agent Deployment to Amazon Bedrock AgentCore Runtime",
  "score": 81.33,
  "snippet": "This example demonstrates deploying a TypeScript-based Strands agent to Amazon Bedrock AgentCore Runtime using Express and Docker."
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions